Qpid Proton C++ 0.40.0
 
Loading...
Searching...
No Matches
receiver

A channel for receiving messages. More...

#include <receiver.hpp>

Inheritance diagram for receiver:
link endpoint

Public Member Functions

 receiver ()=default
 Create an empty receiver.
 
void open ()
 Open the receiver.
 
void open (const receiver_options &opts)
 Open the receiver.
 
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.
 

Detailed Description

A channel for receiving messages.

Examples
client.cpp, simple_recv.cpp, and tracing_client.cpp.

Member Function Documentation

◆ open()

void open ( const receiver_options & opts)

Open the receiver.

◆ add_credit()

void add_credit ( uint32_t )

Increment the credit available to the sender.

Credit granted during a drain cycle is not communicated to the receiver until the drain completes.

Examples
multithreaded_client_flow_control.cpp.

◆ drain()

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.


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