io.nats.client

Interface ConsumerContext

All Superinterfaces:

BaseConsumerContext

public interface ConsumerContext
extends BaseConsumerContext

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

Method Summary

Modifier and Type	Method and Description
ConsumerInfo	getCachedConsumerInfo() Gets information about the consumer behind this subscription.
ConsumerInfo	getConsumerInfo() Gets information about the consumer behind this subscription.
java.lang.String	getConsumerName() Gets the consumer name that was used to create the context.

Methods inherited from interface io.nats.client.BaseConsumerContext

consume, consume, consume, consume, fetch, fetchBytes, fetchMessages, iterate, iterate, next, next, next

Method Detail

getConsumerName

java.lang.String getConsumerName()

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

Returns:

the consumer name

getConsumerInfo

ConsumerInfo getConsumerInfo()
                      throws java.io.IOException,
                             JetStreamApiException

Gets information about the consumer behind this subscription.

Returns:

consumer information

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

getCachedConsumerInfo

ConsumerInfo getCachedConsumerInfo()

Gets information about the consumer behind this subscription. This returns the last read version of Consumer Info, which could technically be out of date.

Returns:

consumer information