Package org.apache.qpid.protonj2.client

Interface StreamReceiver

All Superinterfaces:

AutoCloseable, Link<StreamReceiver>

All Known Implementing Classes:

ClientStreamReceiver

public interface StreamReceiver
extends Link<StreamReceiver>

A receiver of large message content that is delivered in multiple Transfer frames from the remote.

Method Summary

Modifier and Type	Method	Description
StreamReceiver	addCredit(int credits)	Adds credit to the StreamReceiver link for use when the receiver has not been configured with a credit window.
Future<StreamReceiver>	drain()	Requests the remote to drain previously granted credit for this StreamReceiver link.
long	queuedDeliveries()	Returns the number of Deliveries that are currently held in the Receiver delivery queue.
StreamDelivery	receive()	Blocking receive method that waits forever for the remote to provide a StreamReceiverMessage for consumption.
StreamDelivery	receive(long timeout, TimeUnit unit)	Blocking receive method that waits the given time interval for the remote to provide a StreamReceiverMessage for consumption.
StreamDelivery	tryReceive()	Non-blocking receive method that either returns a message is one is immediately available or returns null if none is currently at hand.

Methods inherited from interface org.apache.qpid.protonj2.client.Link

address, client, close, close, closeAsync, closeAsync, connection, desiredCapabilities, detach, detach, detachAsync, detachAsync, offeredCapabilities, openFuture, properties, session, source, target

Method Detail

addCredit

StreamReceiver addCredit(int credits)
                  throws ClientException

Adds credit to the StreamReceiver link for use when the receiver has not been configured with a credit window. When credit window is configured credit replenishment is automatic and calling this method will result in an exception indicating that the operation is invalid.

If the Receiver is draining and this method is called an exception will be thrown to indicate that credit cannot be replenished until the remote has drained the existing link credit.

Parameters:

credits - The number of credits to add to the Receiver link.

Returns:

this StreamReceiver instance.

Throws:

ClientException - if an error occurs while attempting to add new StreamReceiver link credit.

drain

Future<StreamReceiver> drain()
                      throws ClientException

Requests the remote to drain previously granted credit for this StreamReceiver link.

Returns:

a Future that will be completed when the remote drains this StreamReceiver link.

Throws:

ClientException - if an error occurs while attempting to drain the link credit.

receive

StreamDelivery receive()
                throws ClientException

Blocking receive method that waits forever for the remote to provide a StreamReceiverMessage for consumption.

Receive calls will only grant credit on their own if a credit window is configured in the StreamReceiverOptions which is done by default. If the client application has configured no credit window than this method will not grant any credit when it enters the wait for new incoming messages.

Returns:

a new Delivery received from the remote.

Throws:

ClientException - if the StreamReceiver or its parent is closed when the call to receive is made.

receive

StreamDelivery receive(long timeout,
                       TimeUnit unit)
                throws ClientException

Blocking receive method that waits the given time interval for the remote to provide a StreamReceiverMessage for consumption. The amount of time this method blocks is based on the timeout value. If timeout is equal to -1 then it blocks until a Delivery is received. If timeout is equal to zero then it will not block and simply return a StreamReceiverMessage if one is available locally. If timeout value is greater than zero then it blocks up to timeout amount of time.

Receive calls will only grant credit on their own if a credit window is configured in the StreamReceiverOptions which is done by default. If the client application has not configured a credit window or granted credit manually this method will not automatically grant any credit when it enters the wait for a new incoming StreamReceiverMessage.

Parameters:

timeout - The timeout value used to control how long the receive method waits for a new Delivery.

unit - The unit of time that the given timeout represents.

Returns:

a new StreamReceiverMessage received from the remote.

Throws:

ClientException - if the StreamReceiver or its parent is closed when the call to receive is made.

tryReceive

StreamDelivery tryReceive()
                   throws ClientException

Non-blocking receive method that either returns a message is one is immediately available or returns null if none is currently at hand.

Returns:

a new StreamReceiverMessage received from the remote or null if no pending deliveries are available.

Throws:

ClientException - if the StreamReceiver or its parent is closed when the call to try to receive is made.

queuedDeliveries

long queuedDeliveries()
               throws ClientException

Returns the number of Deliveries that are currently held in the Receiver delivery queue. This number is likely to change immediately following the call as more deliveries arrive but can be used to determine if any pending Delivery work is ready.

Returns:

the number of deliveries that are currently buffered locally.

Throws:

ClientException - if an error occurs while attempting to fetch the queue count.