com.ibm.mqlight.api

Class NonBlockingClient

java.lang.Object

com.ibm.mqlight.api.NonBlockingClient

public abstract class NonBlockingClient
extends Object

A Java MQ Light client implementation that never blocks the calling thread when carrying out messaging operations. Notification of completion for any (potentially blocking) operation is via a callback.

Example code for using the non-blocking client to send a message

 NonBlockingClient.create("amqp://localhost", new NonBlockingClientAdapter() {
     public void onStarted(NonBlockingClient client, Void context) {
         SendOptions opts = SendOptions.builder().setQos(QOS.AT_LEAST_ONCE).build();
         client.send("/kittens", "Hello kitty!", null, opts, new CompletionListener() {
             public void onSuccess(NonBlockingClient client, Void context) {
                 client.stop(null, null);
             }
             public void onError(NonBlockingClient client, Void context, Exception exception) {
                 client.stop(null, null);
             }
         }, null);
     }
     public void onDrain(NonBlockingClient client, Void context) {}
 }, null);
 

Example code for receiving messages published to the '/kittens' topic.

 public static void main(String[] args) {
     NonBlockingClient client = NonBlockingClient.create("amqp://localhost", null, null);
     client.subscribe("/kittens", new DestinationAdapter() {
         public void onMessage(NonBlockingClient client, Void context, Delivery delivery) {
             switch (delivery.getType()) {
             case BYTES:
                 BytesDelivery bd = (BytesDelivery)delivery;
                 System.out.println(bd.getData());
                 break;
             case STRING:
                 StringDelivery sd = (StringDelivery)delivery;
                 System.out.println(sd.getData());
                 break;
             }
         }
     }, null, null);
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientOptions	defaultClientOptions
protected static SendOptions	defaultSendOptions
protected static SubscribeOptions	defaultSubscribeOptions

Constructor Summary

Constructors

Constructor and Description
NonBlockingClient()

Method Summary

Methods

Modifier and Type	Method and Description
static <T> NonBlockingClient	create(EndpointService endpointService, CallbackService callbackService, NetworkService networkService, TimerService timerService, com.google.gson.GsonBuilder gsonBuilder, ClientOptions options, NonBlockingClientListener<T> listener, T context) Creates a new instance of the NonBlockingClient in starting state.
static <T> NonBlockingClient	create(String service, ClientOptions options, NonBlockingClientListener<T> listener, T context) Creates a new instance of the NonBlockingClient in starting state.
static <T> NonBlockingClient	create(String service, NonBlockingClientListener<T> listener, T context) Creates a new instance of the NonBlockingClient in starting state.
abstract String	getId()
abstract String	getService()
abstract ClientState	getState()
boolean	send(String topic, ByteBuffer data, Map<String,Object> properties) Send a message to the MQ Light server.
<T> boolean	send(String topic, ByteBuffer data, Map<String,Object> properties, CompletionListener<T> listener, T context) Send a message to the MQ Light server.
abstract <T> boolean	send(String topic, ByteBuffer data, Map<String,Object> properties, SendOptions sendOptions, CompletionListener<T> listener, T context) Sends a ByteBuffer to a topic.
boolean	send(String topic, Object json, Map<String,Object> properties) Send a message to the MQ Light server.
<T> boolean	send(String topic, Object json, Map<String,Object> properties, CompletionListener<T> listener, T context) Sends a message to the MQ Light server.
abstract <T> boolean	send(String topic, Object json, Map<String,Object> properties, SendOptions sendOptions, CompletionListener<T> listener, T context) Sends a JSON object to a topic.
boolean	send(String topic, Object json, Type type, Map<String,Object> properties) Send a message to the MQ Light server.
<T> boolean	send(String topic, Object json, Type type, Map<String,Object> properties, CompletionListener<T> listener, T context) Sends a message to the MQ Light server.
abstract <T> boolean	send(String topic, Object json, Type type, Map<String,Object> properties, SendOptions sendOptions, CompletionListener<T> listener, T context) Sends a JSON object to a topic.
boolean	send(String topic, String data, Map<String,Object> properties) Send a message to the MQ Light server.
<T> boolean	send(String topic, String data, Map<String,Object> properties, CompletionListener<T> listener, T context) Send a message to the MQ Light server.
abstract <T> boolean	send(String topic, String data, Map<String,Object> properties, SendOptions sendOptions, CompletionListener<T> listener, T context) Sends a string message to a topic.
boolean	sendJson(String topic, String json, Map<String,Object> properties) Send a message to the MQ Light server.
<T> boolean	sendJson(String topic, String json, Map<String,Object> properties, CompletionListener<T> listener, T context) Sends a message to the MQ Light server.
abstract <T> boolean	sendJson(String topic, String json, Map<String,Object> properties, SendOptions sendOptions, CompletionListener<T> listener, T context) Sends a String containing JSON data to a topic.
abstract <T> NonBlockingClient	start(CompletionListener<T> listener, T context) Requests that the client transitions into started state.
abstract <T> void	stop(CompletionListener<T> listener, T context) Requests that the client transitions into stopped state, automatically unsubscribing from any destinations previously subscribed to using the subscribe(...) methods.
<T> NonBlockingClient	subscribe(String topicPattern, DestinationListener<T> dstListener, CompletionListener<T> compListener, T context) Subscribes to a destination.
abstract <T> NonBlockingClient	subscribe(String topicPattern, SubscribeOptions subOptions, DestinationListener<T> destListener, CompletionListener<T> compListener, T context) Subscribes the client to a destination, based on the supplied topic pattern and share parameters.
<T> NonBlockingClient	unsubscribe(String topicPattern, CompletionListener<T> listener, T context) Unsubscribes from a destination.
<T> NonBlockingClient	unsubscribe(String topicPattern, int ttl, CompletionListener<T> listener, T context) Unsubscribes from a destination.
abstract <T> NonBlockingClient	unsubscribe(String topicPattern, String share, CompletionListener<T> listener, T context) Unsubscribes from a destination.
abstract <T> NonBlockingClient	unsubscribe(String topicPattern, String share, int ttl, CompletionListener<T> listener, T context) Unsubscribes from a destination.

Methods inherited from class java.lang.Object

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

Field Detail

defaultClientOptions

protected static final ClientOptions defaultClientOptions

defaultSendOptions

protected static final SendOptions defaultSendOptions

defaultSubscribeOptions

protected static final SubscribeOptions defaultSubscribeOptions

Constructor Detail

NonBlockingClient

public NonBlockingClient()

Method Detail

create

public static <T> NonBlockingClient create(String service,
                           ClientOptions options,
                           NonBlockingClientListener<T> listener,
                           T context)
                                throws IllegalArgumentException

Creates a new instance of the NonBlockingClient in starting state.

Parameters:

service - a URI for the service to connect to, for example: amqp://example.org:5672. This URI can start with either amqp:// or amqps:// (for SSL/TLS based connections). User names and passwords may be embedded into the URL - for example: amqp://user:pass@example.com. If a value of null is specified then the client will attempt to locate a suitable service based on its environment. Currently it is capable of locating services in this way when run in the IBM Bluemix environment.

options - a set of options that determine the behaviour of the client.

listener - a listener that is notified of major life-cycle events for the client.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the create method relating to the listener invocation.

Returns:

a new instance of NonBlockingClient

Throws:

IllegalArgumentException - thrown if one or more of the options is not valid.

create

public static <T> NonBlockingClient create(EndpointService endpointService,
                           CallbackService callbackService,
                           NetworkService networkService,
                           TimerService timerService,
                           com.google.gson.GsonBuilder gsonBuilder,
                           ClientOptions options,
                           NonBlockingClientListener<T> listener,
                           T context)
                                throws IllegalArgumentException

Creates a new instance of the NonBlockingClient in starting state. The client will use the set of plugable services, provided as arguments to this method.

Parameters:

endpointService - used to lookup the location of the MQ Light server.

callbackService - used to run each call back into application code.

networkService - used to establish network connections to the MQ Light server.

timerService - used to schedule work to be performed in the future.

options - a set of options that determine the behaviour of the client.

listener - a listener that is notified of major life-cycle events for the client.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the create method relating to the listener invocation.

Returns:

a new instance of NonBlockingClient

Throws:

IllegalArgumentException - thrown if one or more of the options is not valid.

create

public static <T> NonBlockingClient create(String service,
                           NonBlockingClientListener<T> listener,
                           T context)

Creates a new instance of the NonBlockingClient in starting state. This is equivalent to calling: create(service, ClientOptions.create, listener, context);

See Also:

create(String, ClientOptions, NonBlockingClientListener, Object)

getId

public abstract String getId()

Returns:

the client ID, as assigned to this instance of the client either explicitly via the ClientOptions object passed in to the create(String, NonBlockingClientListener, Object) method, or if this value is omitted, then the client ID will be set to a probabilistically unique string by the client implementation.

getService

public abstract String getService()

Returns:

the service to which the client is connected (as specified on the create(String, NonBlockingClientListener, Object) call or null if the client is not, currently, connected to the MQ Light server.

getState

public abstract ClientState getState()

Returns:

the current state of this client.

send

public abstract <T> boolean send(String topic,
               String data,
               Map<String,Object> properties,
               SendOptions sendOptions,
               CompletionListener<T> listener,
               T context)
                      throws StoppedException,
                             IllegalArgumentException

Sends a string message to a topic.

Parameters:

topic - the topic to send the message to. Cannot be null.

data - the string data to send to the topic. Cannot be null.

properties - a Map of properties that will be carried alongside the message. Keys must be non-null and values must be one of the following types: null, Boolean, Byte, Short, Integer, Long, Float, Double, byte[], and String.

sendOptions - a set of options that determine how the send operation works.

listener - a listener object that is notified when the send operation completes. For 'at most once' quality of service messages, this is notified (of success) when the message has been flushed to the network. For 'at least once' quality of service messages, this is notified (of success) when receipt of the message has been confirmed by the service.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the send method relating to the listener invocation.

Returns:

a boolean true if the message was sent immediately, or false if the message was buffered in memory due to a backlog of messages to send over the network)

Throws:

StoppedException - if the client is in stopped or stopping state when this method is invoked.

IllegalArgumentException - if an invalid value is specified for one of the arguments.

send

public abstract <T> boolean send(String topic,
               ByteBuffer data,
               Map<String,Object> properties,
               SendOptions sendOptions,
               CompletionListener<T> listener,
               T context)
                      throws StoppedException,
                             IllegalArgumentException

Sends a ByteBuffer to a topic.

Parameters:

topic - the topic to send the message to. Cannot be null.

data - the byte buffer to send to the topic. Cannot be null.

properties - a Map of properties that will be carried alongside the message. Keys must be non-null and values must be one of the following types: null, Boolean, Byte, Short, Integer, Long, Float, Double, byte[], and String.

sendOptions - a set of options that determine exactly how the send operation works.

listener - a listener object that is notified when the send operation completes. For 'at most once' quality of service messages, this is notified (of success) when the message has been flushed to the network. For 'at least once' quality of service messages, this is notified (of success) when receipt of the message has been confirmed by the service.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the send method relating to the listener invocation.

Returns:

a boolean true if the message was sent immediately, or false if the message was buffered in memory due to a backlog of messages to send over the network)

