io.nats.stan

Interface Subscription

All Superinterfaces:

AutoCloseable

public interface Subscription
extends AutoCloseable

A client uses a Subscription object to receive messages that have been published to a subject.

Each Subscription object is unique, even if the subscription is to the same subject. This means that if Connection.subscribe("foo", cb) is called twice in a row, each of the resulting Subscription objects will be unique, and any message delivered on subject "foo" will be delivered individually to both Subscription objects.

Method Summary

Modifier and Type	Method and Description
void	close() Removes interest in the Subscription's subject immediately.
SubscriptionOptions	getOptions() Returns the SubscriptionOptions object for this Subscription object.
String	getQueue() Returns the optional queue group name.
String	getSubject() Retrieves the subject of interest from the Subscription object.
void	unsubscribe() Removes interest in the Subscription object's subject immediately.

Method Detail

getSubject

String getSubject()

Retrieves the subject of interest from the Subscription object.

Returns:

the subject of interest

getQueue

String getQueue()

Returns the optional queue group name. If present, all subscriptions with the same name will form a distributed queue, and each message will only be processed by one member of the group.

Returns:

the name of the queue group this Subscription belongs to.

unsubscribe

void unsubscribe()
          throws IOException,
                 TimeoutException

Removes interest in the Subscription object's subject immediately.

Throws:

IOException - if an error occurs while notifying the server

TimeoutException - if the unsubscribe request times out without a response

close

void close()

Removes interest in the Subscription's subject immediately.

Specified by:

close in interface AutoCloseable

See Also:

Subscription.close(), AutoCloseable.close()

getOptions

SubscriptionOptions getOptions()

Returns the SubscriptionOptions object for this Subscription object.

Returns:

this Subscription's code SubscriptionOptions} object.

See Also:

SubscriptionOptions