org.springframework.web.socket.sockjs.client

Class WebSocketTransport.ClientSockJsWebSocketHandler

java.lang.Object

org.springframework.web.socket.handler.AbstractWebSocketHandler

org.springframework.web.socket.handler.TextWebSocketHandler

org.springframework.web.socket.sockjs.client.WebSocketTransport.ClientSockJsWebSocketHandler

All Implemented Interfaces:

WebSocketHandler

Enclosing class:

WebSocketTransport

private static class WebSocketTransport.ClientSockJsWebSocketHandler
extends TextWebSocketHandler

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.concurrent.atomic.AtomicInteger	connectCount
private WebSocketClientSockJsSession	sockJsSession

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ClientSockJsWebSocketHandler(WebSocketClientSockJsSession session)

Method Summary

Modifier and Type	Method and Description
void	afterConnectionClosed(WebSocketSession webSocketSession, CloseStatus status) Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.
void	afterConnectionEstablished(WebSocketSession webSocketSession) Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.
void	handleTextMessage(WebSocketSession webSocketSession, TextMessage message)
void	handleTransportError(WebSocketSession webSocketSession, java.lang.Throwable ex) Handle an error from the underlying WebSocket message transport.

Methods inherited from class org.springframework.web.socket.handler.TextWebSocketHandler

handleBinaryMessage

Methods inherited from class org.springframework.web.socket.handler.AbstractWebSocketHandler

handleMessage, handlePongMessage, supportsPartialMessages

Methods inherited from class java.lang.Object

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

Field Detail

sockJsSession

private final WebSocketClientSockJsSession sockJsSession

connectCount

private final java.util.concurrent.atomic.AtomicInteger connectCount

Constructor Detail

ClientSockJsWebSocketHandler

private ClientSockJsWebSocketHandler(WebSocketClientSockJsSession session)

Method Detail

afterConnectionEstablished

public void afterConnectionEstablished(WebSocketSession webSocketSession)
                                throws java.lang.Exception

Description copied from interface: WebSocketHandler

Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.

Specified by:

afterConnectionEstablished in interface WebSocketHandler

Overrides:

afterConnectionEstablished in class AbstractWebSocketHandler

Throws:

java.lang.Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.

handleTextMessage

public void handleTextMessage(WebSocketSession webSocketSession,
                              TextMessage message)
                       throws java.lang.Exception

Overrides:

handleTextMessage in class AbstractWebSocketHandler

Throws:

java.lang.Exception

handleTransportError

public void handleTransportError(WebSocketSession webSocketSession,
                                 java.lang.Throwable ex)
                          throws java.lang.Exception

Description copied from interface: WebSocketHandler

Handle an error from the underlying WebSocket message transport.

Specified by:

handleTransportError in interface WebSocketHandler

Overrides:

handleTransportError in class AbstractWebSocketHandler

Throws:

java.lang.Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.

afterConnectionClosed

public void afterConnectionClosed(WebSocketSession webSocketSession,
                                  CloseStatus status)
                           throws java.lang.Exception

Description copied from interface: WebSocketHandler

Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred. Although the session may technically still be open, depending on the underlying implementation, sending messages at this point is discouraged and most likely will not succeed.

Specified by:

afterConnectionClosed in interface WebSocketHandler

Overrides:

afterConnectionClosed in class AbstractWebSocketHandler

Throws:

java.lang.Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.