Throws:

StoppedException - if the client is in stopped or stopping state when this method is invoked.

IllegalArgumentException - if an invalid value is specified for one of the arguments.

send

public abstract <T> boolean send(String topic,
               Object json,
               Map<String,Object> properties,
               SendOptions sendOptions,
               CompletionListener<T> listener,
               T context)
                      throws StoppedException,
                             IllegalArgumentException

Sends a JSON object to a topic.

Parameters:

topic - the topic to send the message to. Cannot be null.

json - the object to send as a JSON object. The send method will convert this object to JSON using the Google Gson library to convert the object to JSON (essentially calling Gson.toJson(Object) to perform the conversion).

properties - a Map of properties that will be carried alongside the message. Keys must be non-null and values must be one of the following types: null, Boolean, Byte, Short, Integer, Long, Float, Double, byte[], and String.

sendOptions - a set of options that determine exactly how the send operation works.

listener - a listener object that is notified when the send operation completes. For 'at most once' quality of service messages, this is notified (of success) when the message has been flushed to the network. For 'at least once' quality of service messages, this is notified (of success) when receipt of the message has been confirmed by the service.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the send method relating to the listener invocation.

Returns:

a boolean true if the message was sent immediately, or false if the message was buffered in memory due to a backlog of messages to send over the network)

