org.springframework.web.socket.messaging

Class WebSocketStompClient.WebSocketTcpConnectionHandlerAdapter

java.lang.Object

org.springframework.web.socket.messaging.WebSocketStompClient.WebSocketTcpConnectionHandlerAdapter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, TcpConnection<byte[]>, FailureCallback, ListenableFutureCallback<WebSocketSession>, SuccessCallback<WebSocketSession>, WebSocketHandler

Enclosing class:

WebSocketStompClient

private class WebSocketStompClient.WebSocketTcpConnectionHandlerAdapter
extends java.lang.Object
implements ListenableFutureCallback<WebSocketSession>, WebSocketHandler, TcpConnection<byte[]>

Adapt WebSocket to the TcpConnectionHandler and TcpConnection contracts.

Field Summary

Fields

Modifier and Type	Field and Description
private WebSocketStompClient.StompWebSocketMessageCodec	codec
private TcpConnectionHandler<byte[]>	connectionHandler
private java.util.List<java.util.concurrent.ScheduledFuture<?>>	inactivityTasks
private long	lastReadTime
private long	lastWriteTime
private WebSocketSession	session

Constructor Summary

Constructors

Constructor and Description
WebSocketTcpConnectionHandlerAdapter(TcpConnectionHandler<byte[]> connectionHandler)

Method Summary

Modifier and Type	Method and Description
void	afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred.
void	afterConnectionEstablished(WebSocketSession session) Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.
private void	cancelInactivityTasks()
void	close() Close the connection.
void	handleMessage(WebSocketSession session, WebSocketMessage<?> webSocketMessage) Invoked when a new WebSocket message arrives.
void	handleTransportError(WebSocketSession session, java.lang.Throwable ex) Handle an error from the underlying WebSocket message transport.
void	onFailure(java.lang.Throwable ex) Called when the ListenableFuture completes with failure.
void	onReadInactivity(java.lang.Runnable runnable, long duration) Register a task to invoke after a period of read inactivity.
void	onSuccess(WebSocketSession webSocketSession) Called when the ListenableFuture completes with success.
void	onWriteInactivity(java.lang.Runnable runnable, long duration) Register a task to invoke after a period of write inactivity.
ListenableFuture<java.lang.Void>	send(Message<byte[]> message) Send the given message.
boolean	supportsPartialMessages() Whether the WebSocketHandler handles partial messages.
private void	updateLastWriteTime()

Methods inherited from class java.lang.Object

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

Field Detail

connectionHandler

private final TcpConnectionHandler<byte[]> connectionHandler

codec

private final WebSocketStompClient.StompWebSocketMessageCodec codec

session

private volatile WebSocketSession session

lastReadTime

private volatile long lastReadTime

lastWriteTime

private volatile long lastWriteTime

inactivityTasks

private final java.util.List<java.util.concurrent.ScheduledFuture<?>> inactivityTasks

Constructor Detail

WebSocketTcpConnectionHandlerAdapter

public WebSocketTcpConnectionHandlerAdapter(TcpConnectionHandler<byte[]> connectionHandler)

Method Detail

onSuccess

public void onSuccess(WebSocketSession webSocketSession)

Description copied from interface: SuccessCallback

Called when the ListenableFuture completes with success.

Note that Exceptions raised by this method are ignored.

Specified by:

onSuccess in interface SuccessCallback<WebSocketSession>

Parameters:

webSocketSession - the result

onFailure

public void onFailure(java.lang.Throwable ex)

Description copied from interface: FailureCallback

Called when the ListenableFuture completes with failure.

Note that Exceptions raised by this method are ignored.

Specified by:

onFailure in interface FailureCallback

Parameters:

ex - the failure

afterConnectionEstablished

public void afterConnectionEstablished(WebSocketSession session)

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

handleMessage

public void handleMessage(WebSocketSession session,
                          WebSocketMessage<?> webSocketMessage)

Description copied from interface: WebSocketHandler

Invoked when a new WebSocket message arrives.

Specified by:

handleMessage in interface WebSocketHandler

handleTransportError

public void handleTransportError(WebSocketSession session,
                                 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

Throws:

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

afterConnectionClosed

public void afterConnectionClosed(WebSocketSession session,
                                  CloseStatus closeStatus)
                           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

Throws:

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

cancelInactivityTasks

private void cancelInactivityTasks()

supportsPartialMessages

public boolean supportsPartialMessages()

Description copied from interface: WebSocketHandler

Whether the WebSocketHandler handles partial messages. If this flag is set to true and the underlying WebSocket server supports partial messages, then a large WebSocket message, or one of an unknown size may be split and maybe received over multiple calls to WebSocketHandler.handleMessage(WebSocketSession, WebSocketMessage). The flag WebSocketMessage.isLast() indicates if the message is partial and whether it is the last part.

Specified by:

supportsPartialMessages in interface WebSocketHandler

send

public ListenableFuture<java.lang.Void> send(Message<byte[]> message)

Description copied from interface: TcpConnection

Send the given message.

Specified by:

send in interface TcpConnection<byte[]>

Parameters:

message - the message

Returns:

a ListenableFuture that can be used to determine when and if the message was successfully sent

updateLastWriteTime

private void updateLastWriteTime()

onReadInactivity

public void onReadInactivity(java.lang.Runnable runnable,
                             long duration)

Description copied from interface: TcpConnection

Register a task to invoke after a period of read inactivity.

Specified by:

onReadInactivity in interface TcpConnection<byte[]>

Parameters:

runnable - the task to invoke

duration - the amount of inactive time in milliseconds

onWriteInactivity

public void onWriteInactivity(java.lang.Runnable runnable,
                              long duration)

Description copied from interface: TcpConnection

Register a task to invoke after a period of write inactivity.

Specified by:

onWriteInactivity in interface TcpConnection<byte[]>

Parameters:

runnable - the task to invoke

duration - the amount of inactive time in milliseconds

close

public void close()

Description copied from interface: TcpConnection

Close the connection.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface TcpConnection<byte[]>