io.nats.streaming

Interface Subscription

All Superinterfaces:

java.lang.AutoCloseable

public interface Subscription
extends java.lang.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 StreamingConnection.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 this subscriber from the server without removing durable interest (if it exists).
void	close(boolean unsubscribe) Removes this subscriber from the server.
SubscriptionOptions	getOptions() Returns the SubscriptionOptions object for this Subscription object.
java.lang.String	getQueue() Returns the optional queue group name.
java.lang.String	getSubject() Retrieves the subject of interest from the Subscription object.
void	unsubscribe() Removes interest in the Subscription.

Method Detail

getSubject

java.lang.String getSubject()

Retrieves the subject of interest from the Subscription object.

Returns:

the subject of interest

getQueue

java.lang.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 java.io.IOException

Removes interest in the Subscription.

For durables, it means that the durable interest is also removed from the server. Restarting a durable with the same name will not resume the subscription, it will be considered a new one.

This call is equivalent to close(true)

Throws:

java.io.IOException - if an error occurs while notifying the server

close

void close()
    throws java.io.IOException

Removes this subscriber from the server without removing durable interest (if it exists).

This call is equivalent to close(false)

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if the close request times out or the client is connected to a server for which this features is not available.

See Also:

AutoCloseable.close()

close

void close(boolean unsubscribe)
    throws java.io.IOException

Removes this subscriber from the server.

Parameters:

unsubscribe - if true, durable interest is also removed.

Throws:

java.io.IOException - if the close request times out or the client is connected to a server for which this features is not available.

getOptions

SubscriptionOptions getOptions()

Returns the SubscriptionOptions object for this Subscription object.

Returns:

this Subscription's code SubscriptionOptions} object.

See Also:

SubscriptionOptions