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

qpid::client::ConnectionSettings Struct Reference

Settings for a Connection. More...

#include <ConnectionSettings.h>

Inherited by qpid::client::ConnectionHandler.

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.
uint 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.
uint minSsf
 Minimum acceptable strength of any SASL negotiated security layer.
uint maxSsf
 Maximum acceptable strength of any SASL negotiated security layer.


Detailed Description

Settings for a Connection.

Definition at line 43 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

uint qpid::client::ConnectionSettings::bounds

Limit the size of the connections send buffer .

The buffer is limited to bounds * maxFrameSize.

Definition at line 109 of file ConnectionSettings.h.

uint16_t qpid::client::ConnectionSettings::heartbeat

Allows a heartbeat frequency to be specified.

Definition at line 94 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::host

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

Definition at line 62 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::locale

Allows a locale to be specified for the connection.

Definition at line 90 of file ConnectionSettings.h.

uint16_t qpid::client::ConnectionSettings::maxChannels

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

Definition at line 99 of file ConnectionSettings.h.

uint16_t qpid::client::ConnectionSettings::maxFrameSize

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

Definition at line 104 of file ConnectionSettings.h.

uint qpid::client::ConnectionSettings::maxSsf

Maximum acceptable strength of any SASL negotiated security layer.

0 means no security layer allowed.

Definition at line 127 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::mechanism

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

Definition at line 86 of file ConnectionSettings.h.

uint qpid::client::ConnectionSettings::minSsf

Minimum acceptable strength of any SASL negotiated security layer.

0 means no security layer required.

Definition at line 122 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::password

The password to use when authenticating the connection.

Definition at line 81 of file ConnectionSettings.h.

uint16_t qpid::client::ConnectionSettings::port

The port to connect to (defaults to 5672).

Definition at line 66 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::protocol

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

Definition at line 57 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::service

SASL service name.

Definition at line 117 of file ConnectionSettings.h.

bool qpid::client::ConnectionSettings::tcpNoDelay

If true, TCP_NODELAY will be set for the connection.

Definition at line 113 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::username

The username to use when authenticating the connection.

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

Definition at line 77 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::virtualhost

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

Definition at line 71 of file ConnectionSettings.h.


The documentation for this struct was generated from the following file:
Qpid C++ API Reference
Generated on Tue Dec 8 15:39:37 2009 for Qpid C++ Client API by doxygen 1.4.7