org.springframework.messaging.tcp

Interface TcpConnection<P>

Type Parameters:

P - the type of payload for outbound Messages

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

Reactor2TcpConnection, WebSocketStompClient.WebSocketTcpConnectionHandlerAdapter

public interface TcpConnection<P>
extends java.io.Closeable

A contract for sending messages and managing a TCP connection.

Since:

4.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
void	onReadInactivity(java.lang.Runnable runnable, long duration) Register a task to invoke after a period of of read inactivity.
void	onWriteInactivity(java.lang.Runnable runnable, long duration) Register a task to invoke after a period of of write inactivity.
ListenableFuture<java.lang.Void>	send(Message<P> message) Send the given message.

Method Detail

send

ListenableFuture<java.lang.Void> send(Message<P> message)

Send the given message.

Parameters:

message - the message

Returns:

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

onReadInactivity

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

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

Parameters:

runnable - the task to invoke

duration - the amount of inactive time in milliseconds

onWriteInactivity

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

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

Parameters:

runnable - the task to invoke

duration - the amount of inactive time in milliseconds

close

void close()

Close the connection.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable