Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.util

Class KeepAliveScheduler

java.lang.Object

io.modelcontextprotocol.util.KeepAliveScheduler

public class KeepAliveScheduler
extends Object

A utility class for scheduling regular keep-alive calls to maintain connections. It sends periodic keep-alive, ping, messages to connected mcp clients to prevent idle timeouts. The pings are sent to all active mcp sessions at regular intervals.

Author:

Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeepAliveScheduler.Builder	Builder class for creating KeepAliveScheduler instances with fluent API.

Method Summary

Modifier and Type	Method	Description
static KeepAliveScheduler.Builder	builder(Supplier<reactor.core.publisher.Flux<McpSession>> mcpSessions)	Creates a new Builder instance for constructing KeepAliveScheduler.
boolean	isRunning()	Checks if the scheduler is currently running.
void	shutdown()	Shuts down the scheduler and releases resources.
reactor.core.Disposable	start()	Starts regular keepAlive calls with sessions supplier.
void	stop()	Stops the currently running keepAlive scheduler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static KeepAliveScheduler.Builder builder(Supplier<reactor.core.publisher.Flux<McpSession>> mcpSessions)

Creates a new Builder instance for constructing KeepAliveScheduler.

Returns:

A new Builder instance

start

public reactor.core.Disposable start()

Starts regular keepAlive calls with sessions supplier.

Returns:

Disposable to control the scheduled execution

stop

public void stop()

Stops the currently running keepAlive scheduler.

isRunning

public boolean isRunning()

Checks if the scheduler is currently running.

Returns:

true if running, false otherwise

shutdown

public void shutdown()

Shuts down the scheduler and releases resources.