Apache.Qpid.Proton.Client.Implementation.ClientModified Class Reference

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

Inheritance diagram for Apache.Qpid.Proton.Client.Implementation.ClientModified:

Public Member Functions
	ClientModified (bool failed, bool undeliverable)
	Create a new instance with the given outcome values.
	ClientModified (bool failed, bool undeliverable, IDictionary< string, object > annotations)
	Create a new instance with the given outcome values.

Properties
override DeliveryStateType	Type [get]
	Returns an enumeration value which indicates what type of DeliveryState this instance represents.
override Types.Transport.IDeliveryState	ProtonDeliveryState [get]
override bool	IsModified [get]
	Quick access to determine if the state value indicates the delivery was modified.
bool	DeliveryFailed [get]
	Quick access to determine if the modified outcome indicates the delivery has failed.
bool	UndeliverableHere [get]
	Quick access to determine if the modified outcome indicates the delivery cannot be redelivered to the target.
IReadOnlyDictionary< string, object >	MessageAnnotations [get]
	Returns any delivery annotations that were applied to this modified outcome.
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.IModified

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 Modified delivery state.

Constructor & Destructor Documentation

ClientModified() [1/2]

Apache.Qpid.Proton.Client.Implementation.ClientModified.ClientModified ( bool  failed, bool  undeliverable  )

inline

Create a new instance with the given outcome values.

Parameters

failed	did the delivery fail for some reason
undeliverable	should the delivery be treated an not deliverable here any longer

ClientModified() [2/2]

Apache.Qpid.Proton.Client.Implementation.ClientModified.ClientModified ( bool  failed, bool  undeliverable, IDictionary< string, object >  annotations  )

inline

Create a new instance with the given outcome values.

Parameters

failed	did the delivery fail for some reason
undeliverable	should the delivery be treated an not deliverable here any longer
annotations	modification to existing message annotations

Property Documentation

DeliveryFailed

bool Apache.Qpid.Proton.Client.Implementation.ClientModified.DeliveryFailed

get

Quick access to determine if the modified outcome indicates the delivery has failed.

Implements Apache.Qpid.Proton.Client.IModified.

IsModified

override bool Apache.Qpid.Proton.Client.Implementation.ClientModified.IsModified

get

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

Implements Apache.Qpid.Proton.Client.IDeliveryState.

MessageAnnotations

IReadOnlyDictionary<string, object> Apache.Qpid.Proton.Client.Implementation.ClientModified.MessageAnnotations

get

Returns any delivery annotations that were applied to this modified outcome.

Implements Apache.Qpid.Proton.Client.IModified.

Type

override DeliveryStateType Apache.Qpid.Proton.Client.Implementation.ClientModified.Type

get

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

Implements Apache.Qpid.Proton.Client.IDeliveryState.

UndeliverableHere

bool Apache.Qpid.Proton.Client.Implementation.ClientModified.UndeliverableHere

get

Quick access to determine if the modified outcome indicates the delivery cannot be redelivered to the target.

Implements Apache.Qpid.Proton.Client.IModified.

---

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

• src/Proton.Client/Client/Implementation/ClientDeliveryState.cs