Implements the streaming message receiver which allows for reading of large messages in smaller chunks. The API allows for multiple calls to receiver but any call that happens after a large message receives begins will be blocked until the previous large message is fully read and the next arrives. More...
Public Member Functions | |
| IStreamDelivery | Receive () |
| Blocking receive method that waits forever for the remote to provide some or all of a delivery for consumption. This method returns a streamed delivery instance that allows for consumption or the incoming delivery as it arrives. | |
| IStreamDelivery | TryReceive () |
| Non-blocking receive method that either returns a delivery is one is immediately available or returns null if none is currently at hand. This method returns a streamed delivery instance that allows for consumption or the incoming delivery as it arrives. | |
| IStreamDelivery | Receive (TimeSpan timeout) |
| Blocking receive method that waits for the specified time period for the remote to provide a delivery for consumption before returning null if none was received. This method returns a streamed delivery instance that allows for consumption or the incoming delivery as it arrives. | |
| Task< IStreamDelivery > | ReceiveAsync () |
| Asynchronous receive method that waits forever for the remote to provide a delivery for consumption and when a delivery is available the returned Task will be completed. The returned task completes with a streamed delivery instance that allows for consumption or the incoming delivery as it arrives. | |
| Task< IStreamDelivery > | TryReceiveAsync () |
| Asynchronous receive method that returns a Task which will be completed either with a currently available delivery or with null to indicate there are no queued deliveries. The returned task completes with a streamed delivery instance that allows for consumption or the incoming delivery as it arrives. | |
| Task< IStreamDelivery > | ReceiveAsync (TimeSpan timeout) |
| Asynchronous receive method that returns a Task that will be completed after the specified time period if the remote to provides a delivery for consumption before completing with null if none was received. The returned task completes with a streamed delivery instance that allows for consumption or the incoming delivery as it arrives. | |
 Public Member Functions inherited from Apache.Qpid.Proton.Client.Implementation.ClientReceiverLinkType< IStreamReceiver > | |
