java.lang.Object
- org.springframework.web.socket.messaging.StompSubProtocolHandler

所有已实现的接口:
Aware, ApplicationEventPublisherAware, SubProtocolHandler
```
public class StompSubProtocolHandler
extends Object
implements SubProtocolHandler, ApplicationEventPublisherAware
```
A SubProtocolHandler for STOMP that supports versions 1.0, 1.1, and 1.2 of the STOMP specification.
从以下版本开始:
4.0
作者:
Rossen Stoyanchev, Andy Wilkinson

字段概要

字段
修饰符和类型	字段	说明
`static String`	`CONNECTED_USER_HEADER`	The name of the header set on the CONNECTED frame indicating the name of the user authenticated on the WebSocket session.
`static int`	`MINIMUM_WEBSOCKET_MESSAGE_SIZE`	This handler supports assembling large STOMP messages split into multiple WebSocket messages and STOMP clients (like stomp.js) indeed split large STOMP messages at 16K boundaries.

构造器概要
构造器
构造器说明
StompSubProtocolHandler()

方法概要

所有方法实例方法具体方法已过时的方法
修饰符和类型	方法	说明
`void`	`afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)`	Invoked after a `WebSocketSession` has ended.
`void`	`afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)`	Invoked after a `WebSocketSession` has started.
`StompSubProtocolErrorHandler`	`getErrorHandler()`	Return the configured error handler.
`MessageHeaderInitializer`	`getHeaderInitializer()`	Return the configured header initializer.
`int`	`getMessageSizeLimit()`	Get the configured message buffer size limit in bytes.
`String`	`getStatsInfo()`	Return a String describing internal state and counters.
`List<String>`	`getSupportedProtocols()`	Return the list of sub-protocols supported by this handler (never `null`).
`UserSessionRegistry`	`getUserSessionRegistry()`	已过时。 as of 4.2
`void`	`handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel outputChannel)`	Handle incoming WebSocket messages from clients.
`void`	`handleMessageToClient(WebSocketSession session, Message<?> message)`	Handle STOMP messages going back out to WebSocket clients.
`String`	`resolveSessionId(Message<?> message)`	Resolve the session id from the given message or return `null`.
`protected void`	`sendErrorMessage(WebSocketSession session, Throwable error)`	已过时。 as of Spring 4.2, in favor of `configuring` a `StompSubProtocolErrorHandler`
`void`	`setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)`	Set the ApplicationEventPublisher that this object runs in.
`void`	`setDecoder(StompDecoder decoder)`	Configure a `StompDecoder` for decoding STOMP frames
`void`	`setEncoder(StompEncoder encoder)`	Configure a `StompEncoder` for encoding STOMP frames
`void`	`setErrorHandler(StompSubProtocolErrorHandler errorHandler)`	Configure a handler for error messages sent to clients which allows customizing the error messages or preventing them from being sent.
`void`	`setHeaderInitializer(MessageHeaderInitializer headerInitializer)`	Configure a `MessageHeaderInitializer` to apply to the headers of all messages created from decoded STOMP frames and other messages sent to the client inbound channel.
`void`	`setMessageSizeLimit(int messageSizeLimit)`	Configure the maximum size allowed for an incoming STOMP message.
`void`	`setUserSessionRegistry(UserSessionRegistry registry)`	已过时。 as of 4.2 in favor of `DefaultSimpUserRegistry` which relies on the ApplicationContext events published by this class and is created via `WebSocketMessageBrokerConfigurationSupport.createLocalUserRegistry`
`protected StompHeaderAccessor`	`toMutableAccessor(StompHeaderAccessor headerAccessor, Message<?> message)`
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - MINIMUM_WEBSOCKET_MESSAGE_SIZE
```
public static final int MINIMUM_WEBSOCKET_MESSAGE_SIZE
```
    This handler supports assembling large STOMP messages split into multiple WebSocket messages and STOMP clients (like stomp.js) indeed split large STOMP messages at 16K boundaries. Therefore the WebSocket server input message buffer size must allow 16K at least plus a little extra for SockJS framing.
    另请参阅:
    常量字段值
  - CONNECTED_USER_HEADER
```
public static final String CONNECTED_USER_HEADER
```
    The name of the header set on the CONNECTED frame indicating the name of the user authenticated on the WebSocket session.
    另请参阅:
    常量字段值
- 构造器详细资料
  - StompSubProtocolHandler
```
public StompSubProtocolHandler()
```
- 方法详细资料
  - setErrorHandler
```
public void setErrorHandler(StompSubProtocolErrorHandler errorHandler)
```
    Configure a handler for error messages sent to clients which allows customizing the error messages or preventing them from being sent.
    By default this isn't configured in which case an ERROR frame is sent with a message header reflecting the error.
    参数:
    errorHandler - the error handler
  - getErrorHandler
```
public StompSubProtocolErrorHandler getErrorHandler()
```
    Return the configured error handler.
  - setMessageSizeLimit
```
public void setMessageSizeLimit(int messageSizeLimit)
```
    Configure the maximum size allowed for an incoming STOMP message. Since a STOMP message can be received in multiple WebSocket messages, buffering may be required and therefore it is necessary to know the maximum allowed message size.
    By default this property is set to 64K.
    从以下版本开始:
    4.0.3
  - getMessageSizeLimit
