Apache Qpid C++ API
Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation

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>

Inherits qpid::messaging::Handle< ConnectionImpl >.

List of all members.

Public Member Functions

QPID_MESSAGING_EXTERN Connection (ConnectionImpl *impl)
QPID_MESSAGING_EXTERN Connection (const Connection &)
QPID_MESSAGING_EXTERN Connection ()
QPID_MESSAGING_EXTERN Connection (const std::string &url, const qpid::types::Variant::Map &options=qpid::types::Variant::Map())
 Current implementation supports the following options:.
QPID_MESSAGING_EXTERN Connection (const std::string &url, const std::string &options)
 Creates a connection using an option string of the form {name:value,name2:value2.
QPID_MESSAGING_EXTERN ~Connection ()
QPID_MESSAGING_EXTERN Connectionoperator= (const Connection &)
QPID_MESSAGING_EXTERN void setOption (const std::string &name, const qpid::types::Variant &value)
QPID_MESSAGING_EXTERN void open ()
QPID_MESSAGING_EXTERN bool isOpen ()
QPID_MESSAGING_EXTERN void close ()
 Closes a connection and all sessions associated with it.
QPID_MESSAGING_EXTERN Session createTransactionalSession (const std::string &name=std::string())
QPID_MESSAGING_EXTERN Session createSession (const std::string &name=std::string())
QPID_MESSAGING_EXTERN Session getSession (const std::string &name) const
QPID_MESSAGING_EXTERN std::string getAuthenticatedUsername ()
QPID_MESSAGING_EXTERN bool isValid () const
QPID_MESSAGING_EXTERN bool isNull () const
QPID_MESSAGING_EXTERN operator bool () const
 Conversion to bool supports idiom if (handle) { handle->.
QPID_MESSAGING_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 43 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_EXTERN qpid::messaging::Connection::Connection ( ConnectionImpl *  impl  ) 

QPID_MESSAGING_EXTERN qpid::messaging::Connection::Connection ( const Connection  ) 

QPID_MESSAGING_EXTERN qpid::messaging::Connection::Connection (  ) 

QPID_MESSAGING_EXTERN 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-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:
InvalidOptionString if the string does not match the correct syntax

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 std::string qpid::messaging::Connection::getAuthenticatedUsername (  ) 

QPID_MESSAGING_EXTERN Session qpid::messaging::Connection::getSession ( const std::string &  name  )  const

QPID_MESSAGING_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.

QPID_MESSAGING_EXTERN bool qpid::messaging::Connection::isOpen (  ) 

QPID_MESSAGING_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.

QPID_MESSAGING_EXTERN void qpid::messaging::Connection::open (  ) 

QPID_MESSAGING_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_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.

QPID_MESSAGING_EXTERN Connection& qpid::messaging::Connection::operator= ( const Connection  ) 

QPID_MESSAGING_EXTERN 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 Wed Feb 8 13:31:06 2012 for Qpid C++ Client API by doxygen 1.4.7