message.h File Reference

Message API for encoding/decoding AMQP Messages. More...

`#include <proton/import_export.h>`
`#include <proton/types.h>`
`#include <proton/codec.h>`
`#include <proton/error.h>`
`#include <proton/type_compat.h>`

Go to the source code of this file.

## Macros

#define | PN_DEFAULT_PRIORITY (4)
| Default priority for messages. More...

## Typedefs

typedef struct pn_message_t | pn_message_t
| An AMQP Message object. More...

## Functions

PN_EXTERN pn_message_t * | pn_message (void)
| Construct a new pn_message_t. More...
PN_EXTERN void | pn_message_free (pn_message_t *msg)
| Free a previously constructed pn_message_t. More...
PN_EXTERN void | pn_message_clear (pn_message_t *msg)
| Clears the content of a pn_message_t. More...
PN_EXTERN int | pn_message_errno (pn_message_t *msg)
| Access the error code of a message. More...
PN_EXTERN pn_error_t * | pn_message_error (pn_message_t *msg)
| Access the error information for a message. More...
PN_EXTERN bool | pn_message_is_inferred (pn_message_t *msg)
| Get the inferred flag for a message. More...
PN_EXTERN int | pn_message_set_inferred (pn_message_t *msg, bool inferred)
| Set the inferred flag for a message. More...
PN_EXTERN bool | pn_message_is_durable (pn_message_t *msg)
| Get the durable flag for a message. More...
PN_EXTERN int | pn_message_set_durable (pn_message_t *msg, bool durable)
| Set the durable flag for a message. More...
PN_EXTERN uint8_t | pn_message_get_priority (pn_message_t *msg)
| Get the priority for a message. More...
PN_EXTERN int | pn_message_set_priority (pn_message_t *msg, uint8_t priority)
| Set the priority for a message. More...
PN_EXTERN pn_millis_t | pn_message_get_ttl (pn_message_t *msg)
| Get the ttl for a message. More...
PN_EXTERN int | pn_message_set_ttl (pn_message_t *msg, pn_millis_t ttl)
| Set the ttl for a message. More...
PN_EXTERN bool | pn_message_is_first_acquirer (pn_message_t *msg)
| Get the first acquirer flag for a message. More...
PN_EXTERN int | pn_message_set_first_acquirer (pn_message_t *msg, bool first)
| Set the first acquirer flag for a message. More...
PN_EXTERN uint32_t | pn_message_get_delivery_count (pn_message_t *msg)
| Get the delivery count for a message. More...
PN_EXTERN int | pn_message_set_delivery_count (pn_message_t *msg, uint32_t count)
| Set the delivery count for a message. More...
PN_EXTERN pn_data_t * | pn_message_id (pn_message_t *msg)
| Get/set the id for a message. More...
PN_EXTERN pn_atom_t | pn_message_get_id (pn_message_t *msg)
| Get the id for a message. More...
PN_EXTERN int | pn_message_set_id (pn_message_t *msg, pn_atom_t id)
| Set the id for a message. More...
PN_EXTERN pn_bytes_t | pn_message_get_user_id (pn_message_t *msg)
| Get the user id for a message. More...
PN_EXTERN int | pn_message_set_user_id (pn_message_t *msg, pn_bytes_t user_id)
| Set the user id for a message. More...
PN_EXTERN const char * | pn_message_get_address (pn_message_t *msg)
| Get the address for a message. More...
PN_EXTERN int | pn_message_set_address (pn_message_t *msg, const char *address)
| Set the address for a message. More...
PN_EXTERN const char * | pn_message_get_subject (pn_message_t *msg)
| Get the subject for a message. More...
PN_EXTERN int | pn_message_set_subject (pn_message_t *msg, const char *subject)
| Set the subject for a message. More...
PN_EXTERN const char * | pn_message_get_reply_to (pn_message_t *msg)
| Get the reply_to for a message. More...
PN_EXTERN int | pn_message_set_reply_to (pn_message_t *msg, const char *reply_to)
| Set the reply_to for a message. More...
PN_EXTERN pn_data_t * | pn_message_correlation_id (pn_message_t *msg)
| Get/set the correlation id for a message. More...
PN_EXTERN pn_atom_t | pn_message_get_correlation_id (pn_message_t *msg)
| Get the correlation id for a message. More...
PN_EXTERN int | pn_message_set_correlation_id (pn_message_t *msg, pn_atom_t id)
| Set the correlation id for a message. More...
PN_EXTERN const char * | pn_message_get_content_type (pn_message_t *msg)
| Get the content_type for a message. More...
PN_EXTERN int | pn_message_set_content_type (pn_message_t *msg, const char *type)
| Set the content_type for a message. More...
PN_EXTERN const char * | pn_message_get_content_encoding (pn_message_t *msg)
| Get the content_encoding for a message. More...
PN_EXTERN int | pn_message_set_content_encoding (pn_message_t *msg, const char *encoding)
| Set the content_encoding for a message. More...
PN_EXTERN pn_timestamp_t | pn_message_get_expiry_time (pn_message_t *msg)
| Get the expiry time for a message. More...
PN_EXTERN int | pn_message_set_expiry_time (pn_message_t *msg, pn_timestamp_t time)
| Set the expiry time for a message. More...
PN_EXTERN pn_timestamp_t | pn_message_get_creation_time (pn_message_t *msg)
| Get the creation time for a message. More...
PN_EXTERN int | pn_message_set_creation_time (pn_message_t *msg, pn_timestamp_t time)
| Set the creation time for a message. More...
PN_EXTERN const char * | pn_message_get_group_id (pn_message_t *msg)
| Get the group_id for a message. More...
PN_EXTERN int | pn_message_set_group_id (pn_message_t *msg, const char *group_id)
| Set the group_id for a message. More...
PN_EXTERN pn_sequence_t | pn_message_get_group_sequence (pn_message_t *msg)
| Get the group sequence for a message. More...
PN_EXTERN int | pn_message_set_group_sequence (pn_message_t *msg, pn_sequence_t n)
| Set the group sequence for a message. More...
PN_EXTERN const char * | pn_message_get_reply_to_group_id (pn_message_t *msg)
| Get the reply_to_group_id for a message. More...
PN_EXTERN int | pn_message_set_reply_to_group_id (pn_message_t *msg, const char *reply_to_group_id)
| Set the reply_to_group_id for a message. More...
PN_EXTERN pn_data_t * | pn_message_instructions (pn_message_t *msg)
| Get/set the delivery instructions for a message. More...
PN_EXTERN pn_data_t * | pn_message_annotations (pn_message_t *msg)
| Get/set the annotations for a message. More...
PN_EXTERN pn_data_t * | pn_message_properties (pn_message_t *msg)
| Get/set the properties for a message. More...
PN_EXTERN pn_data_t * | pn_message_body (pn_message_t *msg)
| Get/set the body of a message. More...
PN_EXTERN int | pn_message_decode (pn_message_t *msg, const char *bytes, size_t size)
| Decode/load message content from AMQP formatted binary data. More...
PN_EXTERN int | pn_message_encode (pn_message_t *msg, char *bytes, size_t *size)
| Encode/save message content as AMQP formatted binary data. More...
PN_EXTERN int | pn_message_data (pn_message_t *msg, pn_data_t *data)
| Save message content into a pn_data_t object data. More...

## Detailed Description

Message API for encoding/decoding AMQP Messages.