io.nats.client

Interface MessageConsumer

All Superinterfaces:

java.lang.AutoCloseable

All Known Subinterfaces:

FetchConsumer, IterableConsumer

public interface MessageConsumer
extends java.lang.AutoCloseable

The MessageConsumer interface is the core interface replacing a subscription for a simplified consumer.

Method Summary

Modifier and Type	Method and Description
void	close() Unsubscribe the underlying subject.
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 associated with the subscription.
boolean	isFinished() Finish indicates all messages have been received from the server.
boolean	isStopped() Stopped indicates whether consuming has been stopped.
void	stop() Use close() to unsubscribe.

Method Detail

getConsumerName

java.lang.String getConsumerName()

Gets the consumer name associated with the subscription. Some simplified consumer types do not support this, so it might be null.

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

stop

void stop()

Use close() to unsubscribe. Stop will not unsubcribe or clean up resources. The consumer will finish all pull request already in progress, but will not start any new ones.

close

void close()
    throws java.lang.Exception

Unsubscribe the underlying subject. Close will be lenient. In flight and buffered messages may still be delivered.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

isStopped

boolean isStopped()

Stopped indicates whether consuming has been stopped. Can be stopped without being finished.

Returns:

the stopped flag

isFinished

boolean isFinished()

Finish indicates all messages have been received from the server. Can be finished without being stopped.

Returns:

the finished flag