Spring Messaging 6.1.4 · org.springframework.messaging.tcp.TcpOperations

Method Summary

Modifier and Type	Method and Description
public default ListenableFuture<Void>	Returns: a ListenableFuture that can be used to determine when and if the connection is successfully established connect(TcpConnectionHandler<P> a handler to manage the connection connectionHandler) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(TcpConnectionHandler)` Open a new connection.
public default ListenableFuture<Void>	Returns: a ListenableFuture that can be used to determine when and if the initial connection is successfully established connect(TcpConnectionHandler<P> a handler to manage the connection connectionHandler, ReconnectStrategy a strategy for reconnecting reconnectStrategy) Deprecated since 6.0. as of 6.0, in favor of `connectAsync(TcpConnectionHandler, ReconnectStrategy)` Open a new connection and a strategy for reconnecting if the connection fails.
public CompletableFuture<Void>	Returns: a CompletableFuture that can be used to determine when and if the connection is successfully established connectAsync(TcpConnectionHandler<P> a handler to manage the connection connectionHandler) Open a new connection.
public CompletableFuture<Void>	Returns: a CompletableFuture that can be used to determine when and if the initial connection is successfully established connectAsync(TcpConnectionHandler<P> a handler to manage the connection connectionHandler, ReconnectStrategy a strategy for reconnecting reconnectStrategy) Open a new connection and a strategy for reconnecting if the connection fails.
public default ListenableFuture<Void>	Returns: a ListenableFuture that can be used to determine when and if the connection is successfully closed shutdown() Deprecated since 6.0. as of 6.0, in favor of `shutdownAsync()` Shut down and close any open connections.
public CompletableFuture<Void>	Returns: a CompletableFuture that can be used to determine when and if the connection is successfully closed shutdownAsync() Shut down and close any open connections.

Method Detail

connect back to summary

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

public default ListenableFuture<Void> connect(TcpConnectionHandler connectionHandler)

Deprecated

since 6.0.

as of 6.0, in favor of connectAsync(TcpConnectionHandler)

Open a new connection.

Parameters

connectionHandler:TcpConnectionHandler: a handler to manage the connection

Returns:ListenableFuture<Void>

a ListenableFuture that can be used to determine when and if the connection is successfully established

Annotations

@Deprecated
since:6.0

connect back to summary

connect	back to summary
public default ListenableFuture<Void> connect(TcpConnectionHandler<P> connectionHandler, ReconnectStrategy reconnectStrategy) Deprecated since 6.0. 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:TcpConnectionHandler<P> a handler to manage the connection reconnectStrategy:ReconnectStrategy a strategy for reconnecting Returns:ListenableFuture<Void> a ListenableFuture that can be used to determine when and if the initial connection is successfully established Annotations @Deprecated since:6.0

public default ListenableFuture<Void> connect(TcpConnectionHandler connectionHandler, ReconnectStrategy reconnectStrategy)

Deprecated

since 6.0.

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:TcpConnectionHandler: a handler to manage the connection
reconnectStrategy:ReconnectStrategy: a strategy for reconnecting

Returns:ListenableFuture<Void>

a ListenableFuture that can be used to determine when and if the initial connection is successfully established

Annotations

@Deprecated
since:6.0

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

connectAsync

back to summary

public CompletableFuture<Void> connectAsync(TcpConnectionHandler connectionHandler)

Open a new connection.

Parameters

connectionHandler:TcpConnectionHandler: a handler to manage the connection

Returns:CompletableFuture<Void>

a CompletableFuture that can be used to determine when and if the connection is successfully established

Since

6.0

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

connectAsync

back to summary

public CompletableFuture<Void> connectAsync(TcpConnectionHandler connectionHandler, ReconnectStrategy reconnectStrategy)

Open a new connection and a strategy for reconnecting if the connection fails.

Parameters

connectionHandler:TcpConnectionHandler: a handler to manage the connection
reconnectStrategy:ReconnectStrategy: a strategy for reconnecting

Returns:CompletableFuture<Void>

a CompletableFuture that can be used to determine when and if the initial connection is successfully established

Since

6.0

shutdown back to summary

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

public default ListenableFuture<Void> shutdown()

Deprecated

since 6.0.

as of 6.0, in favor of shutdownAsync()

Shut down and close any open connections.

Returns:ListenableFuture<Void>

a ListenableFuture that can be used to determine when and if the connection is successfully closed

Annotations

@Deprecated
since:6.0

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

shutdownAsync

back to summary

public CompletableFuture<Void> shutdownAsync()

Shut down and close any open connections.

Returns:CompletableFuture<Void>: a CompletableFuture that can be used to determine when and if the connection is successfully closed
Since: 6.0

public Interface TcpOperations<P>

Method Summary

Method Detail