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.
framing::FieldTable clientProperties
 Passed as client-propreties on opening the connecction.

Detailed Description

Settings for a Connection.

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

unsigned int qpid::client::ConnectionSettings::bounds

Limit the size of the connections send buffer .

The buffer is limited to bounds * maxFrameSize.

Definition at line 107 of file ConnectionSettings.h.

framing::FieldTable qpid::client::ConnectionSettings::clientProperties

Passed as client-propreties on opening the connecction.

Definition at line 135 of file ConnectionSettings.h.

uint16_t qpid::client::ConnectionSettings::heartbeat

Allows a heartbeat frequency to be specified.

Definition at line 92 of file ConnectionSettings.h.

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

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

Definition at line 60 of file ConnectionSettings.h.

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

Allows a locale to be specified for the connection.

Definition at line 88 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 97 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 102 of file ConnectionSettings.h.

unsigned int qpid::client::ConnectionSettings::maxSsf

Maximum acceptable strength of any SASL negotiated security layer.

0 means no security layer allowed.

Definition at line 125 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 84 of file ConnectionSettings.h.

unsigned int qpid::client::ConnectionSettings::minSsf

Minimum acceptable strength of any SASL negotiated security layer.

0 means no security layer required.

Definition at line 120 of file ConnectionSettings.h.

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

The password to use when authenticating the connection.

Definition at line 79 of file ConnectionSettings.h.

uint16_t qpid::client::ConnectionSettings::port

The port to connect to (defaults to 5672).

Definition at line 64 of file ConnectionSettings.h.

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

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

Definition at line 55 of file ConnectionSettings.h.

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

SASL service name.

Definition at line 115 of file ConnectionSettings.h.

std::string qpid::client::ConnectionSettings::sslCertName

SSL cert-name for the connection.

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

Definition at line 130 of file ConnectionSettings.h.

bool qpid::client::ConnectionSettings::tcpNoDelay

If true, TCP_NODELAY will be set for the connection.

Definition at line 111 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 75 of file ConnectionSettings.h.

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

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

Definition at line 69 of file ConnectionSettings.h.


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

Qpid C++ API Reference
Generated on Tue Jul 2 2013 for Qpid C++ Client API by doxygen 1.8.1.1