io.nats.client

Interface BaseConsumerContext

All Known Subinterfaces:

ConsumerContext, OrderedConsumerContext

public interface BaseConsumerContext

The Consumer Context provides a convenient interface around a defined JetStream Consumer

Note: ConsumerContext requires a pull consumer.

Method Summary

Modifier and Type	Method and Description
MessageConsumer	consume(ConsumeOptions consumeOptions, Dispatcher dispatcher, MessageHandler handler) Start a long-running MessageConsumer with custom ConsumeOptions.
MessageConsumer	consume(ConsumeOptions consumeOptions, MessageHandler handler) Start a long-running MessageConsumer with custom ConsumeOptions.
MessageConsumer	consume(Dispatcher dispatcher, MessageHandler handler) Start a long-running MessageConsumer with default ConsumeOptions.
MessageConsumer	consume(MessageHandler handler) Start a long-running MessageConsumer with default ConsumeOptions.
FetchConsumer	fetch(FetchConsumeOptions fetchConsumeOptions) Start a one use Fetch Consumer with complete custom consume options.
FetchConsumer	fetchBytes(int maxBytes) Start a one use Fetch Consumer using all defaults other than the number of bytes.
FetchConsumer	fetchMessages(int maxMessages) Start a one use Fetch Consumer using all defaults other than the number of messages.
java.lang.String	getConsumerName() Gets the consumer name that was used to create the context.
IterableConsumer	iterate() Start a long-running IterableConsumer with default ConsumeOptions.
IterableConsumer	iterate(ConsumeOptions consumeOptions) Start a long-running IterableConsumer with custom ConsumeOptions.
Message	next() Read the next message with max wait set to ms
Message	next(java.time.Duration maxWait) Read the next message with provided max wait
Message	next(long maxWaitMillis) Read the next message with provided max wait

Method Detail

getConsumerName

java.lang.String getConsumerName()

Gets the consumer name that was used to create the context.

Returns:

the consumer name

next

Message next()
      throws java.io.IOException,
             java.lang.InterruptedException,
             JetStreamStatusCheckedException,
             JetStreamApiException

Read the next message with max wait set to ms

Returns:

the next message or null if the max wait expires

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

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.

JetStreamApiException - the request had an error related to the data

next

Message next(java.time.Duration maxWait)
      throws java.io.IOException,
             java.lang.InterruptedException,
             JetStreamStatusCheckedException,
             JetStreamApiException

Read the next message with provided max wait

Parameters:

maxWait - duration of max wait. Cannot be less than milliseconds.

Returns:

the next message or null if the max wait expires

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

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.

JetStreamApiException - the request had an error related to the data

next

Message next(long maxWaitMillis)
      throws java.io.IOException,
             java.lang.InterruptedException,
             JetStreamStatusCheckedException,
             JetStreamApiException

Read the next message with provided max wait

Parameters:

maxWaitMillis - the max wait value in milliseconds. Cannot be less than milliseconds.

Returns:

the next message or null if the max wait expires

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

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.

JetStreamApiException - the request had an error related to the data

fetchMessages

FetchConsumer fetchMessages(int maxMessages)
                     throws java.io.IOException,
                            JetStreamApiException

Start a one use Fetch Consumer using all defaults other than the number of messages. See FetchConsumer

Parameters:

maxMessages - the maximum number of message to consume

Returns:

the FetchConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

fetchBytes

FetchConsumer fetchBytes(int maxBytes)
                  throws java.io.IOException,
                         JetStreamApiException

Start a one use Fetch Consumer using all defaults other than the number of bytes. See FetchConsumer

Parameters:

maxBytes - the maximum number of bytes to consume

Returns:

the FetchConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

fetch

FetchConsumer fetch(FetchConsumeOptions fetchConsumeOptions)
             throws java.io.IOException,
                    JetStreamApiException

Start a one use Fetch Consumer with complete custom consume options. See FetchConsumer

Parameters:

fetchConsumeOptions - the custom fetch consume options. See FetchConsumeOptions

Returns:

the FetchConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

iterate

IterableConsumer iterate()
                  throws java.io.IOException,
                         JetStreamApiException

Start a long-running IterableConsumer with default ConsumeOptions. See IterableConsumer and ConsumeOptions IterableConsumer require the developer call nextMessage.

Returns:

the IterableConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

iterate

IterableConsumer iterate(ConsumeOptions consumeOptions)
                  throws java.io.IOException,
                         JetStreamApiException

Start a long-running IterableConsumer with custom ConsumeOptions. See IterableConsumer and ConsumeOptions IterableConsumer requires the developer call nextMessage.

Parameters:

consumeOptions - the custom consume options

Returns:

the IterableConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

consume

MessageConsumer consume(MessageHandler handler)
                 throws java.io.IOException,
                        JetStreamApiException

Start a long-running MessageConsumer with default ConsumeOptions. See MessageConsumer and ConsumeOptions

Parameters:

handler - the MessageHandler used for receiving messages.

Returns:

the MessageConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

consume

MessageConsumer consume(Dispatcher dispatcher,
                        MessageHandler handler)
                 throws java.io.IOException,
                        JetStreamApiException

Start a long-running MessageConsumer with default ConsumeOptions. See MessageConsumer and ConsumeOptions

Parameters:

dispatcher - The dispatcher to handle this subscription

handler - the MessageHandler used for receiving messages.

Returns:

the MessageConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

consume

MessageConsumer consume(ConsumeOptions consumeOptions,
                        MessageHandler handler)
                 throws java.io.IOException,
                        JetStreamApiException

Start a long-running MessageConsumer with custom ConsumeOptions. See MessageConsumer and ConsumeOptions

Parameters:

consumeOptions - the custom consume options

handler - the MessageHandler used for receiving messages.

Returns:

the MessageConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data

consume

MessageConsumer consume(ConsumeOptions consumeOptions,
                        Dispatcher dispatcher,
                        MessageHandler handler)
                 throws java.io.IOException,
                        JetStreamApiException

Start a long-running MessageConsumer with custom ConsumeOptions. See MessageConsumer and ConsumeOptions

Parameters:

consumeOptions - the custom consume options

dispatcher - The dispatcher to handle this subscription

handler - the MessageHandler used for receiving messages.

Returns:

the MessageConsumer instance

Throws:

java.io.IOException - covers various communication issues with the NATS server such as timeout or interruption

JetStreamApiException - the request had an error related to the data