io.nats.client

Interface JetStreamReader

public interface JetStreamReader

This interface provides a simple iterative access to a pull consumer.

Note: This interface is superseded by ConsumerContext. For examples for recommended usage see JetStream.

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.
void	stop() Stop getting more messages from the server.

Method Detail

nextMessage

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

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

java.lang.IllegalStateException - if the subscription belongs to a dispatcher, or is not active

nextMessage

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

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

java.lang.IllegalStateException - if the subscription belongs to a dispatcher, or is not active

stop

void stop()

Stop getting more messages from the server. Some messages may have already arrived and are in the buffer, so continue to call nextMessage until a null is returned.