| Package | Description | 
|---|---|
| org.springframework.messaging.simp.broker | 
 Provides a "simple" message broker implementation along with an abstract base
 class and other supporting types such as a registry for subscriptions. 
 | 
| org.springframework.messaging.simp.config | 
 Configuration support for WebSocket messaging using higher level messaging protocols. 
 | 
| org.springframework.messaging.simp.stomp | 
 Generic support for simple messaging protocols (like STOMP). 
 | 
| org.springframework.messaging.simp.user | 
 Support for handling messages to "user" destinations (i.e. 
 | 
| org.springframework.scheduling.commonj | 
 Convenience classes for scheduling based on the CommonJ WorkManager/TimerManager
 facility, as supported by IBM WebSphere 6.0+ and BEA WebLogic 9.0+. 
 | 
| org.springframework.scheduling.concurrent | 
 Scheduling convenience classes for the  
java.util.concurrent
 and javax.enterprise.concurrent packages, allowing to set up a
 ThreadPoolExecutor or ScheduledThreadPoolExecutor as a bean in a Spring
 context. | 
| org.springframework.scheduling.config | 
 Support package for declarative scheduling configuration,
 with XML schema being the primary configuration format. 
 | 
| org.springframework.web.socket.config.annotation | 
 Support for annotation-based WebSocket setup in configuration classes. 
 | 
| org.springframework.web.socket.messaging | 
 WebSocket integration for Spring's messaging module. 
 | 
| org.springframework.web.socket.sockjs.client | 
 SockJS client implementation of
  
WebSocketClient. | 
| org.springframework.web.socket.sockjs.support | 
 Support classes for SockJS including an
  
AbstractSockJsService
 implementation. | 
| org.springframework.web.socket.sockjs.transport | 
 Server-side support for SockJS transports including
  
TransportHandler implementations
 for processing incoming requests, their
 session
 counterparts for sending messages over the various transports, and
 DefaultSockJsService. | 
| org.springframework.web.socket.sockjs.transport.handler | 
TransportHandler
 implementation classes as well as a concrete
 SockJsService. | 
| Modifier and Type | Method and Description | 
|---|---|
TaskScheduler | 
SimpleBrokerMessageHandler.getTaskScheduler()
Return the configured TaskScheduler. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
SimpleBrokerMessageHandler.setTaskScheduler(TaskScheduler taskScheduler)
Configure the  
TaskScheduler to
 use for providing heartbeat support. | 
| Modifier and Type | Method and Description | 
|---|---|
SimpleBrokerRegistration | 
SimpleBrokerRegistration.setTaskScheduler(TaskScheduler taskScheduler)
Configure the  
TaskScheduler to
 use for providing heartbeat support. | 
| Modifier and Type | Method and Description | 
|---|---|
TaskScheduler | 
StompClientSupport.getTaskScheduler()
The configured TaskScheduler. 
 | 
TaskScheduler | 
DefaultStompSession.getTaskScheduler()
Return the configured TaskScheduler to use for receipt tracking. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
StompClientSupport.setTaskScheduler(TaskScheduler taskScheduler)
Configure a scheduler to use for heartbeats and for receipt tracking. 
 | 
void | 
DefaultStompSession.setTaskScheduler(TaskScheduler taskScheduler)
Configure the TaskScheduler to use for receipt tracking. 
 | 
| Constructor and Description | 
|---|
UserRegistryMessageHandler(MultiServerUserRegistry userRegistry,
                          SimpMessagingTemplate brokerTemplate,
                          java.lang.String broadcastDestination,
                          TaskScheduler scheduler)
Constructor. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
TimerManagerTaskScheduler
Deprecated. 
 
as of 5.1, in favor of EE 7's
  
DefaultManagedTaskScheduler | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ConcurrentTaskScheduler
Adapter that takes a  
java.util.concurrent.ScheduledExecutorService and
 exposes a Spring TaskScheduler for it. | 
class  | 
DefaultManagedTaskScheduler
JNDI-based variant of  
ConcurrentTaskScheduler, performing a default lookup for
 JSR-236's "java:comp/DefaultManagedScheduledExecutorService" in a Java EE 7 environment. | 
class  | 
ThreadPoolTaskScheduler
Implementation of Spring's  
TaskScheduler interface, wrapping
 a native ScheduledThreadPoolExecutor. | 
| Modifier and Type | Method and Description | 
|---|---|
TaskScheduler | 
ScheduledTaskRegistrar.getScheduler()
Return the  
TaskScheduler instance for this registrar (may be null). | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ScheduledTaskRegistrar.setTaskScheduler(TaskScheduler taskScheduler)
Set the  
TaskScheduler to register scheduled tasks with. | 
| Modifier and Type | Method and Description | 
|---|---|
TaskScheduler | 
WebSocketConfigurationSupport.defaultSockJsTaskScheduler()
The default TaskScheduler to use if none is registered explicitly via
  
SockJsServiceRegistration.setTaskScheduler(org.springframework.scheduling.TaskScheduler):
 
 @Configuration
 @EnableWebSocket
 public class WebSocketConfig implements WebSocketConfigurer {
   public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
     registry.addHandler(myHandler(), "/echo")
             .withSockJS()
             .setTaskScheduler(myScheduler());
   }
   // ... | 
protected TaskScheduler | 
SockJsServiceRegistration.getTaskScheduler()
Return the TaskScheduler, if configured. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
SockJsServiceRegistration | 
SockJsServiceRegistration.setTaskScheduler(TaskScheduler scheduler)
A scheduler instance to use for scheduling SockJS heart-beats. 
 | 
protected void | 
ServletWebSocketHandlerRegistry.setTaskScheduler(TaskScheduler scheduler)
Provide the TaskScheduler to use for SockJS endpoints for which a task
 scheduler has not been explicitly registered. 
 | 
| Constructor and Description | 
|---|
WebMvcStompEndpointRegistry(WebSocketHandler webSocketHandler,
                           WebSocketTransportRegistration transportRegistration,
                           TaskScheduler defaultSockJsTaskScheduler)  | 
WebMvcStompWebSocketEndpointRegistration(java.lang.String[] paths,
                                        WebSocketHandler webSocketHandler,
                                        TaskScheduler sockJsTaskScheduler)  | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
WebSocketStompClient.setTaskScheduler(TaskScheduler taskScheduler)
Configure a scheduler to use for heartbeats and for receipt tracking. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
SockJsClient.setConnectTimeoutScheduler(TaskScheduler connectTimeoutScheduler)
Configure a  
TaskScheduler for scheduling a connect timeout task
 where the timeout value is calculated based on the duration of the initial
 SockJS "Info" request. | 
| Modifier and Type | Method and Description | 
|---|---|
TaskScheduler | 
AbstractSockJsService.getTaskScheduler()
A scheduler instance to use for scheduling heart-beat messages. 
 | 
| Constructor and Description | 
|---|
AbstractSockJsService(TaskScheduler scheduler)  | 
| Modifier and Type | Method and Description | 
|---|---|
TaskScheduler | 
SockJsServiceConfig.getTaskScheduler()
A scheduler instance to use for scheduling heart-beat messages. 
 | 
| Constructor and Description | 
|---|
TransportHandlingSockJsService(TaskScheduler scheduler,
                              java.util.Collection<TransportHandler> handlers)
Create a TransportHandlingSockJsService with given  
handler types. | 
TransportHandlingSockJsService(TaskScheduler scheduler,
                              TransportHandler... handlers)
Create a TransportHandlingSockJsService with given  
handler types. | 
| Constructor and Description | 
|---|
DefaultSockJsService(TaskScheduler scheduler)
Create a DefaultSockJsService with default  
handler types. | 
DefaultSockJsService(TaskScheduler scheduler,
                    java.util.Collection<TransportHandler> handlerOverrides)
Create a DefaultSockJsService with overridden  
handler types
 replacing the corresponding default handler implementation. | 
DefaultSockJsService(TaskScheduler scheduler,
                    TransportHandler... handlerOverrides)
Create a DefaultSockJsService with overridden  
handler types
 replacing the corresponding default handler implementation. |