Qpid Proton C++
0.13.0
|
A top-level container of connections, sessions, senders, and receivers. More...
#include <container.hpp>
Public Member Functions | |
virtual returned< connection > | connect (const std::string &url, const connection_options &)=0 |
Connect to url and send an open request to the remote peer. More... | |
returned< connection > | connect (const std::string &url) |
Connect to url and send an open request to the remote peer. | |
virtual listener | listen (const std::string &url, listen_handler &lh)=0 |
Start listening on url. More... | |
virtual listener | listen (const std::string &url, const connection_options &) |
Listen with a fixed set of options for all accepted connections. More... | |
virtual listener | listen (const std::string &url) |
Start listening on URL. More... | |
virtual void | run ()=0 |
Run the container in this thread. More... | |
virtual void | auto_stop (bool)=0 |
If true, stop the container when all active connections and listeners are closed. More... | |
virtual void | stop (const error_condition &err=error_condition())=0 |
Experimental - Stop the container with an optional error_condition err. More... | |
virtual returned< sender > | open_sender (const std::string &url) |
Open a connection and sender for url . | |
virtual returned< sender > | open_sender (const std::string &url, const proton::sender_options &o) |
Open a connection and sender for url . More... | |
virtual returned< sender > | open_sender (const std::string &url, const proton::sender_options &o, const connection_options &c)=0 |
Open a connection and sender for url . More... | |
virtual returned< receiver > | open_receiver (const std::string &url) |
Open a connection and receiver for url . | |
virtual returned< receiver > | open_receiver (const std::string &url, const proton::receiver_options &o) |
Open a connection and receiver for url . More... | |
virtual returned< receiver > | open_receiver (const std::string &url, const proton::receiver_options &o, const connection_options &c)=0 |
Open a connection and receiver for url . More... | |
virtual std::string | id () const =0 |
A unique identifier for the container. | |
virtual void | client_connection_options (const connection_options &)=0 |
Connection options that will be to outgoing connections. More... | |
virtual connection_options | client_connection_options () const =0 |
Connection options that will be to outgoing connections. More... | |
virtual void | server_connection_options (const connection_options &)=0 |
Connection options that will be applied to incoming connections. More... | |
virtual connection_options | server_connection_options () const =0 |
Connection options that will be applied to incoming connections. More... | |
virtual void | sender_options (const class sender_options &)=0 |
Sender options applied to senders created by this container. More... | |
virtual class sender_options | sender_options () const =0 |
Sender options applied to senders created by this container. More... | |
virtual void | receiver_options (const class receiver_options &)=0 |
Receiver options applied to receivers created by this container. More... | |
virtual class receiver_options | receiver_options () const =0 |
Receiver options applied to receivers created by this container. More... | |
A top-level container of connections, sessions, senders, and receivers.
A container gives a unique identity to each communicating peer. It is often a process-level object.
It serves as an entry point to the API, allowing connections, senders, and receivers to be established. It can be supplied with an event handler in order to intercept important messaging events, such as newly received messages or newly issued credit for sending messages.
|
pure virtual |
If true, stop the container when all active connections and listeners are closed.
If false the container will keep running till stop() is called.
auto_stop is set by default when a new container is created.
Implemented in default_container.
|
pure virtual |
Connection options that will be to outgoing connections.
These are applied first and overriden by options provided in connect() and messaging_handler::on_connection_open().
Implemented in default_container, and container_impl_base.
|
pure virtual |
Connection options that will be to outgoing connections.
These are applied first and overriden by options provided in connect() and messaging_handler::on_connection_open().
Implemented in default_container, and container_impl_base.
|
pure virtual |
Connect to url
and send an open request to the remote peer.
Options are applied to the connection as follows, values in later options override earlier ones:
The handler in the composed options is used to call proton::messaging_handler::on_connection_open() when the remote peer's open response is received.
Implemented in default_container.
|
pure virtual |
Start listening on url.
Calls to the listen_handler are serialized for this listener, but handlers attached to separate listeners may be called concurrently.
url | identifies a listening url. |
lh | handles listening events |
Implemented in default_container.
|
virtual |
Listen with a fixed set of options for all accepted connections.
|
virtual |
Start listening on URL.
New connections will use the handler from server_connection_options()
|
virtual |
Open a connection and receiver for url
.
Any supplied receiver options will override the container's template options.
|
pure virtual |
Open a connection and receiver for url
.
Any supplied receiver or connection options will override the container's template options.
Implemented in default_container.
|
virtual |
Open a connection and sender for url
.
Any supplied sender options will override the container's template options.
|
pure virtual |
Open a connection and sender for url
.
Any supplied sender or connection options will override the container's template options.
Implemented in default_container.
|
pure virtual |
Receiver options applied to receivers created by this container.
They are applied before messaging_handler::on_receiver_open() and can be overridden.
Implemented in default_container, and container_impl_base.
|
pure virtual |
Receiver options applied to receivers created by this container.
They are applied before messaging_handler::on_receiver_open() and can be overridden.
Implemented in default_container, and container_impl_base.
|
pure virtual |
Run the container in this thread.
Returns when the container stops.
With a multithreaded container, call run() in multiple threads to create a thread pool.
Implemented in default_container.
|
pure virtual |
Sender options applied to senders created by this container.
They are applied before messaging_handler::on_sender_open() and can be overridden.
Implemented in default_container, and container_impl_base.
|
pure virtual |
Sender options applied to senders created by this container.
They are applied before messaging_handler::on_sender_open() and can be overridden.
Implemented in default_container, and container_impl_base.
|
pure virtual |
Connection options that will be applied to incoming connections.
These are applied first and overridden by options provided in listen(), listen_handler::on_accept() and messaging_handler::on_connection_open().
Implemented in default_container, and container_impl_base.
|
pure virtual |
Connection options that will be applied to incoming connections.
These are applied first and overridden by options provided in listen(), listen_handler::on_accept() and messaging_handler::on_connection_open().
Implemented in default_container, and container_impl_base.
|
pure virtual |
Experimental - Stop the container with an optional error_condition err.
!err.empty()
, handlers will receive on_transport_errorImplemented in default_container.