接口的使用
org.springframework.web.socket.WebSocketSession
使用WebSocketSession的程序包 程序包 说明 org.springframework.web.socket Common abstractions and Spring configuration support for WebSocket applications.org.springframework.web.socket.adapter Classes adapting Spring's WebSocket API to and from WebSocket providers.org.springframework.web.socket.adapter.jetty Adapter classes for the Jetty WebSocket API.org.springframework.web.socket.adapter.standard Adapter classes for the standard Java WebSocket API.org.springframework.web.socket.client Client-side abstractions for WebSocket applications.org.springframework.web.socket.client.jetty Client-side support for the Jetty WebSocket API.org.springframework.web.socket.client.standard Client-side classes for use with standard Java WebSocket endpoints.org.springframework.web.socket.handler ConvenientWebSocketHandler
implementations and decorators.org.springframework.web.socket.messaging WebSocket integration for Spring's messaging module.org.springframework.web.socket.sockjs.client SockJS client implementation ofWebSocketClient
.org.springframework.web.socket.sockjs.transport Server-side support for SockJS transports includingTransportHandler
implementations for processing incoming requests, theirsession
counterparts for sending messages over the various transports, andDefaultSockJsService
.org.springframework.web.socket.sockjs.transport.handler TransportHandler
implementation classes as well as a concreteSockJsService
.org.springframework.web.socket.sockjs.transport.session SockJS specific implementations ofWebSocketSession
.org.springframework.web.socket中WebSocketSession的使用
参数类型为WebSocketSession的org.springframework.web.socket中的方法 修饰符和类型 方法 说明 void
WebSocketHandler. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.void
WebSocketHandler. afterConnectionEstablished(WebSocketSession session)
Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.void
WebSocketHandler. handleMessage(WebSocketSession session, WebSocketMessage<?> message)
Invoked when a new WebSocket message arrives.void
WebSocketHandler. handleTransportError(WebSocketSession session, Throwable exception)
Handle an error from the underlying WebSocket message transport.org.springframework.web.socket.adapter中WebSocketSession的使用
org.springframework.web.socket.adapter中WebSocketSession的子接口 修饰符和类型 接口 说明 interface
NativeWebSocketSession
AWebSocketSession
that exposes the underlying, native WebSocketSession through a getter.实现WebSocketSession的org.springframework.web.socket.adapter中的类 修饰符和类型 类 说明 class
AbstractWebSocketSession<T>
An abstract base class for implementations ofWebSocketSession
.org.springframework.web.socket.adapter.jetty中WebSocketSession的使用
实现WebSocketSession的org.springframework.web.socket.adapter.jetty中的类 修饰符和类型 类 说明 class
JettyWebSocketSession
AWebSocketSession
for use with the Jetty 9.4 WebSocket API.org.springframework.web.socket.adapter.standard中WebSocketSession的使用
实现WebSocketSession的org.springframework.web.socket.adapter.standard中的类 修饰符和类型 类 说明 class
StandardWebSocketSession
AWebSocketSession
for use with the standard WebSocket for Java API.org.springframework.web.socket.client中WebSocketSession的使用
返回变量类型为WebSocketSession的类型的org.springframework.web.socket.client中的方法 修饰符和类型 方法 说明 ListenableFuture<WebSocketSession>
AbstractWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVars)
ListenableFuture<WebSocketSession>
AbstractWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)
ListenableFuture<WebSocketSession>
WebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVariables)
ListenableFuture<WebSocketSession>
WebSocketClient. doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)
protected abstract ListenableFuture<WebSocketSession>
AbstractWebSocketClient. doHandshakeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URI uri, List<String> subProtocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)
Perform the actual handshake to establish a connection to the server.org.springframework.web.socket.client.jetty中WebSocketSession的使用
返回变量类型为WebSocketSession的类型的org.springframework.web.socket.client.jetty中的方法 修饰符和类型 方法 说明 ListenableFuture<WebSocketSession>
JettyWebSocketClient. doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVars)
ListenableFuture<WebSocketSession>
JettyWebSocketClient. doHandshakeInternal(WebSocketHandler wsHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)
org.springframework.web.socket.client.standard中WebSocketSession的使用
返回变量类型为WebSocketSession的类型的org.springframework.web.socket.client.standard中的方法 修饰符和类型 方法 说明 protected ListenableFuture<WebSocketSession>
StandardWebSocketClient. doHandshakeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URI uri, List<String> protocols, List<WebSocketExtension> extensions, Map<String,Object> attributes)
org.springframework.web.socket.handler中WebSocketSession的使用
实现WebSocketSession的org.springframework.web.socket.handler中的类 修饰符和类型 类 说明 class
ConcurrentWebSocketSessionDecorator
Wrap aWebSocketSession
to guarantee only one thread can send messages at a time.class
WebSocketSessionDecorator
Wraps anotherWebSocketSession
instance and delegates to it.返回WebSocketSession的org.springframework.web.socket.handler中的方法 修饰符和类型 方法 说明 WebSocketSession
WebSocketSessionDecorator. getDelegate()
WebSocketSession
WebSocketSessionDecorator. getLastSession()
static WebSocketSession
WebSocketSessionDecorator. unwrap(WebSocketSession session)
参数类型为WebSocketSession的org.springframework.web.socket.handler中的方法 修饰符和类型 方法 说明 void
AbstractWebSocketHandler. afterConnectionClosed(WebSocketSession session, CloseStatus status)
void
ExceptionWebSocketHandlerDecorator. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void
LoggingWebSocketHandlerDecorator. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void
PerConnectionWebSocketHandler. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void
WebSocketHandlerDecorator. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void
AbstractWebSocketHandler. afterConnectionEstablished(WebSocketSession session)
void
ExceptionWebSocketHandlerDecorator. afterConnectionEstablished(WebSocketSession session)
void
LoggingWebSocketHandlerDecorator. afterConnectionEstablished(WebSocketSession session)
void
PerConnectionWebSocketHandler. afterConnectionEstablished(WebSocketSession session)
void
WebSocketHandlerDecorator. afterConnectionEstablished(WebSocketSession session)
protected void
AbstractWebSocketHandler. handleBinaryMessage(WebSocketSession session, BinaryMessage message)
protected void
TextWebSocketHandler. handleBinaryMessage(WebSocketSession session, BinaryMessage message)
void
AbstractWebSocketHandler. handleMessage(WebSocketSession session, WebSocketMessage<?> message)
void
ExceptionWebSocketHandlerDecorator. handleMessage(WebSocketSession session, WebSocketMessage<?> message)
void
LoggingWebSocketHandlerDecorator. handleMessage(WebSocketSession session, WebSocketMessage<?> message)
void
PerConnectionWebSocketHandler. handleMessage(WebSocketSession session, WebSocketMessage<?> message)
void
WebSocketHandlerDecorator. handleMessage(WebSocketSession session, WebSocketMessage<?> message)
protected void
AbstractWebSocketHandler. handlePongMessage(WebSocketSession session, PongMessage message)
protected void
AbstractWebSocketHandler. handleTextMessage(WebSocketSession session, TextMessage message)
protected void
BinaryWebSocketHandler. handleTextMessage(WebSocketSession session, TextMessage message)
void
AbstractWebSocketHandler. handleTransportError(WebSocketSession session, Throwable exception)
void
ExceptionWebSocketHandlerDecorator. handleTransportError(WebSocketSession session, Throwable exception)
void
LoggingWebSocketHandlerDecorator. handleTransportError(WebSocketSession session, Throwable exception)
void
PerConnectionWebSocketHandler. handleTransportError(WebSocketSession session, Throwable exception)
void
WebSocketHandlerDecorator. handleTransportError(WebSocketSession session, Throwable exception)
static void
ExceptionWebSocketHandlerDecorator. tryCloseWithError(WebSocketSession session, Throwable exception, Log logger)
static WebSocketSession
WebSocketSessionDecorator. unwrap(WebSocketSession session)
参数类型为WebSocketSession的org.springframework.web.socket.handler中的构造器 构造器 说明 ConcurrentWebSocketSessionDecorator(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit)
Basic constructor.ConcurrentWebSocketSessionDecorator(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit, ConcurrentWebSocketSessionDecorator.OverflowStrategy overflowStrategy)
Constructor that also specifies the overflow strategy to use.WebSocketSessionDecorator(WebSocketSession session)
org.springframework.web.socket.messaging中WebSocketSession的使用
返回WebSocketSession的org.springframework.web.socket.messaging中的方法 修饰符和类型 方法 说明 protected WebSocketSession
SubProtocolWebSocketHandler. decorateSession(WebSocketSession session)
Decorate the givenWebSocketSession
, if desired.参数类型为WebSocketSession的org.springframework.web.socket.messaging中的方法 修饰符和类型 方法 说明 void
SubProtocolWebSocketHandler. afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)
void
SubProtocolWebSocketHandler. afterConnectionEstablished(WebSocketSession session)
void
StompSubProtocolHandler. afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)
void
SubProtocolHandler. afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)
Invoked after aWebSocketSession
has ended.void
StompSubProtocolHandler. afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)
void
SubProtocolHandler. afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)
Invoked after aWebSocketSession
has started.protected WebSocketSession
SubProtocolWebSocketHandler. decorateSession(WebSocketSession session)
Decorate the givenWebSocketSession
, if desired.protected SubProtocolHandler
SubProtocolWebSocketHandler. findProtocolHandler(WebSocketSession session)
Find aSubProtocolHandler
for the given session.void
SubProtocolWebSocketHandler. handleMessage(WebSocketSession session, WebSocketMessage<?> message)
Handle an inbound message from a WebSocket client.void
StompSubProtocolHandler. handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel outputChannel)
Handle incoming WebSocket messages from clients.void
SubProtocolHandler. handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel)
Handle the givenWebSocketMessage
received from a client.void
StompSubProtocolHandler. handleMessageToClient(WebSocketSession session, Message<?> message)
Handle STOMP messages going back out to WebSocket clients.void
SubProtocolHandler. handleMessageToClient(WebSocketSession session, Message<?> message)
Handle the givenMessage
to the client associated with the given WebSocket session.void
SubProtocolWebSocketHandler. handleTransportError(WebSocketSession session, Throwable exception)
org.springframework.web.socket.sockjs.client中WebSocketSession的使用
实现WebSocketSession的org.springframework.web.socket.sockjs.client中的类 修饰符和类型 类 说明 class
AbstractClientSockJsSession
Base class for SockJS client implementations ofWebSocketSession
.class
WebSocketClientSockJsSession
An extension ofAbstractClientSockJsSession
wrapping and delegating to an actual WebSocket session.class
XhrClientSockJsSession
An extension ofAbstractClientSockJsSession
for use with HTTP transports simulating a WebSocket session.返回变量类型为WebSocketSession的类型的org.springframework.web.socket.sockjs.client中的方法 修饰符和类型 方法 说明 ListenableFuture<WebSocketSession>
AbstractXhrTransport. connect(TransportRequest request, WebSocketHandler handler)
ListenableFuture<WebSocketSession>
Transport. connect(TransportRequest request, WebSocketHandler webSocketHandler)
Connect the transport.ListenableFuture<WebSocketSession>
WebSocketTransport. connect(TransportRequest request, WebSocketHandler handler)
ListenableFuture<WebSocketSession>
SockJsClient. doHandshake(WebSocketHandler handler, String uriTemplate, Object... uriVars)
ListenableFuture<WebSocketSession>
SockJsClient. doHandshake(WebSocketHandler handler, WebSocketHttpHeaders headers, URI url)
参数类型为WebSocketSession的org.springframework.web.socket.sockjs.client中的方法 修饰符和类型 方法 说明 void
WebSocketClientSockJsSession. initializeDelegateSession(WebSocketSession session)
类型变量类型为WebSocketSession的org.springframework.web.socket.sockjs.client中的构造器参数 构造器 说明 AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)
WebSocketClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)
XhrClientSockJsSession(TransportRequest request, WebSocketHandler handler, XhrTransport transport, SettableListenableFuture<WebSocketSession> connectFuture)
org.springframework.web.socket.sockjs.transport中WebSocketSession的使用
org.springframework.web.socket.sockjs.transport中WebSocketSession的子接口 修饰符和类型 接口 说明 interface
SockJsSession
SockJS extension of Spring's standardWebSocketSession
.org.springframework.web.socket.sockjs.transport.handler中WebSocketSession的使用
参数类型为WebSocketSession的org.springframework.web.socket.sockjs.transport.handler中的方法 修饰符和类型 方法 说明 void
SockJsWebSocketHandler. afterConnectionClosed(WebSocketSession wsSession, CloseStatus status)
void
SockJsWebSocketHandler. afterConnectionEstablished(WebSocketSession wsSession)
void
SockJsWebSocketHandler. handleTextMessage(WebSocketSession wsSession, TextMessage message)
void
SockJsWebSocketHandler. handleTransportError(WebSocketSession webSocketSession, Throwable exception)
org.springframework.web.socket.sockjs.transport.session中WebSocketSession的使用
实现WebSocketSession的org.springframework.web.socket.sockjs.transport.session中的类 修饰符和类型 类 说明 class
AbstractHttpSockJsSession
An abstract base class for use with HTTP transport SockJS sessions.class
AbstractSockJsSession
An abstract base class for SockJS sessions implementingSockJsSession
.class
PollingSockJsSession
A SockJS session for use with polling HTTP transports.class
StreamingSockJsSession
A SockJS session for use with streaming HTTP transports.class
WebSocketServerSockJsSession
A SockJS session for use with the WebSocket transport.参数类型为WebSocketSession的org.springframework.web.socket.sockjs.transport.session中的方法 修饰符和类型 方法 说明 void
WebSocketServerSockJsSession. handleMessage(TextMessage message, WebSocketSession wsSession)
void
WebSocketServerSockJsSession. initializeDelegateSession(WebSocketSession session)