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 43 of file Connection.h.
Member Typedef Documentation
Constructor & Destructor Documentation
QPID_MESSAGING_EXTERN qpid::messaging::Connection::Connection |
( |
ConnectionImpl * |
impl |
) |
|
QPID_MESSAGING_EXTERN qpid::messaging::Connection::Connection |
( |
const Connection & |
|
) |
|
QPID_MESSAGING_EXTERN qpid::messaging::Connection::Connection |
( |
|
) |
|
Current implementation supports the following options:
username password heartbeat tcp-nodelay sasl-mechanism 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: number of 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: number of seconds (initial delay between failed reconnection attempts) reconnect-interval-max: number of 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.
QPID_MESSAGING_EXTERN 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_EXTERN qpid::messaging::Connection::~Connection |
( |
|
) |
|
Member Function Documentation
QPID_MESSAGING_EXTERN 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.
QPID_MESSAGING_EXTERN Session qpid::messaging::Connection::createSession |
( |
const std::string & |
name = std::string() |
) |
|
QPID_MESSAGING_EXTERN Session qpid::messaging::Connection::createTransactionalSession |
( |
const std::string & |
name = std::string() |
) |
|
QPID_MESSAGING_EXTERN 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.
QPID_MESSAGING_EXTERN bool qpid::messaging::Connection::isOpen |
( |
|
) |
|
- Returns:
- true if handle is valid, i.e. not null.
Definition at line 43 of file Handle.h.
QPID_MESSAGING_EXTERN void qpid::messaging::Connection::open |
( |
|
) |
|
Conversion to bool supports idiom if (handle) { handle->...
}
Definition at line 49 of file Handle.h.
Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.
Definition at line 52 of file Handle.h.
QPID_MESSAGING_EXTERN 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: