io.nats.client

Interface SyncSubscription

All Superinterfaces:

AutoCloseable, Subscription

public interface SyncSubscription
extends Subscription

A client uses an SyncSubscription object to receive messages from a subject synchronously.

Method Summary

Modifier and Type	Method and Description
Message	nextMessage() Receives the next Message that becomes available for this Subscription, waiting if necessary until a Message becomes available.
Message	nextMessage(long timeout) Receives the next Message that arrives for this Subscription, waiting up to the specified wait time if necessary for a Message to become available.
Message	nextMessage(long timeout, TimeUnit unit) Receives the next Message that arrives for this Subscription, waiting up to the specified wait time if necessary for a Message to become available.

Methods inherited from interface io.nats.client.Subscription

autoUnsubscribe, clearMaxPending, close, getDelivered, getDropped, getPendingBytes, getPendingBytesLimit, getPendingBytesMax, getPendingMsgs, getPendingMsgsLimit, getPendingMsgsMax, getQueue, getQueuedMessageCount, getSubject, isValid, setPendingLimits, unsubscribe

Method Detail

nextMessage

Message nextMessage()
             throws IOException,
                    InterruptedException

Receives the next Message that becomes available for this Subscription, waiting if necessary until a Message becomes available.

Returns:

the next message produced for this subscription, or return null if the Connection is closed concurrently.

This call blocks indefinitely until a message is produced or until this Subscription is closed.

Throws:

InterruptedException - if interrupted while waiting, e.g. because the Subscription was closed in another thread

IOException - if the Subscription has been unsubscribed due to reaching its autoUnsubscribe limit, or if the Subscription has been marked a slow consumer.

IllegalStateException - if the Subscription is not valid, e.g. it was closed prior to this invocation

See Also:

Subscription.autoUnsubscribe(int)

nextMessage

Message nextMessage(long timeout)
             throws IOException,
                    TimeoutException,
                    InterruptedException

Receives the next Message that arrives for this Subscription, waiting up to the specified wait time if necessary for a Message to become available.

Parameters:

timeout - how long to wait before giving up, in milliseconds

Returns:

the next message produced for this subscription, or null if timeout expires before a message is available

Throws:

TimeoutException - if the timeout expires before a Message becomes available

InterruptedException - if interrupted while waiting, e.g. because the Subscription was closed in another thread

IOException - if the Subscription has been unsubscribed due to reaching its autoUnsubscribe limit, or if the Subscription has been marked a slow consumer.

IllegalStateException - if the Subscription is not valid, e.g. it was closed prior to this invocation

See Also:

nextMessage(long, TimeUnit), Subscription.autoUnsubscribe(int)

nextMessage

Message nextMessage(long timeout,
                    TimeUnit unit)
             throws IOException,
                    TimeoutException,
                    InterruptedException

Receives the next Message that arrives for this Subscription, waiting up to the specified wait time if necessary for a Message to become available.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the next message produced for this subscription, or return null if timeout expires

Throws:

TimeoutException - if the timeout expires before a Message becomes available

InterruptedException - if interrupted while waiting, e.g. because the Subscription was closed in another thread

IOException - if the Subscription has been unsubscribed due to reaching its autoUnsubscribe limit, or if the Subscription has been marked a slow consumer.

IllegalStateException - if the Subscription is not valid, e.g. it was closed prior to this invocation

See Also:

Subscription.autoUnsubscribe(int)