Proton DotNet
Public Member Functions | Properties | List of all members
Apache.Qpid.Proton.Client.Implementation.ClientTracker Class Reference
Inheritance diagram for Apache.Qpid.Proton.Client.Implementation.ClientTracker:
Apache.Qpid.Proton.Client.ITracker

Public Member Functions

ITracker Disposition (IDeliveryState state, bool settle)
 Apply the delivery state and optionally settle the sent delivery with the remote More...
 
ITracker Settle ()
 Settles the sent delivery if not performing auto-settlement on the sender. More...
 
Task< ITrackerSettleAsync ()
 Settles the sent delivery if not performing auto-settlement on the sender and returns a Task that will be completed once any IO operations required by the settlement have completed. More...
 
Task< ITrackerDispositionAsync (IDeliveryState state, bool settle)
 Apply the delivery state and optionally settle the sent delivery with the remote. The method returns a Task that will be completed once any required IO operations in order to apply the disposition have been completed. More...
 
ITracker AwaitAccepted ()
 Waits for the remote to accept and settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. More...
 
ITracker AwaitAccepted (TimeSpan timeout)
 Waits for the remote to accept and settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. More...
 
ITracker AwaitSettlement ()
 Waits for the remote to settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. More...
 
ITracker AwaitSettlement (TimeSpan timeout)
 Waits for the remote to settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled. More...
 

Properties

ISender Sender [get]
 
bool Settled [get]
 
IDeliveryState State [get]
 
bool RemoteSettled [get]
 
IDeliveryState RemoteState [get]
 
Task< ITrackerSettlementTask [get]
 
- Properties inherited from Apache.Qpid.Proton.Client.ITracker
ISender Sender [get]
 Returns the parent sender instance that sent the delivery that is now being tacked. More...
 
bool Settled [get]
 Indicates if the sent delivery has already been locally settled. More...
 
IDeliveryState State [get]
 Retrieve the currently applied delivery state for the sent delivery. More...
 
bool RemoteSettled [get]
 Indicates if the sent delivery has already been remotely settled. More...
 
IDeliveryState RemoteState [get]
 Retrieve the currently applied delivery state by the remote for the sent delivery. More...
 
Task< ITrackerSettlementTask [get]
 Gets a task that will be completed once the remote has settled the sent delivery, or will indicate an error if the connection fails before the remote can settle. If the sender sent the tracked delivery settled the task returned will already be completed. More...
 

Member Function Documentation

◆ AwaitAccepted() [1/2]

ITracker Apache.Qpid.Proton.Client.Implementation.ClientTracker.AwaitAccepted ( )
inline

Waits for the remote to accept and settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled.

If the remote send back a delivery state other than accepted then this method will throw an ClientDeliveryStateException to indicate the expected outcome was not achieved.

Returns
This tracker instance

Implements Apache.Qpid.Proton.Client.ITracker.

◆ AwaitAccepted() [2/2]

ITracker Apache.Qpid.Proton.Client.Implementation.ClientTracker.AwaitAccepted ( TimeSpan  timeout)
inline

Waits for the remote to accept and settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled.

If the remote send back a delivery state other than accepted then this method will throw an ClientDeliveryStateException to indicate the expected outcome was not achieved.

Parameters
timeoutThe duration to wait for the remote to accept the delivery
Returns
This tracker instance

Implements Apache.Qpid.Proton.Client.ITracker.

◆ AwaitSettlement() [1/2]

ITracker Apache.Qpid.Proton.Client.Implementation.ClientTracker.AwaitSettlement ( )
inline

Waits for the remote to settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled.

Returns
This tracker instance

Implements Apache.Qpid.Proton.Client.ITracker.

◆ AwaitSettlement() [2/2]

ITracker Apache.Qpid.Proton.Client.Implementation.ClientTracker.AwaitSettlement ( TimeSpan  timeout)
inline

Waits for the remote to settle the sent delivery unless the delivery was already settled by the remote or the delivery was sent already settled.

Parameters
timeoutThe duration to wait for the remote to settle the delivery
Returns
This tracker instance

Implements Apache.Qpid.Proton.Client.ITracker.

◆ Disposition()

ITracker Apache.Qpid.Proton.Client.Implementation.ClientTracker.Disposition ( IDeliveryState  state,
bool  settle 
)
inline

Apply the delivery state and optionally settle the sent delivery with the remote

Parameters
stateThe delivery state to apply to the sent delivery
settleOptionally settle the delivery that was sent
Returns
This tracker instance

Implements Apache.Qpid.Proton.Client.ITracker.

◆ DispositionAsync()

Task<ITracker> Apache.Qpid.Proton.Client.Implementation.ClientTracker.DispositionAsync ( IDeliveryState  state,
bool  settle 
)
inline

Apply the delivery state and optionally settle the sent delivery with the remote. The method returns a Task that will be completed once any required IO operations in order to apply the disposition have been completed.

Parameters
stateThe delivery state to apply to the sent delivery
settleOptionally settle the delivery that was sent
Returns
This tracker instance

Implements Apache.Qpid.Proton.Client.ITracker.

◆ Settle()

ITracker Apache.Qpid.Proton.Client.Implementation.ClientTracker.Settle ( )
inline

Settles the sent delivery if not performing auto-settlement on the sender.

Returns
This tracker instance

Implements Apache.Qpid.Proton.Client.ITracker.

◆ SettleAsync()

Task<ITracker> Apache.Qpid.Proton.Client.Implementation.ClientTracker.SettleAsync ( )
inline

Settles the sent delivery if not performing auto-settlement on the sender and returns a Task that will be completed once any IO operations required by the settlement have completed.

Returns
This tracker instance

Implements Apache.Qpid.Proton.Client.ITracker.


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