com.solace.messaging.util

Interface AsyncConnectable

All Known Subinterfaces:

MessagingService

@ProviderType
public interface AsyncConnectable

An interface for asynchronous (non-blocking) connection related operations.

Since:

1.0

See Also:

CompletableFuture for Asynchronous Programming in Java 8.

Method Summary

Modifier and Type	Method and Description
<T> CompletableFuture<T>	connectAsync() Connects asynchronously with a PubSub+ event broker.
<T> void	connectAsync(CompletionListener<T> connectionListener) Connects asynchronously with a PubSub+ event broker with a callback.
CompletableFuture<Void>	disconnectAsync() Disconnects asynchronously with a PubSub+ event broker.
void	disconnectAsync(CompletionListener<Void> disconnectionListener) Disconnects asynchronously with a PubSub+ event broker with a callback.

Method Detail

connectAsync

<T> CompletableFuture<T> connectAsync()
                               throws PubSubPlusClientException,
                                      IllegalStateException

Connects asynchronously with a PubSub+ event broker.

Returns:

a future state of a connection request that can succeed or fail

Throws:

PubSubPlusClientException - if the messaging service cannot be connected

IllegalStateException - if an attempt to connect to a messaging service that's been disconnected

Since:

1.0

connectAsync

<T> void connectAsync(CompletionListener<T> connectionListener)
               throws PubSubPlusClientException,
                      IllegalStateException

Connects asynchronously with a PubSub+ event broker with a callback.

Parameters:

connectionListener - the callback for future notifications about completion state of the connection process

Throws:

PubSubPlusClientException - if the messaging service cannot be connected

IllegalStateException - if an attempt to connect to a messaging service that's been disconnected

Since:

1.0

disconnectAsync

CompletableFuture<Void> disconnectAsync()
                                 throws PubSubPlusClientException,
                                        IllegalStateException

Disconnects asynchronously with a PubSub+ event broker.

Returns:

the future state of a disconnection request that can succeed or fail

Throws:

PubSubPlusClientException - if the messaging service cannot be disconnected

IllegalStateException

Since:

1.0

disconnectAsync

void disconnectAsync(CompletionListener<Void> disconnectionListener)
              throws PubSubPlusClientException,
                     IllegalStateException

Disconnects asynchronously with a PubSub+ event broker with a callback.

Parameters:

disconnectionListener - the callback for future notifications about completion of the disconnection process

Throws:

PubSubPlusClientException - if the messaging service cannot be disconnected

IllegalStateException - if a service is in an inappropriate state to perform a disconnect

Since:

1.0