com.ibm.mqlight.api

Interface NonBlockingClientListener<T>

All Known Implementing Classes:

NonBlockingClientAdapter

public interface NonBlockingClientListener<T>

A listener for events that occur to an instance of the NonBlockingClient

Method Summary

Methods

Modifier and Type	Method and Description
void	onDrain(NonBlockingClient client, T context) Called as a notification when the client has flushed any buffered messages to the network.
void	onRestarted(NonBlockingClient client, T context) Called as a notification when the client transitions into restarting state.
void	onRetrying(NonBlockingClient client, T context, ClientException exception) Called as a notification when the client transitions into retrying state.
void	onStarted(NonBlockingClient client, T context) Called as a notification when the client transitions into started state.
void	onStopped(NonBlockingClient client, T context, ClientException exception) Called as a notification when the client transitions into stopped state.

Method Detail

onStarted

void onStarted(NonBlockingClient client,
             T context)

Called as a notification when the client transitions into started state.

Parameters:

client - a reference to the client that the listener was registered for and this notification pertains to.

context - the context object that was specified when the listener was registered.

onStopped

void onStopped(NonBlockingClient client,
             T context,
             ClientException exception)

Called as a notification when the client transitions into stopped state.

Parameters:

client - a reference to the client that the listener was registered for and this notification pertains to.

context - the context object that was specified when the listener was registered.

exception - indicates why the client transitioned into stopped state. This will be null when the client transitions into stopped state because the stop() method is called on the client. This exception can be one of the following client type exceptions:

• NetworkException indicates a non-recoverable network type error.
• SecurityException indicates a security related error.
• ReplacedException indicates that the client has been replaced by another instance of itself.
• ClientException a general client type exception, usually caused by another exception.

onRestarted

void onRestarted(NonBlockingClient client,
               T context)

Called as a notification when the client transitions into restarting state.

Parameters:

client - a reference to the client that the listener was registered for and this notification pertains to.

context - the context object that was specified when the listener was registered.

onRetrying

void onRetrying(NonBlockingClient client,
              T context,
              ClientException exception)

Called as a notification when the client transitions into retrying state. Or for each time the client attempts to re-connect to the MQ Light server, if this connection attempt is unsuccessful.

Parameters:

client - a reference to the client that the listener was registered for and this notification pertains to.

context - the context object that was specified when the listener was registered.

exception - indicates why the client transitioned (or remains) in the retrying state. This exception can be one of the following client type exceptions:

• NetworkException indicates a network type error.
• ClientException a general client type exception, usually caused by another exception.

onDrain

void onDrain(NonBlockingClient client,
           T context)

Called as a notification when the client has flushed any buffered messages to the network. This notification can be used in conjunction with the value returned by a NonBlockingClient.send(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.Object>, com.ibm.mqlight.api.SendOptions, com.ibm.mqlight.api.CompletionListener<T>, T) method to efficiently send messages without buffering a large number of messages in memory allocated by the client.

Parameters:

client - a reference to the client that the listener was registered for and this notification pertains to.

context - the context object that was specified when the listener was registered.