| LinkType | AddCredit (uint credit) |
| Task< LinkType > | AddCreditAsync (uint credit) |
| LinkType | Drain () |
| Task< LinkType > | DrainAsync () |
| Public Member Functions inherited from Apache.Qpid.Proton.Client.IStreamReceiver | |
| IStreamReceiver | AddCredit (uint credit) |
| Adds credit to the Receiver link for use when there receiver has not been configured with 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. | |
| Task< IStreamReceiver > | AddCreditAsync (uint credit) |
| Asynchronously Adds credit to the Receiver link for use when there receiver has not been configured with 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. | |
| IStreamReceiver | Drain () |
| Requests the remote to drain previously granted credit for this receiver link. The remote will either send all available deliveries up to the currently granted link credit or will report it has none to send an link credit will be set to zero. This method will block until the remote answers the drain request or the configured drain timeout expires. | |
| Task< IStreamReceiver > | DrainAsync () |
| Requests the remote to drain previously granted credit for this receiver link. The remote will either send all available deliveries up to the currently granted link credit or will report it has none to send an link credit will be set to zero. The caller can wait on the returned task which will be signalled either after the remote reports drained or once the configured drain timeout is reached. | |
| Public Member Functions inherited from Apache.Qpid.Proton.Client.ILink< IStreamReceiver > | |
| void | Close (IErrorCondition error=null) |
| Initiates a close of the link and awaits a response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the method returns after cleaning up the link resources. | |
| void | Detach (IErrorCondition error=null) |
| Initiates a detach of the link and awaits a response from the remote that indicates completion of the detach operation. If the response from the remote exceeds the configure close timeout the method returns after cleaning up the link resources. | |
| Task< Role > | CloseAsync (IErrorCondition error=null) |
| Initiates a close of the link and a Task that allows the caller to await or poll for the response from the remote that indicates completion of the close operation. If the response from the remote exceeds the configure close timeout the sender will be cleaned up and the Task signalled indicating completion. | |
| Task< Role > | DetachAsync (IErrorCondition error=null) |
| Initiates a detach of the link and a Task that allows the caller to await or poll for the response from the remote that indicates completion of the detach operation. If the response from the remote exceeds the configure close timeout the sender will be cleaned up and the Task signalled indicating completion. | |
Properties | |
| override IStreamReceiver | Self [get] |
| Properties inherited from Apache.Qpid.Proton.Client.Implementation.ClientReceiverLinkType< IStreamReceiver > | |
| virtual int | QueuedDeliveries [get] |
| LinkType | Self [get] |
| Properties inherited from Apache.Qpid.Proton.Client.IStreamReceiver | |
| int | QueuedDeliveries [get] |
| A count of the currently queued deliveries which can be read immediately without blocking a call to receive. | |
| Properties inherited from Apache.Qpid.Proton.Client.ILink< IStreamReceiver > | |
| IClient | Client [get] |
| Returns the parent client instance that hosts this link. | |
| IConnection | Connection [get] |
| Returns the parent connection instance that hosts this link. | |
| ISession | Session [get] |
| Returns the parent session instance that created this link. | |
| string | Address [get] |
Returns the address that the link instance will send message objects to. The value returned from this method is controlled by the configuration that was used to create the link.
| |
| ISource | Source [get] |
| Returns an immutable view of the remote Source object assigned to this link link. If the attach has not completed yet this method will block to await the attach response which carries the remote source. | |
| ITarget | Target [get] |
| Returns an immutable view of the remote Target object assigned to this link link. If the attach has not completed yet this method will block to await the attach response which carries the remote target. | |
| IReadOnlyDictionary< string, object > | Properties [get] |
| Returns the properties that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote properties. If the remote provides no properties this method will return null. | |
| IReadOnlyCollection< string > | OfferedCapabilities [get] |
| Returns the offered capabilities that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote offered capabilities. If the remote provides no offered capabilities this method will return null. | |
| IReadOnlyCollection< string > | DesiredCapabilities [get] |
| Returns the desired capabilities that the remote provided upon successfully opening the link. If the open has not completed yet this method will block to await the open response which carries the remote desired capabilities. If the remote provides no desired capabilities this method will return null. | |
| Task< Role > | OpenTask [get] |
| When a link is created and returned to the client application it may not be remotely opened yet and if the client needs to wait for completion of the open before proceeding the open task can be fetched and waited upon. | |
Additional Inherited Members | |
| Protected Member Functions inherited from Apache.Qpid.Proton.Client.Implementation.ClientReceiverLinkType< IStreamReceiver > | |
| void | AsyncApplyDisposition (IIncomingDelivery delivery, Types.Transport.IDeliveryState state, bool settle) |
| void | AsyncReplenishCreditIfNeeded () |
| virtual void | ReplenishCreditIfNeeded () |
| Protected Attributes inherited from Apache.Qpid.Proton.Client.Implementation.ClientReceiverLinkType< IStreamReceiver > | |
| TaskCompletionSource< LinkType > | drainingFuture |
| readonly ReceiverOptions | options |
| readonly string | receiverId |
Detailed Description
Implements the streaming message receiver which allows for reading of large messages in smaller chunks. The API allows for multiple calls to receiver but any call that happens after a large message receives begins will be blocked until the previous large message is fully read and the next arrives.
Member Function Documentation
◆ Receive() [1/2]
|
inline |
Blocking receive method that waits forever for the remote to provide some or all of a delivery for consumption. This method returns a streamed delivery instance that allows for consumption or the incoming delivery as it arrives.
Receive calls will only grant credit on their own if a credit window is configured in the options which by default will have been configured. If the client application has not configured a credit window then this method won't grant or extend the credit window but will wait for a delivery regardless. The application needs to arrange for credit to be granted in that case.
- Returns
- The next available delivery
Implements Apache.Qpid.Proton.Client.IStreamReceiver.
◆ Receive() [2/2]
|
inline |
Blocking receive method that waits for the specified time period for the remote to provide a delivery for consumption before returning null if none was received. This method returns a streamed delivery instance that allows for consumption or the incoming delivery as it arrives.
Receive calls will only grant credit on their own if a credit window is configured in the options which by default will have been configured. If the client application has not configured a credit window then this method won't grant or extend the credit window but will wait for a delivery regardless. The application needs to arrange for credit to be granted in that case.
Implements Apache.Qpid.Proton.Client.IStreamReceiver.
◆ ReceiveAsync() [1/2]
|
inline |
Asynchronous receive method that waits forever for the remote to provide a delivery for consumption and when a delivery is available the returned Task will be completed. The returned task completes with a streamed delivery instance that allows for consumption or the incoming delivery as it arrives.
Receive calls will only grant credit on their own if a credit window is configured in the options which by default will have been configured. If the client application has not configured a credit window then this method won't grant or extend the credit window but will wait for a delivery regardless. The application needs to arrange for credit to be granted in that case.
- Returns
- The next available delivery
Implements Apache.Qpid.Proton.Client.IStreamReceiver.
◆ ReceiveAsync() [2/2]
|
inline |
Asynchronous receive method that returns a Task that will be completed after the specified time period if the remote to provides a delivery for consumption before completing with null if none was received. The returned task completes with a streamed delivery instance that allows for consumption or the incoming delivery as it arrives.
Receive calls will only grant credit on their own if a credit window is configured in the options which by default will have been configured. If the client application has not configured a credit window then this method won't grant or extend the credit window but will wait for a delivery regardless. The application needs to arrange for credit to be granted in that case.
- Returns
- The next available delivery or null if the time span elapses
Implements Apache.Qpid.Proton.Client.IStreamReceiver.
◆ TryReceive()
|
inline |
Non-blocking receive method that either returns a delivery is one is immediately available or returns null if none is currently at hand. This method returns a streamed delivery instance that allows for consumption or the incoming delivery as it arrives.
- Returns
- A delivery if one is immediately available or null if not
Implements Apache.Qpid.Proton.Client.IStreamReceiver.
◆ TryReceiveAsync()
|
inline |
Asynchronous receive method that returns a Task which will be completed either with a currently available delivery or with null to indicate there are no queued deliveries. The returned task completes with a streamed delivery instance that allows for consumption or the incoming delivery as it arrives.
- Returns
- A Task that completes with a delivery if one is immediately available or null if not
Implements Apache.Qpid.Proton.Client.IStreamReceiver.
The documentation for this class was generated from the following file:
- src/Proton.Client/Client/Implementation/ClientStreamReceiver.cs
