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 ()
	**Experimental** - 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 ()
	**Experimental** - 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 connection	connection () const
	The connection that owns this link.
class session	session () const
	The session that owns this link.

---

Detailed Description

A channel for receiving messages.

Examples:

broker.cpp, broker.hpp, client.cpp, mt/broker.cpp, service_bus.cpp, and simple_recv.cpp.

---

Constructor & Destructor Documentation

receiver

(

)

[inline]

Create an empty receiver.

---

Member Function Documentation

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 close

(

const error_condition &

)

[virtual, inherited]

Close the endpoint with an error condition.

See also:

endpoint_lifecycle

Implements endpoint.

void close

(

)

[virtual, inherited]

Close the endpoint.

See also:

endpoint_lifecycle

Implements endpoint.

Examples:

helloworld.cpp, and helloworld_direct.cpp.

void detach

(

)

[inherited]

Suspend the link without closing it.

A suspended link may be reopened with the same or different link options if supported by the peer. A suspended durable subscription becomes inactive without cancelling it.

void drain

(

)

**Experimental** - 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.

bool draining

(

)

[inherited]

**Experimental** - 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.

See also:

receiver::drain.

void open

(

const receiver_options &

opts

)

Open the receiver.

See also:

endpoint_lifecycle

void open

(

)

Open the receiver.

See also:

endpoint_lifecycle

---

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

• proton/receiver.hpp