Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation
Public Member Functions | Protected Types | Protected Attributes
qpid::messaging::Connection Class Reference

A connection represents a network connection to a remote endpoint. More...

#include <qpid/messaging/Connection.h>

List of all members.

Public Member Functions

 Connection (ConnectionImpl *impl)
 Connection (const Connection &)
 Connection ()
 Connection (const std::string &url, const qpid::types::Variant::Map &options=qpid::types::Variant::Map())
 Current implementation supports the following options:
 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.
 ~Connection ()
Connectionoperator= (const Connection &)
void setOption (const std::string &name, const qpid::types::Variant &value)
void open ()
bool isOpen ()
bool isOpen () const
void close ()
 Closes a connection and all sessions associated with it.
Session createTransactionalSession (const std::string &name=std::string())
Session createSession (const std::string &name=std::string())
Session getSession (const std::string &name) const
std::string getAuthenticatedUsername ()
QPID_MESSAGING_INLINE_EXTERN bool isValid () const
QPID_MESSAGING_INLINE_EXTERN bool isNull () const
QPID_MESSAGING_INLINE_EXTERN operator bool () const
 Conversion to bool supports idiom if (handle) { handle->...
QPID_MESSAGING_INLINE_EXTERN bool operator! () const
 Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }.
void swap (Handle< ConnectionImpl > &h)

Protected Types

typedef ConnectionImpl Impl

Protected Attributes

Implimpl

Detailed Description

A connection represents a network connection to a remote endpoint.

Definition at line 45 of file Connection.h.


Member Typedef Documentation

typedef ConnectionImpl qpid::messaging::Handle< ConnectionImpl >::Impl [protected, inherited]

Definition at line 57 of file Handle.h.


Constructor & Destructor Documentation

qpid::messaging::Connection::Connection ( ConnectionImpl *  impl)
qpid::messaging::Connection::Connection ( const Connection )
qpid::messaging::Connection::Connection ( )
qpid::messaging::Connection::Connection ( const std::string &  url,
const qpid::types::Variant::Map options = qpid::types::Variant::Map() 
)

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: 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::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:
InvalidOptionStringif the string does not match the correct syntax
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
QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< ConnectionImpl >::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 ( ) const
bool qpid::messaging::Connection::isOpen ( )
QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< ConnectionImpl >::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< 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.

Connection& qpid::messaging::Connection::operator= ( const Connection )
void qpid::messaging::Connection::setOption ( const std::string &  name,
const qpid::types::Variant value 
)
void qpid::messaging::Handle< ConnectionImpl >::swap ( Handle< ConnectionImpl > &  h) [inline, inherited]

Definition at line 54 of file Handle.h.


Member Data Documentation

Impl* qpid::messaging::Handle< ConnectionImpl >::impl [protected, inherited]

Definition at line 64 of file Handle.h.


The documentation for this class was generated from the following file:

Qpid C++ API Reference
Generated on Mon Aug 22 2011 for Qpid C++ Client API by doxygen 1.7.4