nats.client

Interface MessageIterator

All Superinterfaces:

AutoCloseable, Iterator<Message>

All Known Implementing Classes:

BlockingQueueMessageIterator

public interface MessageIterator
extends Iterator<Message>, AutoCloseable

Provides an Iterator for fetching Nats subscription messages in a blocking manner.

Author:

Mike Heath

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	remove() Throws an UnsupportedOperationException since you obviously can't remove a message after it has been received.

Methods inherited from interface java.util.Iterator

forEachRemaining

Method Detail

hasNext

boolean hasNext()

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>

Returns:

true unless this iterator has been closed.

next

Message next()
      throws NatsClosedException

Returns the next Message sent by the Nats server.

Specified by:

next in interface Iterator<Message>

Returns:

the next Message sent by the Nats server.

Throws:

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

next

Message next(long timeout,
             TimeUnit unit)
      throws NatsClosedException

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

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.

remove

void remove()

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

Specified by:

remove in interface Iterator<Message>

close

void close()

Closes this subscription iterator.

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

Specified by:

close in interface AutoCloseable