Module org.apache.qpid.protonj2.client

Package org.apache.qpid.protonj2.client.impl

Class ClientStreamReceiver

java.lang.Object

org.apache.qpid.protonj2.client.impl.ClientLinkType<StreamReceiver,org.apache.qpid.protonj2.engine.Receiver>

org.apache.qpid.protonj2.client.impl.ClientReceiverLinkType<StreamReceiver>

org.apache.qpid.protonj2.client.impl.ClientStreamReceiver

All Implemented Interfaces:

AutoCloseable, Link<StreamReceiver>, StreamReceiver

public final class ClientStreamReceiver
extends ClientReceiverLinkType<StreamReceiver>
implements StreamReceiver

Client implementation of a StreamReceiver.

Field Summary

Fields inherited from class org.apache.qpid.protonj2.client.impl.ClientReceiverLinkType

protonReceiver

Fields inherited from class org.apache.qpid.protonj2.client.impl.ClientLinkType

closed, CLOSED_UPDATER, closeFuture, executor, failureCause, linkId, linkRemotelyClosedHandler, openFuture, remoteSource, remoteTarget, session

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.
protected void	handleDeliveryRead(org.apache.qpid.protonj2.engine.IncomingDelivery delivery)
protected void	linkSpecificCleanupHandler(ClientException failureCause)
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.
protected void	recreateLinkForReconnect()
protected void	replenishCreditIfNeeded()
protected StreamReceiver	self()
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 class org.apache.qpid.protonj2.client.impl.ClientReceiverLinkType

handleDeliveryAborted, handleDeliveryStateRemotelyUpdated, handleReceiverCreditUpdated, linkSpecificLocalCloseHandler, linkSpecificLocalOpenHandler, linkSpecificRemoteCloseHandler, linkSpecificRemoteOpenHandler, protonLink

Methods inherited from class org.apache.qpid.protonj2.client.impl.ClientLinkType

address, checkClosedOrFailed, client, close, close, closeAsync, closeAsync, connection, desiredCapabilities, detach, detach, detachAsync, detachAsync, handleEngineShutdown, handleLocalCloseOrDetach, handleLocalOpen, handleParentEndpointClosed, handleRemoteCloseOrDetach, handleRemoteOpen, immediateLinkShutdown, notClosedOrFailed, notClosedOrFailed, offeredCapabilities, openFuture, properties, session, source, target, waitForOpenToComplete

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 Details

receive

public StreamDelivery receive()
                       throws ClientException

Description copied from interface: StreamReceiver

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.

Specified by:

receive in interface StreamReceiver

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

public StreamDelivery receive(long timeout,
 TimeUnit unit)
                       throws ClientException

Description copied from interface: StreamReceiver

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 the timeout is negative then it blocks until a Delivery is received. If the timeout is equal to zero then it will not block and simply return a StreamReceiverMessage if one is available locally. If the 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.

Specified by:

receive in interface StreamReceiver

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

public StreamDelivery tryReceive()
                          throws ClientException

Description copied from interface: StreamReceiver

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

Specified by:

tryReceive in interface StreamReceiver

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.

addCredit

public StreamReceiver addCredit(int credits)
                         throws ClientException

Description copied from interface: StreamReceiver

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.

Specified by:

addCredit in interface StreamReceiver

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

public Future<StreamReceiver> drain()
                             throws ClientException

Description copied from interface: StreamReceiver

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

Specified by:

drain in interface StreamReceiver

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.

queuedDeliveries

public long queuedDeliveries()
                      throws ClientException

Description copied from interface: StreamReceiver

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.

Specified by:

queuedDeliveries in interface StreamReceiver

Returns:

the number of deliveries that are currently buffered locally.

Throws:

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

self

protected StreamReceiver self()

Specified by:

self in class ClientLinkType<StreamReceiver,org.apache.qpid.protonj2.engine.Receiver>

handleDeliveryRead

protected void handleDeliveryRead(org.apache.qpid.protonj2.engine.IncomingDelivery delivery)

Specified by:

handleDeliveryRead in class ClientReceiverLinkType<StreamReceiver>

replenishCreditIfNeeded

protected void replenishCreditIfNeeded()

Specified by:

replenishCreditIfNeeded in class ClientReceiverLinkType<StreamReceiver>

linkSpecificCleanupHandler

protected void linkSpecificCleanupHandler(ClientException failureCause)

Overrides:

linkSpecificCleanupHandler in class ClientReceiverLinkType<StreamReceiver>

recreateLinkForReconnect

protected void recreateLinkForReconnect()

Specified by:

recreateLinkForReconnect in class ClientLinkType<StreamReceiver,org.apache.qpid.protonj2.engine.Receiver>