A channel for receiving messages. More...
#include <receiver.hpp>
Public Member Functions | |
receiver () | |
void | open () |
Open the receiver. | |
void | open (const receiver_options &opts) |
class source | source () const |
Get the source node. | |
class target | target () const |
Get the target node. | |
void | add_credit (uint32_t) |
Increment the credit available to the sender. | |
void | drain () |
**Unsettled API** - Commence a drain cycle. |
A channel for receiving messages.
broker.cpp, client.cpp, multithreaded_client_flow_control.cpp, service_bus.cpp, and simple_recv.cpp.
void open | ( | ) |
Open the receiver.
void open | ( | const receiver_options & | opts | ) |
Open the receiver.
void add_credit | ( | uint32_t | ) |
void drain | ( | ) |
**Unsettled API** - Commence a drain cycle.
If there is positive credit, a request is sent to the sender to immediately use up all of the existing credit balance by sending messages that are immediately available and releasing any unused credit (see sender::return_credit). Throws proton::error if a drain cycle is already in progress. An on_receiver_drain_finish event will be generated when the outstanding drained credit reaches zero.