Throws:

StoppedException - if the client is in stopped or stopping state when this method is invoked.

IllegalArgumentException - if an invalid value is specified for one of the arguments.

send

public abstract <T> boolean send(String topic,
               Object json,
               Type type,
               Map<String,Object> properties,
               SendOptions sendOptions,
               CompletionListener<T> listener,
               T context)
                      throws StoppedException,
                             IllegalArgumentException

Sends a JSON object to a topic. This form of send can handle objects that use Java Generics.

Parameters:

topic - the topic to send the message to. Cannot be null.

json - the object to send as a JSON object. The send method will convert this object to JSON using the Google Gson library to convert the object to JSON (essentially calling Gson.toJson(Object, Type) to perform the conversion).

type - provides type information about the json object. This allows Java types that make use of Java Generics to be converted to JSON.

properties - a Map of properties that will be carried alongside the message. Keys must be non-null and values must be one of the following types: null, Boolean, Byte, Short, Integer, Long, Float, Double, byte[], and String.

sendOptions - a set of options that determine exactly how the send operation works.

listener - a listener object that is notified when the send operation completes. For 'at most once' quality of service messages, this is notified (of success) when the message has been flushed to the network. For 'at least once' quality of service messages, this is notified (of success) when receipt of the message has been confirmed by the service.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the send method relating to the listener invocation.

