Qpid Proton C++ API  0.18.1
session

A container of senders and receivers. More...

#include <session.hpp>

Inheritance diagram for session:
endpoint

Public Member Functions

 session ()
 Create an empty session.
 
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 open ()
 Open the session. More...
 
void open (const session_options &opts)
 Open the session. More...
 
void close ()
 Close the endpoint. More...
 
void close (const error_condition &)
 Close the endpoint with an error condition. More...
 
class containercontainer () const
 Get the container for this session.
 
class work_queuework_queue () const
 Get the work_queue for the session.
 
class connection connection () const
 Get the connection this session belongs to.
 
sender open_sender (const std::string &addr)
 Open a sender for addr.
 
sender open_sender (const std::string &addr, const sender_options &opts)
 Open a sender for addr. More...
 
receiver open_receiver (const std::string &addr)
 Open a receiver for addr.
 
receiver open_receiver (const std::string &addr, const receiver_options &opts)
 Open a receiver for addr. More...
 
size_t incoming_bytes () const
 The number of incoming bytes currently buffered.
 
size_t outgoing_bytes () const
 The number of outgoing bytes currently buffered.
 
sender_range senders () const
 Return the senders on this session.
 
receiver_range receivers () const
 Return the receivers on this session.
 

Detailed Description

A container of senders and receivers.

Examples:
broker.cpp.

Member Function Documentation

◆ open() [1/2]

void open ( )

Open the session.

See also
endpoint_lifecycle

◆ open() [2/2]

void open ( const session_options opts)

Open the session.

See also
endpoint_lifecycle

◆ close() [1/2]

void close ( )
virtual

Close the endpoint.

See also
endpoint_lifecycle

Implements endpoint.

◆ close() [2/2]

void close ( const error_condition )
virtual

Close the endpoint with an error condition.

See also
endpoint_lifecycle

Implements endpoint.

◆ open_sender()

sender open_sender ( const std::string &  addr,
const sender_options opts 
)

Open a sender for addr.

◆ open_receiver()

receiver open_receiver ( const std::string &  addr,
const receiver_options opts 
)

Open a receiver for addr.


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