```
public int getMessageSizeLimit()
```
    Get the configured message buffer size limit in bytes.
    从以下版本开始:
    4.0.3
  - setUserSessionRegistry
```
@Deprecated
public void setUserSessionRegistry(UserSessionRegistry registry)
```
    已过时。
    as of 4.2 in favor of DefaultSimpUserRegistry which relies on the ApplicationContext events published by this class and is created via WebSocketMessageBrokerConfigurationSupport.createLocalUserRegistry
    Provide a registry with which to register active user session ids.
    另请参阅:
    UserDestinationMessageHandler
  - getUserSessionRegistry
```
@Deprecated
public UserSessionRegistry getUserSessionRegistry()
```
    已过时。
    as of 4.2
  - setEncoder
```
public void setEncoder(StompEncoder encoder)
```
    Configure a StompEncoder for encoding STOMP frames
    从以下版本开始:
    4.3.5
  - setDecoder
```
public void setDecoder(StompDecoder decoder)
```
    Configure a StompDecoder for decoding STOMP frames
    从以下版本开始:
    4.3.5
  - setHeaderInitializer
```
public void setHeaderInitializer(MessageHeaderInitializer headerInitializer)
```
    Configure a MessageHeaderInitializer to apply to the headers of all messages created from decoded STOMP frames and other messages sent to the client inbound channel.
    By default this property is not set.
  - getHeaderInitializer
```
public MessageHeaderInitializer getHeaderInitializer()
```
    Return the configured header initializer.
  - getSupportedProtocols
```
public List<String> getSupportedProtocols()
```
    从接口复制的说明: SubProtocolHandler
    Return the list of sub-protocols supported by this handler (never null).
    指定者:
    getSupportedProtocols 在接口中 SubProtocolHandler
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
```
    从接口复制的说明: ApplicationEventPublisherAware
    Set the ApplicationEventPublisher that this object runs in.
    Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.
    指定者:
    setApplicationEventPublisher 在接口中 ApplicationEventPublisherAware
    参数:
    applicationEventPublisher - event publisher to be used by this object
  - getStatsInfo
```
public String getStatsInfo()
```
    Return a String describing internal state and counters.
  - handleMessageFromClient
```
public void handleMessageFromClient(WebSocketSession session,
                                    WebSocketMessage<?> webSocketMessage,
                                    MessageChannel outputChannel)
```
    Handle incoming WebSocket messages from clients.
    指定者:
    handleMessageFromClient 在接口中 SubProtocolHandler
    参数:
    session - the client session
    webSocketMessage - the client message
    outputChannel - an output channel to send messages to
  - sendErrorMessage
```
@Deprecated
protected void sendErrorMessage(WebSocketSession session,
                                Throwable error)
```
    已过时。
    as of Spring 4.2, in favor of configuring a StompSubProtocolErrorHandler
    Invoked when no errorHandler is configured to send an ERROR frame to the client.
  - handleMessageToClient
```
public void handleMessageToClient(WebSocketSession session,
                                  Message<?> message)
```
    Handle STOMP messages going back out to WebSocket clients.
    指定者:
    handleMessageToClient 在接口中 SubProtocolHandler
    参数:
    session - the client session
    message - the client message
  - toMutableAccessor
```
protected StompHeaderAccessor toMutableAccessor(StompHeaderAccessor headerAccessor,
                                                Message<?> message)
```
  - resolveSessionId
```
public String resolveSessionId(Message<?> message)
```
    从接口复制的说明: SubProtocolHandler
    Resolve the session id from the given message or return null.
    指定者:
    resolveSessionId 在接口中 SubProtocolHandler
    参数:
    message - the message to resolve the session id from
  - afterSessionStarted
```
public void afterSessionStarted(WebSocketSession session,
                                MessageChannel outputChannel)
```
    从接口复制的说明: SubProtocolHandler
    Invoked after a WebSocketSession has started.
    指定者:
    afterSessionStarted 在接口中 SubProtocolHandler
    参数:
    session - the client session
    outputChannel - a channel
  - afterSessionEnded
```
public void afterSessionEnded(WebSocketSession session,
                              CloseStatus closeStatus,
                              MessageChannel outputChannel)
```
    从接口复制的说明: SubProtocolHandler
    Invoked after a WebSocketSession has ended.
    指定者:
    afterSessionEnded 在接口中 SubProtocolHandler
    参数:
    session - the client session
    closeStatus - the reason why the session was closed
    outputChannel - a channel
  - toString
```
public String toString()
```
    覆盖:
    toString 在类中 Object

类 StompSubProtocolHandler

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

MINIMUM_WEBSOCKET_MESSAGE_SIZE

CONNECTED_USER_HEADER

构造器详细资料

StompSubProtocolHandler

方法详细资料

setErrorHandler

getErrorHandler

setMessageSizeLimit

getMessageSizeLimit

setUserSessionRegistry

getUserSessionRegistry

setEncoder

setDecoder

setHeaderInitializer

getHeaderInitializer

getSupportedProtocols

setApplicationEventPublisher

getStatsInfo

handleMessageFromClient

sendErrorMessage

handleMessageToClient

toMutableAccessor

resolveSessionId

afterSessionStarted

afterSessionEnded

toString