Returns:

a boolean true if the message was sent immediately, or false if the message was buffered in memory due to a backlog of messages to send over the network)

Throws:

StoppedException - if the client is in stopped or stopping state when this method is invoked.

IllegalArgumentException - if an invalid value is specified for one of the arguments.

sendJson

public abstract <T> boolean sendJson(String topic,
                   String json,
                   Map<String,Object> properties,
                   SendOptions sendOptions,
                   CompletionListener<T> listener,
                   T context)
                          throws StoppedException,
                                 IllegalArgumentException

Sends a String containing JSON data to a topic. This form of send can be used to integrate with other JSON libraries.

Parameters:

topic - the topic to send the message to. Cannot be null.

json - a String which is assumed to contain JSON information. No checking is performed on this string, it is simply transferred as the body of a message which the appropriate

properties - a Map of properties that will be carried alongside the message. Keys must be non-null and values must be one of the following types: null, Boolean, Byte, Short, Integer, Long, Float, Double, byte[], and String.

sendOptions - a set of options that determine exactly how the send operation works.

listener - a listener object that is notified when the send operation completes. For 'at most once' quality of service messages, this is notified (of success) when the message has been flushed to the network. For 'at least once' quality of service messages, this is notified (of success) when receipt of the message has been confirmed by the service.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the send method relating to the listener invocation.

Returns:

a boolean true if the message was sent immediately, or false if the message was buffered in memory due to a backlog of messages to send over the network)

Throws:

StoppedException - if the client is in stopped or stopping state when this method is invoked.

IllegalArgumentException - if an invalid value is specified for one of the arguments.

send

public <T> boolean send(String topic,
               String data,
               Map<String,Object> properties,
               CompletionListener<T> listener,
               T context)
             throws StoppedException,
                    IllegalArgumentException

Send a message to the MQ Light server. This is equivalent to calling: send(topic, data, properties, SendOptions.builder().build(), listener, context)

Throws:

StoppedException

IllegalArgumentException

See Also:

send(String, String, Map, SendOptions, CompletionListener, Object)

send

public <T> boolean send(String topic,
               ByteBuffer data,
               Map<String,Object> properties,
               CompletionListener<T> listener,
               T context)
             throws StoppedException,
                    IllegalArgumentException

Send a message to the MQ Light server. This is equivalent to calling: send(topic, data, properties, SendOptions.builder().build(), listener, context)

Throws:

StoppedException

IllegalArgumentException

See Also:

send(String, ByteBuffer, Map, SendOptions, CompletionListener, Object)

send

public <T> boolean send(String topic,
               Object json,
               Map<String,Object> properties,
               CompletionListener<T> listener,
               T context)
             throws StoppedException,
                    IllegalArgumentException

Sends a message to the MQ Light server. This is equivalent to calling: send(topic, json, properties, SendOptions.builder().build(), listener, context)

Throws:

StoppedException

IllegalArgumentException

See Also:

send(String, Object, Map, SendOptions, CompletionListener, Object)

send

public <T> boolean send(String topic,
               Object json,
               Type type,
               Map<String,Object> properties,
               CompletionListener<T> listener,
               T context)
             throws StoppedException,
                    IllegalArgumentException

Sends a message to the MQ Light server. This is equivalent to calling: send(topic, json, type, properties, SendOptions.builder().build(), listener, context)

Throws:

StoppedException

IllegalArgumentException

See Also:

send(String, Object, Type, Map, SendOptions, CompletionListener, Object)

sendJson

public <T> boolean sendJson(String topic,
                   String json,
                   Map<String,Object> properties,
                   CompletionListener<T> listener,
                   T context)
                 throws StoppedException,
                        IllegalArgumentException

