session Class Reference

A container of links. More...

#include <session.hpp>

Inheritance diagram for session:

Public Types
typedef int	state
	A bit mask of state bit values. More...

Public Member Functions
endpoint::state	state () const
	Get the state of this session.
condition	local_condition () const
	Get the local error condition.
condition	remote_condition () const
	Get the error condition of the remote endpoint.
void	close ()
	Initiate local close. More...
class connection	connection () const
	Get the connection this session belongs to.
sender	open_sender (const std::string &addr, const link_options &opts=link_options())
	Open a sender for addr.
receiver	open_receiver (const std::string &addr, const link_options &opts=link_options())
	Open a receiver for addr.
link_range	find_links (endpoint::state mask) const
	Return the links on this session matching the state mask.

Static Public Attributes
static const state	LOCAL_UNINIT
	Local endpoint is uninitialized.
static const state	REMOTE_UNINIT
	Remote endpoint is uninitialized.
static const state	LOCAL_ACTIVE
	Local endpoint is active.
static const state	REMOTE_ACTIVE
	Remote endpoint is active.
static const state	LOCAL_CLOSED
	Local endpoint has been closed.
static const state	REMOTE_CLOSED
	Remote endpoint has been closed.
static const state	LOCAL_MASK
	Mask including all LOCAL_ bits (UNINIT, ACTIVE, CLOSED)
static const state	REMOTE_MASK
	Mask including all REMOTE_ bits (UNINIT, ACTIVE, CLOSED)

Detailed Description

A container of links.

Member Typedef Documentation

typedef int state

inherited

A bit mask of state bit values.

A state mask is matched against an endpoint as follows: If the state mask contains both local and remote flags, then an exact match against those flags is performed. If state contains only local or only remote flags, then a match occurs if any of the local or remote flags are set respectively.

See Also

connection::find_links, connection::find_sessions

Member Function Documentation

void close

(

)

Initiate local close.

The operation is not complete till handler::on_session_close().

---

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

• /builddir/build/BUILD/qpid-proton-0.12.0/proton-c/bindings/cpp/include/proton/session.hpp