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. | |
bool | uninitialized () const |
True if the local end is uninitialized. | |
bool | active () const |
True if the local end is active. | |
bool | closed () const |
True if the local and remote ends are closed. | |
class error_condition | error () const |
Get the error condition of the remote endpoint. | |
void | close () |
Close the endpoint. | |
void | close (const error_condition &) |
Close the endpoint with an error condition. | |
void | detach () |
Suspend the link without closing it. | |
int | credit () const |
Credit available on the link. | |
bool | draining () |
**Unsettled API** - True for a receiver if a drain cycle has been started and the corresponding `on_receiver_drain_finish` event is still pending. | |
std::string | name () const |
Get the link name. | |
class container & | container () const |
The container for this link. | |
class work_queue & | work_queue () const |
Get the work_queue for the link. | |
class connection | connection () const |
The connection that owns this link. | |
class session | session () const |
The session that owns this link. |
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.
void close | ( | ) | [virtual, inherited] |
void close | ( | const error_condition & | ) | [virtual, inherited] |
void detach | ( | ) | [inherited] |
bool draining | ( | ) | [inherited] |
**Unsettled API** - True for a receiver if a drain cycle has been started and the corresponding `on_receiver_drain_finish` event is still pending.
True for a sender if the receiver has requested a drain of credit and the sender has unused credit.