A connection to a remote AMQP peer. More...
#include <connection.hpp>
Public Member Functions | |
connection () | |
Create an empty connection. | |
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. | |
class container & | container () const |
Get the container. More... | |
class work_queue & | work_queue () const |
Get the work_queue for the connection. | |
class transport | transport () const |
Get the transport for the connection. | |
std::string | virtual_host () const |
Return the AMQP hostname attribute for the connection. | |
std::string | container_id () const |
Return the container ID for the connection. | |
std::string | user () const |
Return authenticated user for the connection Note: The value returned is not stable until the on_transport_open event is received. | |
void | open () |
Open the connection. More... | |
void | open (const connection_options &) |
Open the connection. More... | |
void | close () |
Close the endpoint. More... | |
void | close (const error_condition &) |
Close the endpoint with an error condition. More... | |
session | open_session () |
Open a new session. | |
session | open_session (const session_options &) |
Open a new session. More... | |
session | default_session () |
Get the default session. More... | |
sender | open_sender (const std::string &addr) |
Open a sender for addr on default_session(). | |
sender | open_sender (const std::string &addr, const sender_options &) |
Open a sender for addr on default_session(). More... | |
receiver | open_receiver (const std::string &addr) |
Open a receiver for addr on default_session(). | |
receiver | open_receiver (const std::string &addr, const receiver_options &) |
Open a receiver for addr on default_session(). More... | |
class sender_options | sender_options () const |
class receiver_options | receiver_options () const |
session_range | sessions () const |
Return all sessions on this connection. | |
receiver_range | receivers () const |
Return all receivers on this connection. | |
sender_range | senders () const |
Return all senders on this connection. | |
uint32_t | max_frame_size () const |
Get the maximum frame size allowed by the remote peer. More... | |
uint16_t | max_sessions () const |
Get the maximum number of open sessions allowed by the remote peer. More... | |
uint32_t | idle_timeout () const |
Get the idle timeout set by the remote peer. More... | |
void | wake () const |
Unsettled API - Trigger an event from another thread. More... | |
A connection to a remote AMQP peer.
Get the container.
proton::error | if this connection is not managed by a container |
void open | ( | ) |
void open | ( | const connection_options & | ) |
Open the connection.
|
virtual |
|
virtual |
session open_session | ( | const session_options & | ) |
Open a new session.
session default_session | ( | ) |
Get the default session.
A default session is created on the first call and reused for the lifetime of the connection.
sender open_sender | ( | const std::string & | addr, |
const sender_options & | |||
) |
Open a sender for addr
on default_session().
receiver open_receiver | ( | const std::string & | addr, |
const receiver_options & | |||
) |
Open a receiver for addr
on default_session().
class sender_options sender_options | ( | ) | const |
class receiver_options receiver_options | ( | ) | const |
uint32_t max_frame_size | ( | ) | const |
Get the maximum frame size allowed by the remote peer.
uint16_t max_sessions | ( | ) | const |
Get the maximum number of open sessions allowed by the remote peer.
uint32_t idle_timeout | ( | ) | const |
Get the idle timeout set by the remote peer.
void wake | ( | ) | const |
Unsettled API - Trigger an event from another thread.
This method can be called from any thread. The Proton library will call messaging_handler::on_connection_wake()
as soon as possible in the correct event-handling thread.
Thread-safety - This is the only proton::connection
function that can be called from outside the handler thread.
messaging_handler::on_connection_wake()
calls can occur even if the application does not call wake()
.wake()
may be coalesced into a single call to messaging_handler::on_connection_wake()
that occurs after all of them.The proton::work_queue
interface provides an easier way execute code safely in the event-handler thread.