disposition.h File Reference

Disposition API for the proton Engine. 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   (0x0000000000000023)
	The PN_RECEIVED delivery state is a non terminal state indicating how much (if any) message data has been received for a delivery. More...
#define	PN_ACCEPTED   (0x0000000000000024)
	The PN_ACCEPTED delivery state is a terminal state indicating that the delivery was successfully processed. More...
#define	PN_REJECTED   (0x0000000000000025)
	The PN_REJECTED delivery state is a terminal state indicating that the delivery could not be processed due to some error condition. More...
#define	PN_RELEASED   (0x0000000000000026)
	The PN_RELEASED delivery state is a terminal state indicating that the delivery is being returned to the sender. More...
#define	PN_MODIFIED   (0x0000000000000027)
	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. More...

Typedefs
typedef struct pn_disposition_t	pn_disposition_t
	Dispositions record the current state and/or final outcome of a transfer. More...

Functions
PN_EXTERN uint64_t	pn_disposition_type (pn_disposition_t *disposition)
	Get the type of a disposition. More...
PN_EXTERN pn_condition_t *	pn_disposition_condition (pn_disposition_t *disposition)
	Access the condition object associated with a disposition. More...
PN_EXTERN pn_data_t *	pn_disposition_data (pn_disposition_t *disposition)
	Access the disposition as a raw pn_data_t. More...
PN_EXTERN uint32_t	pn_disposition_get_section_number (pn_disposition_t *disposition)
	Get the section number associated with a disposition. More...
PN_EXTERN void	pn_disposition_set_section_number (pn_disposition_t *disposition, uint32_t section_number)
	Set the section number associated with a disposition. More...
PN_EXTERN uint64_t	pn_disposition_get_section_offset (pn_disposition_t *disposition)
	Get the section offset associated with a disposition. More...
PN_EXTERN void	pn_disposition_set_section_offset (pn_disposition_t *disposition, uint64_t section_offset)
	Set the section offset associated with a disposition. More...
PN_EXTERN bool	pn_disposition_is_failed (pn_disposition_t *disposition)
	Check if a disposition has the failed flag set. More...
PN_EXTERN void	pn_disposition_set_failed (pn_disposition_t *disposition, bool failed)
	Set the failed flag on a disposition. More...
PN_EXTERN bool	pn_disposition_is_undeliverable (pn_disposition_t *disposition)
	Check if a disposition has the undeliverable flag set. More...
PN_EXTERN void	pn_disposition_set_undeliverable (pn_disposition_t *disposition, bool undeliverable)
	Set the undeliverable flag on a disposition. More...
PN_EXTERN pn_data_t *	pn_disposition_annotations (pn_disposition_t *disposition)
	Access the annotations associated with a disposition. More...

Detailed Description

Disposition API for the proton Engine.