nats.client

Interface Subscription

All Superinterfaces:

AutoCloseable, Iterable<Message>

All Known Implementing Classes:

DefaultSubscription

public interface Subscription
extends AutoCloseable, Iterable<Message>

Represents a NATS subscription.

Author:

Mike Heath

Method Summary

Modifier and Type	Method and Description
Registration	addMessageHandler(MessageHandler messageHandler) Registers a MessageHandler instance with this subscription that will be invoked every time the subscription receives a message.
void	close() Closes this subscription.
Integer	getMaxMessages() Returns the maximum number of messages this subscription will receive before being closed automatically.
String	getQueueGroup() Returns the queue group the subscription is participating in.
int	getReceivedMessages() Returns the number of messages this subscription has received.
String	getSubject() Returns this subscription's NATS subject.
MessageIterator	iterator() Creates a MessageIterator that can be used for fetching messages from this subscription in a blocking manner.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

close

void close()

Closes this subscription. Any MessageHandler objects associated with this request will no longer receive messages for this subscription after this method is invoked. All MessageIterator objects created by this subscription will also be closed.

Specified by:

close in interface AutoCloseable

getSubject

String getSubject()

Returns this subscription's NATS subject.

Returns:

this subscription's NATS subject

getReceivedMessages

int getReceivedMessages()

Returns the number of messages this subscription has received.

Returns:

the number of messages this subscription has received.

getMaxMessages

Integer getMaxMessages()

Returns the maximum number of messages this subscription will receive before being closed automatically.

Returns:

the maximum number of messages this subscription will receive or null if no maximum was specified.

getQueueGroup

String getQueueGroup()

Returns the queue group the subscription is participating in.

Returns:

the queue group the subscription is participating in

iterator

MessageIterator iterator()

Creates a MessageIterator that can be used for fetching messages from this subscription in a blocking manner. Because Subscription implements the Iterable interface, a subscription can be used in a Java for loop. For example: for (Message message : nats.subscribe("foo.>") { System.out.println(message); } The for loop may terminate with an exception when the subscription is closed.

Specified by:

iterator in interface Iterable<Message>

Returns:

a MessageIterator

addMessageHandler

Registration addMessageHandler(MessageHandler messageHandler)

Registers a MessageHandler instance with this subscription that will be invoked every time the subscription receives a message.

Parameters:

messageHandler - the message handler that is invoked when a message arrives

Returns:

a handler registration