Sends a message to the MQ Light server. This is equivalent to calling: sendJson(topic, json, properties, SendOptions.builder().build(), listener, context)

Throws:

StoppedException

IllegalArgumentException

See Also:

sendJson(String, String, Map, SendOptions, CompletionListener, Object)

send

public boolean send(String topic,
           String data,
           Map<String,Object> properties)
             throws StoppedException,
                    IllegalArgumentException

Send a message to the MQ Light server. This is equivalent to calling: send(topic, data, properties, SendOptions.builder().build(), null, null)

Throws:

StoppedException

IllegalArgumentException

See Also:

send(String, String, Map, SendOptions, CompletionListener, Object)

send

public boolean send(String topic,
           ByteBuffer data,
           Map<String,Object> properties)
             throws StoppedException,
                    IllegalArgumentException

Send a message to the MQ Light server. This is equivalent to calling: send(topic, data, properties, SendOptions.builder().build(), null, null)

Throws:

StoppedException

IllegalArgumentException

See Also:

send(String, ByteBuffer, Map, SendOptions, CompletionListener, Object)

send

public boolean send(String topic,
           Object json,
           Map<String,Object> properties)
             throws StoppedException,
                    IllegalArgumentException

Send a message to the MQ Light server. This is equivalent to calling: send(topic, json, properties, SendOptions.builder().build(), null, null)

Throws:

StoppedException

IllegalArgumentException

See Also:

send(String, Object, Map, SendOptions, CompletionListener, Object)

send

public boolean send(String topic,
           Object json,
           Type type,
           Map<String,Object> properties)
             throws StoppedException,
                    IllegalArgumentException

Send a message to the MQ Light server. This is equivalent to calling: send(topic, json, type, properties, SendOptions.builder().build(), null, null)

Throws:

StoppedException

IllegalArgumentException

See Also:

send(String, Object, Type, Map, SendOptions, CompletionListener, Object)

sendJson

public boolean sendJson(String topic,
               String json,
               Map<String,Object> properties)
                 throws StoppedException,
                        IllegalArgumentException

Send a message to the MQ Light server. This is equivalent to calling: send(topic, json, properties, SendOptions.builder().build(), null, null)

Throws:

StoppedException

IllegalArgumentException

See Also:

sendJson(String, String, Map, SendOptions, CompletionListener, Object)

start

public abstract <T> NonBlockingClient start(CompletionListener<T> listener,
                          T context)
                                 throws StoppedException

Requests that the client transitions into started state. This prepares the client to send and/or receive messages from the server. As new instances of NonBlockingClient are created in starting state, this method need only be called if an instance of the client has been stopped using the stop(CompletionListener, Object) method.

Parameters:

listener - this listener will be invoked when the start operation completes. This can either be when the client has attained started state, or when a subsequent call to stop results in the client attaining stopped state before it ever achieves started state.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the start method relating to the listener invocation.

Returns:

the instance of NonBlockingClient that the start method was invoked upon.

Throws:

StoppedException - if the client is in the process of stopping when this method is invoked.

stop

public abstract <T> void stop(CompletionListener<T> listener,
            T context)
                   throws StartingException

Requests that the client transitions into stopped state, automatically unsubscribing from any destinations previously subscribed to using the subscribe(...) methods. Any messages held by the client, pending transmission to the server, will not be transmitted.

Parameters:

listener - a listener that is notified when the stop operation has completed and the client has attained stopped state.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the stop method relating to the listener invocation.

Throws:

StartingException - if the client is in the process of starting when this method is invoked.

subscribe

public abstract <T> NonBlockingClient subscribe(String topicPattern,
                              SubscribeOptions subOptions,
                              DestinationListener<T> destListener,
                              CompletionListener<T> compListener,
                              T context)
                                     throws SubscribedException,
                                            StoppedException,
                                            IllegalArgumentException

Subscribes the client to a destination, based on the supplied topic pattern and share parameters. The topicPattern parameter is matched against the topic that messages are sent to, allowing the messaging service to determine whether a particular message will be delivered to a particular destination, and hence the subscribing client.

Parameters:

topicPattern - the topic pattern to subscribe to. This determines which messages will be held at the subscribed to destination pending delivery to this client. Cannot be null.

subOptions - a set of options that control the behaviour of the destination subscribed to and influence how this client receives messages from the destination.

destListener - a listener that is notified when messages arrive at the client and also when the destination is unsubscribed from using the unsubscribe(String, String, int, CompletionListener, Object) method. Cannot be null.

