A single AMQP receiver instance. More...
Public Member Functions | |
| IReceiver | 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. More... | |
| Task< IReceiver > | 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. More... | |
| IDelivery | Receive () |
| Blocking receive method that waits forever for the remote to provide a delivery for consumption. More... | |
| IDelivery | 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. More... | |
| IDelivery | TryReceive () |
| A mostly Non-blocking receive method that either returns a delivery if one is immediately available or returns null if none is currently at hand. It is possible that this method will block for short time intervals while acquiring and releasing internal locks. More... | |
| Task< IDelivery > | 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. More... | |
| Task< IDelivery > | 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. More... | |
| Task< IDelivery > | 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. More... | |
| IReceiver | 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. More... | |
| Task< IReceiver > | 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. More... | |
Properties | |
| int | QueuedDeliveries [get] |
| A count of the currently queued deliveries which can be read immediately without blocking a call to receive. More... | |
Detailed Description
A single AMQP receiver instance.
Member Function Documentation
◆ AddCredit()
| IReceiver Apache.Qpid.Proton.Client.IReceiver.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.
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
-
credit The amount of new credit to add to the existing credit if any
- Returns
- This receiver instance.
◆ AddCreditAsync()
| Task<IReceiver> Apache.Qpid.Proton.Client.IReceiver.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.
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
-
credit The amount of new credit to add to the existing credit if any
- Returns
- This receiver instance.
◆ Drain()
| IReceiver Apache.Qpid.Proton.Client.IReceiver.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.
- Returns
- This receiver instance once the remote reports drain completed
◆ DrainAsync()
| Task<IReceiver> Apache.Qpid.Proton.Client.IReceiver.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.
- Returns
- A Task that will be completed when the remote reports drained.
◆ Receive() [1/2]
| IDelivery Apache.Qpid.Proton.Client.IReceiver.Receive | ( | ) |
Blocking receive method that waits forever for the remote to provide a delivery for consumption.
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
Implemented in Apache.Qpid.Proton.Client.Implementation.ClientReceiver.
◆ Receive() [2/2]
| IDelivery Apache.Qpid.Proton.Client.IReceiver.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.
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
Implemented in Apache.Qpid.Proton.Client.Implementation.ClientReceiver.
◆ ReceiveAsync() [1/2]
| Task<IDelivery> Apache.Qpid.Proton.Client.IReceiver.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.
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
Implemented in Apache.Qpid.Proton.Client.Implementation.ClientReceiver.
◆ ReceiveAsync() [2/2]
| Task<IDelivery> Apache.Qpid.Proton.Client.IReceiver.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.
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
Implemented in Apache.Qpid.Proton.Client.Implementation.ClientReceiver.
◆ TryReceive()
| IDelivery Apache.Qpid.Proton.Client.IReceiver.TryReceive | ( | ) |
A mostly Non-blocking receive method that either returns a delivery if one is immediately available or returns null if none is currently at hand. It is possible that this method will block for short time intervals while acquiring and releasing internal locks.
- Returns
- A delivery if one is immediately available or null if not
Implemented in Apache.Qpid.Proton.Client.Implementation.ClientReceiver.
◆ TryReceiveAsync()
| Task<IDelivery> Apache.Qpid.Proton.Client.IReceiver.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.
- Returns
- A Task that completes with a delivery if one is immediately available or null if not
Implemented in Apache.Qpid.Proton.Client.Implementation.ClientReceiver.
Property Documentation
◆ QueuedDeliveries
|
get |
A count of the currently queued deliveries which can be read immediately without blocking a call to receive.
The documentation for this interface was generated from the following file:
- src/Proton.Client/Client/IReceiver.cs
