Package org.springframework.messaging.tcp

Interface TcpOperations<P>

Type Parameters:
P - the type of payload for inbound and outbound messages
All Known Implementing Classes:
ReactorNetty2TcpClient, ReactorNettyTcpClient
public interface TcpOperations<P>
A contract for establishing TCP connections.
Since:
4.0
Author:
Rossen Stoyanchev

  • Method Details

    • connect

      @Deprecated(since="6.0") default ListenableFuture<Void> connect(TcpConnectionHandler<P> connectionHandler)
      Deprecated.
      as of 6.0, in favor of connectAsync(TcpConnectionHandler)
      Open a new connection.
      Parameters:
      connectionHandler - a handler to manage the connection
      Returns:
      a ListenableFuture that can be used to determine when and if the connection is successfully established

    • connectAsync

      CompletableFuture<Void> connectAsync(TcpConnectionHandler<P> connectionHandler)
      Open a new connection.
      Parameters:
      connectionHandler - a handler to manage the connection
      Returns:
      a CompletableFuture that can be used to determine when and if the connection is successfully established
      Since:
      6.0

    • connect

      @Deprecated(since="6.0") default ListenableFuture<Void> connect(TcpConnectionHandler<P> connectionHandler, ReconnectStrategy reconnectStrategy)
      Deprecated.
      as of 6.0, in favor of connectAsync(TcpConnectionHandler, ReconnectStrategy)
      Open a new connection and a strategy for reconnecting if the connection fails.
      Parameters:
      connectionHandler - a handler to manage the connection
      reconnectStrategy - a strategy for reconnecting
      Returns:
      a ListenableFuture that can be used to determine when and if the initial connection is successfully established

    • connectAsync

      CompletableFuture<Void> connectAsync(TcpConnectionHandler<P> connectionHandler, ReconnectStrategy reconnectStrategy)
      Open a new connection and a strategy for reconnecting if the connection fails.
      Parameters:
      connectionHandler - a handler to manage the connection
      reconnectStrategy - a strategy for reconnecting
      Returns:
      a CompletableFuture that can be used to determine when and if the initial connection is successfully established
      Since:
      6.0

    • shutdown

      @Deprecated(since="6.0") default ListenableFuture<Void> shutdown()
      Deprecated.
      as of 6.0, in favor of shutdownAsync()
      Shut down and close any open connections.
      Returns:
      a ListenableFuture that can be used to determine when and if the connection is successfully closed

    • shutdownAsync

      CompletableFuture<Void> shutdownAsync()
      Shut down and close any open connections.
      Returns:
      a CompletableFuture that can be used to determine when and if the connection is successfully closed
      Since:
      6.0