Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET Apache Qpid Documentation
Public Member Functions | Public Attributes
qpid::client::ConnectionSettings Struct Reference

Settings for a Connection. More...

#include <qpid/client/ConnectionSettings.h>

List of all members.

Public Member Functions

 ConnectionSettings ()
virtual ~ConnectionSettings ()
virtual void configureSocket (qpid::sys::Socket &) const
 Allows socket to be configured; default only sets tcp-nodelay based on the flag set.

Public Attributes

std::string protocol
 The protocol used for the connection (defaults to 'tcp')
std::string host
 The host (or ip address) to connect to (defaults to 'localhost').
uint16_t port
 The port to connect to (defaults to 5672).
std::string virtualhost
 Allows an AMQP 'virtual host' to be specified for the connection.
std::string username
 The username to use when authenticating the connection.
std::string password
 The password to use when authenticating the connection.
std::string mechanism
 The SASL mechanism to use when authenticating the connection; the options are currently PLAIN or ANONYMOUS.
std::string locale
 Allows a locale to be specified for the connection.
uint16_t heartbeat
 Allows a heartbeat frequency to be specified.
uint16_t maxChannels
 The maximum number of channels that the client will request for use on this connection.
uint16_t maxFrameSize
 The maximum frame size that the client will request for this connection.
unsigned int bounds
 Limit the size of the connections send buffer .
bool tcpNoDelay
 If true, TCP_NODELAY will be set for the connection.
std::string service
 SASL service name.
unsigned int minSsf
 Minimum acceptable strength of any SASL negotiated security layer.
unsigned int maxSsf
 Maximum acceptable strength of any SASL negotiated security layer.
std::string sslCertName
 SSL cert-name for the connection.

Detailed Description

Settings for a Connection.

Definition at line 40 of file ConnectionSettings.h.


Constructor & Destructor Documentation

qpid::client::ConnectionSettings::ConnectionSettings ( )
virtual qpid::client::ConnectionSettings::~ConnectionSettings ( ) [virtual]

Member Function Documentation

virtual void qpid::client::ConnectionSettings::configureSocket ( qpid::sys::Socket &  ) const [virtual]

Allows socket to be configured; default only sets tcp-nodelay based on the flag set.

Can be overridden.


Member Data Documentation

Limit the size of the connections send buffer .

The buffer is limited to bounds * maxFrameSize.

Definition at line 106 of file ConnectionSettings.h.

Allows a heartbeat frequency to be specified.

Definition at line 91 of file ConnectionSettings.h.

The host (or ip address) to connect to (defaults to 'localhost').

Definition at line 59 of file ConnectionSettings.h.

Allows a locale to be specified for the connection.

Definition at line 87 of file ConnectionSettings.h.

The maximum number of channels that the client will request for use on this connection.

Definition at line 96 of file ConnectionSettings.h.

The maximum frame size that the client will request for this connection.

Definition at line 101 of file ConnectionSettings.h.

Maximum acceptable strength of any SASL negotiated security layer.

0 means no security layer allowed.

Definition at line 124 of file ConnectionSettings.h.

The SASL mechanism to use when authenticating the connection; the options are currently PLAIN or ANONYMOUS.

Definition at line 83 of file ConnectionSettings.h.

Minimum acceptable strength of any SASL negotiated security layer.

0 means no security layer required.

Definition at line 119 of file ConnectionSettings.h.

The password to use when authenticating the connection.

Definition at line 78 of file ConnectionSettings.h.

The port to connect to (defaults to 5672).

Definition at line 63 of file ConnectionSettings.h.

The protocol used for the connection (defaults to 'tcp')

Definition at line 54 of file ConnectionSettings.h.

SASL service name.

Definition at line 114 of file ConnectionSettings.h.

SSL cert-name for the connection.

Overrides global SSL settings. Used only when a client connects to the broker.

Definition at line 129 of file ConnectionSettings.h.

If true, TCP_NODELAY will be set for the connection.

Definition at line 110 of file ConnectionSettings.h.

The username to use when authenticating the connection.

If not specified the current users login is used if available.

Definition at line 74 of file ConnectionSettings.h.

Allows an AMQP 'virtual host' to be specified for the connection.

Definition at line 68 of file ConnectionSettings.h.


The documentation for this struct 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