Qpid Proton C API  0.18.0
delivery.h File Reference

A message transfer. More...

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

Go to the source code of this file.

Typedefs

typedef pn_bytes_t pn_delivery_tag_t
 An AMQP delivery tag.
 

Functions

pn_delivery_tag_t pn_dtag (const char *bytes, size_t size)
 Construct a delivery tag. More...
 
pn_delivery_tpn_delivery (pn_link_t *link, pn_delivery_tag_t tag)
 Create a delivery on a link. More...
 
void * pn_delivery_get_context (pn_delivery_t *delivery)
 Deprecated - Use pn_delivery_attachments(). More...
 
void pn_delivery_set_context (pn_delivery_t *delivery, void *context)
 Deprecated - Use pn_delivery_attachments(). More...
 
pn_record_t * pn_delivery_attachments (pn_delivery_t *delivery)
 Get the attachments that are associated with a delivery object. More...
 
pn_delivery_tag_t pn_delivery_tag (pn_delivery_t *delivery)
 Get the tag for a delivery object. More...
 
pn_link_tpn_delivery_link (pn_delivery_t *delivery)
 Get the parent link for a delivery object. More...
 
pn_disposition_tpn_delivery_local (pn_delivery_t *delivery)
 Get the local disposition for a delivery. More...
 
uint64_t pn_delivery_local_state (pn_delivery_t *delivery)
 Get the local disposition state for a delivery. More...
 
pn_disposition_tpn_delivery_remote (pn_delivery_t *delivery)
 Get the remote disposition for a delivery. More...
 
uint64_t pn_delivery_remote_state (pn_delivery_t *delivery)
 Get the remote disposition state for a delivery. More...
 
bool pn_delivery_settled (pn_delivery_t *delivery)
 Check if a delivery is remotely settled. More...
 
size_t pn_delivery_pending (pn_delivery_t *delivery)
 Get the amount of pending message data for a delivery. More...
 
bool pn_delivery_partial (pn_delivery_t *delivery)
 Check if a delivery only has partial message data. More...
 
bool pn_delivery_aborted (pn_delivery_t *delivery)
 Check if a received delivery has been aborted. More...
 
bool pn_delivery_writable (pn_delivery_t *delivery)
 Check if a delivery is writable. More...
 
bool pn_delivery_readable (pn_delivery_t *delivery)
 Check if a delivery is readable. More...
 
bool pn_delivery_updated (pn_delivery_t *delivery)
 Check if a delivery is updated. More...
 
void pn_delivery_update (pn_delivery_t *delivery, uint64_t state)
 Update the disposition of a delivery. More...
 
void pn_delivery_clear (pn_delivery_t *delivery)
 Clear the updated flag for a delivery. More...
 
bool pn_delivery_current (pn_delivery_t *delivery)
 Return true if delivery is the current delivery for its link. More...
 
void pn_delivery_abort (pn_delivery_t *delivery)
 Abort a delivery being sent. More...
 
void pn_delivery_settle (pn_delivery_t *delivery)
 Settle a delivery. More...
 
void pn_delivery_dump (pn_delivery_t *delivery)
 Utility function for printing details of a delivery. More...
 
bool pn_delivery_buffered (pn_delivery_t *delivery)
 Check if a delivery is buffered. More...
 
pn_delivery_tpn_work_head (pn_connection_t *connection)
 Extracts the first delivery on the connection that has pending operations. More...
 
pn_delivery_tpn_work_next (pn_delivery_t *delivery)
 Get the next delivery on the connection that needs has pending operations. More...
 

Detailed Description

A message transfer.