receiver Class Reference

A channel for receiving messages. More...

#include <receiver.hpp>

Inheritance diagram for receiver:

List of all members.

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.

---

Detailed Description

A channel for receiving messages.

Examples:

broker.cpp, client.cpp, multithreaded_client_flow_control.cpp, service_bus.cpp, and simple_recv.cpp.

---

Constructor & Destructor Documentation

receiver

(

)

[inline]

Create an empty receiver.

---

Member Function Documentation

void open

(

const receiver_options &

opts

)

Open the receiver.

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.

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:

• proton/receiver.hpp