io.nats.client

Interface IterableConsumer

All Superinterfaces:

java.lang.AutoCloseable, MessageConsumer

public interface IterableConsumer
extends MessageConsumer

Method Summary

Modifier and Type	Method and Description
Message	nextMessage(java.time.Duration timeout) Read the next message.
Message	nextMessage(long timeoutMillis) Read the next message.

Methods inherited from interface io.nats.client.MessageConsumer

getCachedConsumerInfo, getConsumerInfo, getConsumerName, isFinished, isStopped, stop

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

nextMessage

Message nextMessage(java.time.Duration timeout)
             throws java.lang.InterruptedException,
                    JetStreamStatusCheckedException

Read the next message. Return null if the calls times out. Use a timeout of 0 to wait indefinitely. This could still be interrupted if the subscription is unsubscribed or the client connection is closed.

Parameters:

timeout - the maximum time to wait

Returns:

the next message for this subscriber or null if there is a timeout

Throws:

java.lang.InterruptedException - if one is thrown, in order to propagate it up

JetStreamStatusCheckedException - an exception representing a status that requires attention, such as the consumer was deleted on the server in the middle of use.

nextMessage

Message nextMessage(long timeoutMillis)
             throws java.lang.InterruptedException,
                    JetStreamStatusCheckedException

Read the next message. Return null if the calls times out. Use a timeout of 0 to wait indefinitely. This could still be interrupted if the subscription is unsubscribed or the client connection is closed.

Parameters:

timeoutMillis - the maximum time to wait

Returns:

the next message for this subscriber or null if there is a timeout

Throws:

java.lang.InterruptedException - if one is thrown, in order to propagate it up

JetStreamStatusCheckedException - an exception representing a status that requires attention, such as the consumer was deleted on the server in the middle of use.