com.solace.messaging.util

Interface Connectable

All Known Subinterfaces:

MessagingService

@ProviderType
public interface Connectable

An interface for synchronous (blocking) connection related operations.

Method Summary

Modifier and Type	Method and Description
Connectable	addReconnectionAttemptListener(MessagingService.ReconnectionAttemptListener listener) Registers the callback to receive reconnection attempt notifications.
Connectable	addReconnectionListener(MessagingService.ReconnectionListener listener) Registers the callback to receive reconnection notifications.
Connectable	connect() Connects synchronously with a PubSub+ event broker.
void	disconnect() Disconnects with a PubSub+ event broker.
boolean	isConnected() Determines if the messaging service is operational and that the connect() method was previously called successfully.
Connectable	removeReconnectionAttemptListener(MessagingService.ReconnectionAttemptListener listener) Unregisters the callback that listens for reconnection attempts notifications.
Connectable	removeReconnectionListener(MessagingService.ReconnectionListener listener) Unregisters the callback that was used to receive reconnection notifications.

Method Detail

connect

Connectable connect()
             throws PubSubPlusClientException,
                    IllegalStateException

Connects synchronously with a PubSub+ event broker. The service is considered off-duty before this method is called.

This method is idempotent when no other connect/disconnect operation is ongoing.

Returns:

an instance for the synchronous connection

Throws:

PubSubPlusClientException - if the messaging service can't be put in service

IllegalStateException - if another disconnect operation is on-going or finished

Since:

1.0

isConnected

boolean isConnected()

Determines if the messaging service is operational and that the connect() method was previously called successfully. This method will continue to return true even if the underlying connection is temporarily lost and the API is attempting to reconnect.

Returns:

false if there is no connection or active attempt of reconnection to a PubSub+ event broker, otherwise true

Since:

1.0

disconnect

void disconnect()
         throws PubSubPlusClientException,
                IllegalStateException

Disconnects with a PubSub+ event broker. The only way to resume service operation after this method asynchronously completes will be to recreate the service instance. Disconnection is a terminal operation.

This method is idempotent when no other connect()/disconnect() operation is ongoing.

Throws:

PubSubPlusClientException - if the messaging service cannot be disconnected; it is recommended to use isConnected() to check if messaging service is still connected even though this exception is thrown

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

Since:

1.0

addReconnectionListener

Connectable addReconnectionListener(MessagingService.ReconnectionListener listener)

Registers the callback to receive reconnection notifications.

Parameters:

listener - the callback to listen for reconnection

Returns:

an instance for the synchronous connection

Since:

1.0

removeReconnectionListener

Connectable removeReconnectionListener(MessagingService.ReconnectionListener listener)

Unregisters the callback that was used to receive reconnection notifications.

Parameters:

listener - the callback to unregister

Returns:

an instance for the synchronous connection

Since:

1.0

addReconnectionAttemptListener

Connectable addReconnectionAttemptListener(MessagingService.ReconnectionAttemptListener listener)

Registers the callback to receive reconnection attempt notifications.

Parameters:

listener - the callback to listen for reconnection attempts

Returns:

an instance for the synchronous connection

Since:

1.0

removeReconnectionAttemptListener

Connectable removeReconnectionAttemptListener(MessagingService.ReconnectionAttemptListener listener)

Unregisters the callback that listens for reconnection attempts notifications.

Parameters:

listener - the callback to listen for reconnection attempts

Returns:

an instance for the synchronous connection

Since:

1.0