compListener - a listener that is notified when the subscribe operation completes. If a value of null is specified then no-one is notified.

context - a context object that is passed into the listeners registered using this method. The object supplied can be used within the listener code to identify the specific instance of the subscribe method relating to the listener invocation.

Returns:

the instance of NonBlockingClient that the unsubscribe method was invoked upon. This is to allow invocations of the unsubscribe method to be chained.

Throws:

SubscribedException - if the client is already subscribed to the destination identified by a combination of the topic pattern and share options.

StoppedException - if the client is in stopped or stopping state when this method is invoked.

IllegalArgumentException - if an invalid value is specified for one of the arguments.

subscribe

public <T> NonBlockingClient subscribe(String topicPattern,
                              DestinationListener<T> dstListener,
                              CompletionListener<T> compListener,
                              T context)
                            throws SubscribedException,
                                   StoppedException,
                                   IllegalArgumentException

Subscribes to a destination. This is equivalent to calling: subscribe(topicPattern, new SubscribeOptions(), listener, context)

Throws:

SubscribedException

StoppedException

IllegalArgumentException

See Also:

subscribe(String, SubscribeOptions, DestinationListener, CompletionListener, Object)

unsubscribe

public abstract <T> NonBlockingClient unsubscribe(String topicPattern,
                                String share,
                                int ttl,
                                CompletionListener<T> listener,
                                T context)
                                       throws UnsubscribedException,
                                              StoppedException,
                                              IllegalArgumentException

Unsubscribes from a destination. Once complete, this stops messages received by the destination from being sent to this client.

Parameters:

topicPattern - a topic pattern that identifies the destination to unsubscribe from. This must match one of the topic patterns previously subscribed to using the subscribe(String, SubscribeOptions, DestinationListener, CompletionListener, Object) method.

share - a share name that identifies the destination to unsubscribe from. This must match the share option specified when the corresponding topic pattern was subscribed to. If a value of null is supplied for this parameter then the client will attempt to unsubscribe from a private destination.

ttl - the new time-to-live value to assign to the destination. Currently the only supported value for this parameter is zero.

listener - a listener that is notified when the unsubscribe operation has completed. Invocation of this listener is deferred until any messages, buffered pending delivery to a DestiantionListener registered with the client, have been delivered. If a value of null is supplied for this parameter then no notification will be generated.

context - a context object that is passed into the listener. This can be used within the listener code to identify the specific instance of the stop method relating to the listener invocation.

Returns:

the instance of NonBlockingClient that the unsubscribe method was invoked upon. This is to allow invocations of the unsubscribe method to be chained.

Throws:

UnsubscribedException - if an attempt is made to unsubscribe from a destination that the client is not currently subscribed to.

StoppedException - if the client is in stopped or stopping state when this method is invoked.

IllegalArgumentException - if an invalid value is specified for one of the arguments.

unsubscribe

public <T> NonBlockingClient unsubscribe(String topicPattern,
                                int ttl,
                                CompletionListener<T> listener,
                                T context)
                              throws UnsubscribedException,
                                     StoppedException,
                                     IllegalArgumentException

Unsubscribes from a destination. This is equivalent to calling: unsubscribe(topicPattern, null, ttl)

Throws:

UnsubscribedException

StoppedException

IllegalArgumentException

See Also:

unsubscribe(String, String, int, CompletionListener, Object)

unsubscribe

public abstract <T> NonBlockingClient unsubscribe(String topicPattern,
                                String share,
                                CompletionListener<T> listener,
                                T context)
                                       throws UnsubscribedException,
                                              StoppedException,
                                              IllegalArgumentException

Unsubscribes from a destination. This is equivalent to calling the unsubscribe(String, String, int, CompletionListener, Object) method without specifying a ttl (time-to-live) value. This has the effect of unsubscribing from the destination without changing the ttl value currently assigned to the destination.

Throws:

UnsubscribedException

StoppedException

IllegalArgumentException

unsubscribe

public <T> NonBlockingClient unsubscribe(String topicPattern,
                                CompletionListener<T> listener,
                                T context)
                              throws UnsubscribedException,
                                     StoppedException,
                                     IllegalArgumentException

Unsubscribes from a destination. This is equivalent to calling: unsubscribe(topicPattern, null, listerner, context)

Throws:

UnsubscribedException

StoppedException

IllegalArgumentException

See Also:

unsubscribe(String, String, CompletionListener, Object)