io.nats.client

Interface FetchConsumer

All Superinterfaces:

java.lang.AutoCloseable, MessageConsumer

public interface FetchConsumer
extends MessageConsumer

A fetch consumer gets messages by calling nextMessage. nextMessage returns null when there are no more messages

Method Summary

Modifier and Type	Method and Description
Message	nextMessage() 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()
             throws java.lang.InterruptedException,
                    JetStreamStatusCheckedException

Read the next message. Return null if the fetch has been fulfilled either because max messages or bytes max bytes have been reached, or because the fetch was not fulfilled in the timeout set by the fetch options.

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.