com.ibm.mqlight.api

Class NonBlockingClientAdapter<T>

java.lang.Object

com.ibm.mqlight.api.NonBlockingClientAdapter<T>

All Implemented Interfaces:

NonBlockingClientListener<T>

public abstract class NonBlockingClientAdapter<T>
extends Object
implements NonBlockingClientListener<T>

An abstract adapter class for receiving client events. The methods in this class are empty. This class exists as convenience for creating client listener objects. Extend this class to create a NonBlockingClientListener object and override the methods for the events of interest. (If you implement the NonBlockingClientListener interface, you have to define all of the methods in it. This abstract class defines null methods for them all, so you can only have to define methods for events you care about.)

Constructor Summary

Constructors

Constructor and Description
NonBlockingClientAdapter()

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 throwable) 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 throwable) Called as a notification when the client transitions into stopped state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NonBlockingClientAdapter

public NonBlockingClientAdapter()

Method Detail

onStarted

public void onStarted(NonBlockingClient client,
             T context)

Description copied from interface: NonBlockingClientListener

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

Specified by:

onStarted in interface NonBlockingClientListener<T>

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

public void onStopped(NonBlockingClient client,
             T context,
             ClientException throwable)

Description copied from interface: NonBlockingClientListener

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

Specified by:

onStopped in interface NonBlockingClientListener<T>

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.

throwable - 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

public void onRestarted(NonBlockingClient client,
               T context)

Description copied from interface: NonBlockingClientListener

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

Specified by:

onRestarted in interface NonBlockingClientListener<T>

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

public void onRetrying(NonBlockingClient client,
              T context,
              ClientException throwable)

Description copied from interface: NonBlockingClientListener

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.

Specified by:

onRetrying in interface NonBlockingClientListener<T>

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.

throwable - 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

public void onDrain(NonBlockingClient client,
           T context)

Description copied from interface: NonBlockingClientListener

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.

Specified by:

onDrain in interface NonBlockingClientListener<T>

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.