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.
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:
- heartbeat: the heartbeat interval in seconds
- tcp_nodelay: true/false, whether nagle should be disabled or not
- transport: the underlying transport to use (e.g. tcp, ssl, rdma)
- protocol: the version of AMQP to use (e.g. amqp0-10 or amqp1.0)
(Note: the transports and/or protocols recognised may depend on which plugins are loaded)
- username: the username to authenticate as
- password: the password to use if required by the selected authentication mechanism
- sasl_mechanisms: a space separated list of acceptable SASL mechanisms
- sasl_min_ssf: the minimum acceptable security strength factor
- sasl_max_ssf: the maximum acceptable security strength factor
- sasl_service: the service name if needed by the SASL mechanism in use
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.
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.
std::string qpid::messaging::Connection::getAuthenticatedUsername |
( |
| ) |
|
QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle::isNull |
( |
| ) |
const [inline, inherited] |
- 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 |
( |
| ) |
|
bool qpid::messaging::Connection::isOpen |
( |
| ) |
const |
QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle::isValid |
( |
| ) |
const [inline, inherited] |
- 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::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::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::Handle::swap |
( |
Handle< T > & |
h | ) |
[inline, inherited] |
Member Data Documentation
The documentation for this class was generated from the following file: