Qpid Proton C++ API  0.18.0
delivery

A received message. More...

#include <delivery.hpp>

Inheritance diagram for delivery:
transfer

Public Types

enum  state {
  NONE, RECEIVED, ACCEPTED, REJECTED,
  RELEASED, MODIFIED
}
 Delivery state values. More...
 

Public Member Functions

class receiver receiver () const
 Return the receiver for this delivery.
 
void accept ()
 Settle with ACCEPTED state.
 
void reject ()
 Settle with REJECTED state.
 
void release ()
 Settle with RELEASED state.
 
void modify ()
 Settle with MODIFIED state.
 
enum state state () const
 Get the remote state for a delivery.
 
class session session () const
 Return the session for this transfer.
 
class connection connection () const
 Return the connection for this transfer.
 
class work_queuework_queue () const
 Get the work_queue for the transfer.
 
class containercontainer () const
 Return the container for this transfer.
 
void settle ()
 Settle the delivery; informs the remote end.
 
bool settled () const
 Return true if the transfer has been settled.
 

Detailed Description

A received message.

A delivery attempt can fail. As a result, a particular message may correspond to multiple deliveries.

Examples:
broker.cpp, client.cpp, direct_recv.cpp, helloworld.cpp, helloworld_direct.cpp, multithreaded_client.cpp, multithreaded_client_flow_control.cpp, server.cpp, server_direct.cpp, service_bus.cpp, and simple_recv.cpp.

Member Enumeration Documentation

◆ state

enum state
inherited

Delivery state values.

Enumerator
NONE 

Unknown state.

RECEIVED 

Received but not yet settled.

ACCEPTED 

Settled as accepted.

REJECTED 

Settled as rejected.

RELEASED 

Settled as released.

MODIFIED 

Settled as modified.


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