A single AMQP receiver instance. More...

Inheritance diagram for Apache.Qpid.Proton.Client.IReceiver:

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.

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.

IDelivery	Receive ()
	Blocking receive method that waits forever for the remote to provide a delivery for consumption.

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.

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.

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.

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.

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.

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.

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.

Public Member Functions inherited from Apache.Qpid.Proton.Client.ILink< IReceiver >
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
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< IReceiver >
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. If the link is configured as an anonymous link then this method returns null. If the link was created with the dynamic link methods then the method will return the dynamically created address once the remote has attached its end of the link link. Due to the need to await the remote peer to populate the dynamic address this method will block until the open of the link link has completed. If neither of the above is true then the address returned is the address passed to the original address value passed to one of the open link methods.

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.

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.

The documentation for this interface was generated from the following file:

src/Proton.Client/Client/IReceiver.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddCredit()

◆ AddCreditAsync()

◆ Drain()

◆ DrainAsync()

◆ Receive() [1/2]

◆ Receive() [2/2]

◆ ReceiveAsync() [1/2]

◆ ReceiveAsync() [2/2]

◆ TryReceive()

◆ TryReceiveAsync()