nats.client

Class BlockingQueueMessageIterator

java.lang.Object

nats.client.BlockingQueueMessageIterator

All Implemented Interfaces:

AutoCloseable, Iterator<Message>, MessageHandler, MessageIterator

public class BlockingQueueMessageIterator
extends Object
implements MessageIterator, MessageHandler

A MessageIterator that is backed by a LinkedBlockingQueue.

Author:

Mike Heath

Constructor Summary

Constructors

Constructor and Description
BlockingQueueMessageIterator()

Method Summary

Modifier and Type	Method and Description
void	close() Closes this subscription iterator.
boolean	hasNext() Returns true if this iterator is open.
Message	next() Returns the next Message sent by the Nats server.
Message	next(long timeout, TimeUnit unit) Returns the next Message sent by the Nats server within the specified time limit.
void	onMessage(Message message)
void	remove() Throws an UnsupportedOperationException since you obviously can't remove a message after it has been received.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

BlockingQueueMessageIterator

public BlockingQueueMessageIterator()

Method Detail

close

public void close()

Description copied from interface: MessageIterator

Closes this subscription iterator.

Closing the subscription associated with this iterator will close this iterator.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MessageIterator

hasNext

public boolean hasNext()

Description copied from interface: MessageIterator

Returns true if this iterator is open. We do not know if/when the Nats server will publish another message so we assume another message is pending so, this method always returns true unless this iterator has been closed.

Closing the subscription associated with this iterator will close this iterator.

Specified by:

hasNext in interface Iterator<Message>

Specified by:

hasNext in interface MessageIterator

Returns:

true unless this iterator has been closed.

next

public Message next()
             throws NatsClosedException,
                    NatsInterruptedException,
                    NoSuchElementException

Description copied from interface: MessageIterator

Returns the next Message sent by the Nats server.

Specified by:

next in interface Iterator<Message>

Specified by:

next in interface MessageIterator

Returns:

the next Message sent by the Nats server.

Throws:

NatsClosedException - thrown if the iterator closes while waiting for a message.

NatsInterruptedException

NoSuchElementException

next

public Message next(long timeout,
                    TimeUnit unit)
             throws NatsClosedException,
                    NatsInterruptedException,
                    NoSuchElementException

Description copied from interface: MessageIterator

Returns the next Message sent by the Nats server within the specified time limit.

Specified by:

next in interface MessageIterator

Parameters:

timeout - the maximum time to wait for a message

unit - the time unit of the timeout argument

Returns:

the next Message sent by the Nats server or null if a message didn't arrive within the specified time limit.

Throws:

NatsClosedException - thrown if the iterator closes while waiting for a message.

NatsInterruptedException

NoSuchElementException

remove

public void remove()
            throws UnsupportedOperationException

Description copied from interface: MessageIterator

Throws an UnsupportedOperationException since you obviously can't remove a message after it has been received.

Specified by:

remove in interface Iterator<Message>

Specified by:

remove in interface MessageIterator

Throws:

UnsupportedOperationException

onMessage

public void onMessage(Message message)

Specified by:

onMessage in interface MessageHandler