nats.client

Class DefaultSubscription

java.lang.Object

nats.client.DefaultSubscription

All Implemented Interfaces:

AutoCloseable, Iterable<Message>, Subscription

public class DefaultSubscription
extends Object
implements Subscription

Provides an abstract implementation of the Subscription interface.

Author:

Mike Heath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultSubscription(String subject, String queueGroup, Integer maxMessages, MessageHandler... messageHandlers)

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.
protected Message	createMessage(String subject, String body, String queueGroup, String replyTo)
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.
void	onMessage(String subject, String body, String replyTo, Executor executor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultSubscription

protected DefaultSubscription(String subject,
                              String queueGroup,
                              Integer maxMessages,
                              MessageHandler... messageHandlers)

Method Detail

close

public void close()

Description copied from interface: Subscription

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

Specified by:

close in interface Subscription

getSubject

public String getSubject()

Description copied from interface: Subscription

Returns this subscription's NATS subject.

Specified by:

getSubject in interface Subscription

Returns:

this subscription's NATS subject

addMessageHandler

public Registration addMessageHandler(MessageHandler messageHandler)

Description copied from interface: Subscription

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

Specified by:

addMessageHandler in interface Subscription

Parameters:

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

Returns:

a handler registration

iterator

public MessageIterator iterator()

Description copied from interface: Subscription

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>

Specified by:

iterator in interface Subscription

Returns:

a MessageIterator

getReceivedMessages

public int getReceivedMessages()

Description copied from interface: Subscription

Returns the number of messages this subscription has received.

Specified by:

getReceivedMessages in interface Subscription

Returns:

the number of messages this subscription has received.

getMaxMessages

public Integer getMaxMessages()

Description copied from interface: Subscription

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

Specified by:

getMaxMessages in interface Subscription

Returns:

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

getQueueGroup

public String getQueueGroup()

Description copied from interface: Subscription

Returns the queue group the subscription is participating in.

Specified by:

getQueueGroup in interface Subscription

Returns:

the queue group the subscription is participating in

onMessage

public void onMessage(String subject,
                      String body,
                      String replyTo,
                      Executor executor)

createMessage

protected Message createMessage(String subject,
                                String body,
                                String queueGroup,
                                String replyTo)