Apache.Qpid.Proton.Client.IDeliveryState Interface Reference

Delivery state instance have a type (e.g. Accepted, Rejected ...) and can in case of a transactional delivery state, carry an outcome and in those cases the is outcome APIs return the value of the nested outcome carried in the transactional. More...

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

Static Public Member Functions
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.

Properties
DeliveryStateType	Type [get]
	Returns an enumeration value which indicates what type of DeliveryState this instance represents.
bool	IsAccepted [get]
	Quick access to determine if the state value indicates the delivery was accepted.
bool	IsRejected [get]
	Quick access to determine if the state value indicates the delivery was rejected.
bool	IsReleased [get]
	Quick access to determine if the state value indicates the delivery was released.
bool	IsModified [get]
	Quick access to determine if the state value indicates the delivery was modified.
bool	IsTransactional [get]
	Quick access to determine if the state value indicates the delivery was transactional.

Detailed Description

Delivery state instance have a type (e.g. Accepted, Rejected ...) and can in case of a transactional delivery state, carry an outcome and in those cases the is outcome APIs return the value of the nested outcome carried in the transactional.

Member Function Documentation

Accepted()

static IDeliveryState Apache.Qpid.Proton.Client.IDeliveryState.Accepted ( )

static

Returns an instance of a delivery state that accepts a delivery.

Returns

An accepted delivery state type

Modified()

static IDeliveryState Apache.Qpid.Proton.Client.IDeliveryState.Modified ( bool  deliveryFailed, bool  undeliverableHere = false, IDictionary< string, object >  annotations = null  )

static

Returns an instance of a delivery state that modifies a delivery.

Returns

An modified delivery state type

Rejected()

static IDeliveryState Apache.Qpid.Proton.Client.IDeliveryState.Rejected ( string  condition, string  description = null, IDictionary< string, object >  info = null  )

static

Returns an instance of a delivery state that rejects a delivery.

Returns

An rejected delivery state type

Released()

static IDeliveryState Apache.Qpid.Proton.Client.IDeliveryState.Released ( )

static

Returns an instance of a delivery state that releases a delivery.

Returns

An released delivery state type

Property Documentation

IsAccepted

bool Apache.Qpid.Proton.Client.IDeliveryState.IsAccepted

get

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientDeliveryState, Apache.Qpid.Proton.Client.Implementation.ClientAccepted, and Apache.Qpid.Proton.Client.Implementation.ClientTransactional.

IsModified

bool Apache.Qpid.Proton.Client.IDeliveryState.IsModified

get

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientDeliveryState, Apache.Qpid.Proton.Client.Implementation.ClientModified, and Apache.Qpid.Proton.Client.Implementation.ClientTransactional.

IsRejected

bool Apache.Qpid.Proton.Client.IDeliveryState.IsRejected

get

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientDeliveryState, Apache.Qpid.Proton.Client.Implementation.ClientRejected, and Apache.Qpid.Proton.Client.Implementation.ClientTransactional.

IsReleased

bool Apache.Qpid.Proton.Client.IDeliveryState.IsReleased

get

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientDeliveryState, Apache.Qpid.Proton.Client.Implementation.ClientReleased, and Apache.Qpid.Proton.Client.Implementation.ClientTransactional.

IsTransactional

bool Apache.Qpid.Proton.Client.IDeliveryState.IsTransactional

get

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientDeliveryState, and Apache.Qpid.Proton.Client.Implementation.ClientTransactional.

Type

DeliveryStateType Apache.Qpid.Proton.Client.IDeliveryState.Type

get

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

Implemented in Apache.Qpid.Proton.Client.Implementation.ClientDeliveryState, Apache.Qpid.Proton.Client.Implementation.ClientAccepted, Apache.Qpid.Proton.Client.Implementation.ClientReleased, Apache.Qpid.Proton.Client.Implementation.ClientRejected, Apache.Qpid.Proton.Client.Implementation.ClientModified, and Apache.Qpid.Proton.Client.Implementation.ClientTransactional.

---

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

• src/Proton.Client/Client/IDeliveryState.cs