Proton DotNet
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
Apache.Qpid.Proton.Client.Implementation.ClientRejected Class Referencesealed

Client version of the proton Rejected delivery state. More...

Inheritance diagram for Apache.Qpid.Proton.Client.Implementation.ClientRejected:
Apache.Qpid.Proton.Client.Implementation.ClientDeliveryState Apache.Qpid.Proton.Client.IRejected Apache.Qpid.Proton.Client.IDeliveryState Apache.Qpid.Proton.Client.IDeliveryState

Public Member Functions

 ClientRejected (string condition, string description)
 Create a new Rejected client delivery state with the provided information.
 
 ClientRejected (string condition, string description, IDictionary< string, object > info)
 Create a new Rejected client delivery state with the provided information.
 

Properties

override DeliveryStateType Type [get]
 Returns an enumeration value which indicates what type of DeliveryState this instance represents.
 
override bool IsRejected [get]
 Quick access to determine if the state value indicates the delivery was rejected.
 
override Types.Transport.IDeliveryState ProtonDeliveryState [get]
 
string Condition [get]
 Quick access to any condition value provided in the error condition sent with the rejected outcome.
 
string Description [get]
 Quick access to any description value provided in the error condition sent with the rejected outcome.
 
IReadOnlyDictionary< string, object > Info [get]
 Returns any information entries that were applied to this rejected outcome in the error condition.
 
- Properties inherited from Apache.Qpid.Proton.Client.Implementation.ClientDeliveryState
virtual bool IsAccepted [get]
 Quick access to determine if the state value indicates the delivery was accepted.
 
virtual bool IsRejected [get]
 Quick access to determine if the state value indicates the delivery was rejected.
 
virtual bool IsReleased [get]
 Quick access to determine if the state value indicates the delivery was released.
 
virtual bool IsModified [get]
 Quick access to determine if the state value indicates the delivery was modified.
 
virtual bool IsTransactional [get]
 Quick access to determine if the state value indicates the delivery was transactional.
 
DeliveryStateType Type [get]
 Returns an enumeration value which indicates what type of DeliveryState this instance represents.
 
Types.Transport.IDeliveryState ProtonDeliveryState [get]
 
- Properties inherited from Apache.Qpid.Proton.Client.IDeliveryState
- Properties inherited from Apache.Qpid.Proton.Client.IRejected

Additional Inherited Members

- Static Public Member Functions inherited from Apache.Qpid.Proton.Client.IDeliveryState
static IDeliveryState Accepted ()
 Returns an instance of a delivery state that accepts a delivery.
 
static IDeliveryState Released ()
 Returns an instance of a delivery state that releases a delivery.
 
static IDeliveryState Rejected (string condition, string description=null, IDictionary< string, object > info=null)
 Returns an instance of a delivery state that rejects a delivery.
 
static IDeliveryState Modified (bool deliveryFailed, bool undeliverableHere=false, IDictionary< string, object > annotations=null)
 Returns an instance of a delivery state that modifies a delivery.
 

Detailed Description

Client version of the proton Rejected delivery state.

Constructor & Destructor Documentation

◆ ClientRejected() [1/2]

Apache.Qpid.Proton.Client.Implementation.ClientRejected.ClientRejected ( string  condition,
string  description 
)
inline

Create a new Rejected client delivery state with the provided information.

Parameters
conditionThe condition value to convey to the remote
descriptionThe description value to convey to the remote

◆ ClientRejected() [2/2]

Apache.Qpid.Proton.Client.Implementation.ClientRejected.ClientRejected ( string  condition,
string  description,
IDictionary< string, object >  info 
)
inline

Create a new Rejected client delivery state with the provided information.

Parameters
conditionThe condition value to convey to the remote
descriptionThe description value to convey to the remote
infoThe information map value to convey to the remote

Property Documentation

◆ Condition

string Apache.Qpid.Proton.Client.Implementation.ClientRejected.Condition
get

Quick access to any condition value provided in the error condition sent with the rejected outcome.

Implements Apache.Qpid.Proton.Client.IRejected.

◆ Description

string Apache.Qpid.Proton.Client.Implementation.ClientRejected.Description
get

Quick access to any description value provided in the error condition sent with the rejected outcome.

Implements Apache.Qpid.Proton.Client.IRejected.

◆ Info

IReadOnlyDictionary<string, object> Apache.Qpid.Proton.Client.Implementation.ClientRejected.Info
get

Returns any information entries that were applied to this rejected outcome in the error condition.

Implements Apache.Qpid.Proton.Client.IRejected.

◆ IsRejected

override bool Apache.Qpid.Proton.Client.Implementation.ClientRejected.IsRejected
get

Quick access to determine if the state value indicates the delivery was rejected.

Implements Apache.Qpid.Proton.Client.IDeliveryState.

◆ Type

override DeliveryStateType Apache.Qpid.Proton.Client.Implementation.ClientRejected.Type
get

Returns an enumeration value which indicates what type of DeliveryState this instance represents.

Implements Apache.Qpid.Proton.Client.IDeliveryState.


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