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() Receive the next message that becomes available for this Subscription, waiting if necessary until a Message becomes available.
Message	nextMessage(long timeout) Receive the next Message that arrives for this Subscription within the specified timeout interval.
Message	nextMessage(long timeout, TimeUnit unit) Receive the next Message that arrives for this Subscription within the specified timeout interval.

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

Receive 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.

Throws:

IOException - if an I/O error prevents message delivery

IllegalStateException - if the Subscription has been removed (unsubscribed)

IOException - if the Subscription's has been unsubscribed due to reaching its autoUnsubscribe limit.

See Also:

Subscription.autoUnsubscribe(int)

nextMessage

Message nextMessage(long timeout)
             throws IOException,
                    TimeoutException

Receive the next Message that arrives for this Subscription within the specified timeout interval.

Parameters:

timeout - the timeout value (in milliseconds)

Returns:

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

Throws:

IOException - if an I/O error prevents message delivery

TimeoutException - if the timeout expires before a message becomes available

IllegalStateException - if the Subscription has been removed (unsubscribed)

IOException - if the Subscription's has been unsubscribed due to reaching its autoUnsubscribe limit.

See Also:

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

nextMessage

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

Receive the next Message that arrives for this Subscription within the specified timeout interval.

Parameters:

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

unit - the timeout value

Returns:

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

Throws:

IOException - if an I/O error prevents message delivery

TimeoutException - if the timeout expires before a message becomes available

IllegalStateException - if the Subscription has been removed (unsubscribed)

IOException - if the Subscription's has been unsubscribed due to reaching its autoUnsubscribe limit.

See Also:

Subscription.autoUnsubscribe(int)