disposition.h

A delivery state. More...

#include <proton/import_export.h>
#include <proton/type_compat.h>
#include <proton/condition.h>
#include <stddef.h>

Go to the source code of this file.

Macros
#define	PN_RECEIVED
	The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has been received for a delivery.
#define	PN_ACCEPTED
	The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully processed.
#define	PN_REJECTED
	The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processed due to some error condition.
#define	PN_RELEASED
	The PN_RELEASED delivery state is a terminal state indicating that the delivery is being returned to the sender.
#define	PN_MODIFIED
	The PN_MODIFIED delivery state is a terminal state indicating that the delivery is being returned to the sender and should be annotated by the sender prior to further delivery attempts.
#define	PN_DECLARED
	The PN_DECLARED delivery state is a terminal state indicating that a transaction has been declared and indicating its transaction identifier.
#define	PN_TRANSACTIONAL_STATE
	The PN_TRANSACTIONAL_STATE delivery state is a non terminal state indicating the transactional state of a delivery.

Typedefs
typedef struct pn_disposition_t	pn_disposition_t
	A delivery state.
typedef struct pn_received_disposition_t	pn_received_disposition_t
	A received delivery disposition.
typedef struct pn_rejected_disposition_t	pn_rejected_disposition_t
	A rejected delivery disposition.
typedef struct pn_modified_disposition_t	pn_modified_disposition_t
	A modified delivery disposition.
typedef struct pn_declared_disposition_t	pn_declared_disposition_t
	A transaction declared delivery disposition.
typedef struct pn_transactional_disposition_t	pn_transactional_disposition_t
	A transactional delivery disposition.
typedef struct pn_custom_disposition_t	pn_custom_disposition_t
	A custom delivery disposition.

Functions
uint64_t	pn_disposition_type (pn_disposition_t *disposition)
	Get the type of a disposition.
const char *	pn_disposition_type_name (uint64_t disposition_type)
	Name of a disposition type for logging and debugging: "received", "accepted" etc.
void	pn_disposition_clear (pn_disposition_t *disposition)
	Clear a disposition.
pn_condition_t *	pn_disposition_condition (pn_disposition_t *disposition)
	Access the condition object associated with a disposition.
pn_data_t *	pn_disposition_data (pn_disposition_t *disposition)
	Access the disposition as a raw pn_data_t.
uint32_t	pn_disposition_get_section_number (pn_disposition_t *disposition)
	Get the section number associated with a disposition.
void	pn_disposition_set_section_number (pn_disposition_t *disposition, uint32_t section_number)
	Set the section number associated with a disposition.
uint64_t	pn_disposition_get_section_offset (pn_disposition_t *disposition)
	Get the section offset associated with a disposition.
void	pn_disposition_set_section_offset (pn_disposition_t *disposition, uint64_t section_offset)
	Set the section offset associated with a disposition.
bool	pn_disposition_is_failed (pn_disposition_t *disposition)
	Check if a disposition has the failed flag set.
void	pn_disposition_set_failed (pn_disposition_t *disposition, bool failed)
	Set the failed flag on a disposition.
bool	pn_disposition_is_undeliverable (pn_disposition_t *disposition)
	Check if a disposition has the undeliverable flag set.
void	pn_disposition_set_undeliverable (pn_disposition_t *disposition, bool undeliverable)
	Set the undeliverable flag on a disposition.
pn_data_t *	pn_disposition_annotations (pn_disposition_t *disposition)
	Access the annotations associated with a disposition.
pn_custom_disposition_t *	pn_custom_disposition (pn_disposition_t *disposition)
	Convert a delivery disposition to a custom disposition.
pn_received_disposition_t *	pn_received_disposition (pn_disposition_t *disposition)
	Convert a delivery disposition to a received disposition.
pn_rejected_disposition_t *	pn_rejected_disposition (pn_disposition_t *disposition)
	Convert a delivery disposition to a rejected disposition.
pn_modified_disposition_t *	pn_modified_disposition (pn_disposition_t *disposition)
	Convert a delivery disposition to a modified disposition.
pn_declared_disposition_t *	pn_declared_disposition (pn_disposition_t *disposition)
	Convert a delivery disposition to a transaction declared disposition.
pn_transactional_disposition_t *	pn_transactional_disposition (pn_disposition_t *disposition)
	Convert a delivery disposition to a transactional disposition.
pn_data_t *	pn_custom_disposition_data (pn_custom_disposition_t *disposition)
	Access the disposition as a raw pn_data_t.
uint64_t	pn_custom_disposition_get_type (pn_custom_disposition_t *disposition)
	Get the type of a custom disposition.
void	pn_custom_disposition_set_type (pn_custom_disposition_t *disposition, uint64_t type)
	Set the type of a custom disposition.
pn_condition_t *	pn_rejected_disposition_condition (pn_rejected_disposition_t *disposition)
	Access the condition object associated with a rejected disposition.
uint32_t	pn_received_disposition_get_section_number (pn_received_disposition_t *disposition)
	Get the section number associated with a received disposition.
void	pn_received_disposition_set_section_number (pn_received_disposition_t *disposition, uint32_t section_number)
	Set the section number associated with a received disposition.
uint64_t	pn_received_disposition_get_section_offset (pn_received_disposition_t *disposition)
	Get the section offset associated with a received disposition.
void	pn_received_disposition_set_section_offset (pn_received_disposition_t *disposition, uint64_t section_offset)
	Set the section offset associated with a received disposition.
bool	pn_modified_disposition_is_failed (pn_modified_disposition_t *disposition)
	Check if a modified disposition has the failed flag set.
void	pn_modified_disposition_set_failed (pn_modified_disposition_t *disposition, bool failed)
	Set the failed flag on a modified disposition.
bool	pn_modified_disposition_is_undeliverable (pn_modified_disposition_t *disposition)
	Check if a modified disposition has the undeliverable flag set.
void	pn_modified_disposition_set_undeliverable (pn_modified_disposition_t *disposition, bool undeliverable)
	Set the undeliverable flag on a modified disposition.
pn_data_t *	pn_modified_disposition_annotations (pn_modified_disposition_t *disposition)
	Access the annotations associated with a modified disposition.
pn_bytes_t	pn_declared_disposition_get_id (pn_declared_disposition_t *disposition)
	Get the transaction id for a transaction declared disposition.
void	pn_declared_disposition_set_id (pn_declared_disposition_t *disposition, pn_bytes_t id)
	Set the transaction id for a transaction declared disposition.
pn_bytes_t	pn_transactional_disposition_get_id (pn_transactional_disposition_t *disposition)
	Get the transaction id for a transaction declared disposition.
void	pn_transactional_disposition_set_id (pn_transactional_disposition_t *disposition, pn_bytes_t id)
	Set the transaction id for a transactional disposition.
uint64_t	pn_transactional_disposition_get_outcome_type (pn_transactional_disposition_t *disposition)
	Get the provisional outcome of the delivery if the transaction is committed successfully.
void	pn_transactional_disposition_set_outcome_type (pn_transactional_disposition_t *disposition, uint64_t outcome)
	Set the provisional outcome of the del;ivery if the transaction is committed successfully.

Detailed Description

A delivery state.