qpid::messaging::Connection Class Reference
[Qpid C++ Client API]
A connection represents a network connection to a remote endpoint.
More...
#include <qpid/messaging/Connection.h>
List of all members.
Detailed Description
A connection represents a network connection to a remote endpoint.
Definition at line 45 of file Connection.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| qpid::messaging::Connection::Connection |
( |
ConnectionImpl * |
impl |
) |
|
| qpid::messaging::Connection::Connection |
( |
const Connection & |
|
) |
|
| qpid::messaging::Connection::Connection |
( |
|
) |
|
Current implementation supports the following options:.
- username
- password
- heartbeat
- tcp_nodelay
- sasl_mechanisms
- sasl_service
- sasl_min_ssf
- sasl_max_ssf
- transport
Reconnect behaviour can be controlled through the following options:
- reconnect: true/false (enables/disables reconnect entirely)
- reconnect_timeout: seconds (give up and report failure after specified time)
- reconnect_limit: n (give up and report failure after specified number of attempts)
- reconnect_interval_min: seconds (initial delay between failed reconnection attempts)
- reconnect_interval_max: seconds (maximum delay between failed reconnection attempts)
- reconnect_interval: shorthand for setting the same reconnect_interval_min/max
- reconnect_urls: list of alternate urls to try when connecting
The reconnect_interval is the time that the client waits for after a failed attempt to reconnect before retrying. It starts at the value of the min_retry_interval and is doubled every failure until the value of max_retry_interval is reached.
Values in seconds can be fractional, for example 0.001 is a millisecond delay.
| qpid::messaging::Connection::Connection |
( |
const std::string & |
url, |
|
|
const std::string & |
options | |
|
) |
| | |
Creates a connection using an option string of the form {name:value,name2:value2.
..}, see above for options supported.
- Exceptions:
-
| qpid::messaging::Connection::~Connection |
( |
|
) |
|
Member Function Documentation
| void qpid::messaging::Connection::close |
( |
|
) |
|
Closes a connection and all sessions associated with it.
An opened connection must be closed before the last handle is allowed to go out of scope.
| Session qpid::messaging::Connection::createSession |
( |
const std::string & |
name = std::string() |
) |
|
| Session qpid::messaging::Connection::createTransactionalSession |
( |
const std::string & |
name = std::string() |
) |
|
| std::string qpid::messaging::Connection::getAuthenticatedUsername |
( |
|
) |
|
| Session qpid::messaging::Connection::getSession |
( |
const std::string & |
name |
) |
const |
- Returns:
- true if handle is null. It is an error to call any function on a null handle.
Definition at line 46 of file Handle.h.
| bool qpid::messaging::Connection::isOpen |
( |
|
) |
const |
| bool qpid::messaging::Connection::isOpen |
( |
|
) |
|
- Returns:
- true if handle is valid, i.e. not null.
Definition at line 43 of file Handle.h.
| void qpid::messaging::Connection::open |
( |
|
) |
|
| QPID_MESSAGING_INLINE_EXTERN qpid::messaging::Handle< ConnectionImpl >::operator bool |
( |
|
) |
const [inline, inherited] |
Conversion to bool supports idiom if (handle) { handle->.
.. }
Definition at line 49 of file Handle.h.
| QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< ConnectionImpl >::operator! |
( |
|
) |
const [inline, inherited] |
Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.
Definition at line 52 of file Handle.h.
| void qpid::messaging::Connection::setOption |
( |
const std::string & |
name, |
|
|
const qpid::types::Variant & |
value | |
|
) |
| | |
Member Data Documentation
The documentation for this class was generated from the following file:
