Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET | Apache Qpid Documentation |
#include <qmf/engine/ConnectionSettings.h>
Public Member Functions | |
QMFE_EXTERN | ConnectionSettings () |
Create a set of default connection settings. | |
QMFE_EXTERN | ConnectionSettings (const char *url) |
Create a set of connection settings by URL. | |
ConnectionSettings (const ConnectionSettings &from) | |
Copy Constructor. | |
QMFE_EXTERN | ~ConnectionSettings () |
Destroy the connection settings object. | |
QMFE_EXTERN bool | setAttr (const char *key, const Value &value) |
Set an attribute to control connection setup. | |
QMFE_EXTERN Value | getAttr (const char *key) const |
Get the value of an attribute. | |
QMFE_EXTERN const char * | getAttrString () const |
Get the attribute string (the portion of the URL following the '?') for the settings. | |
QMFE_EXTERN void | transportTcp (uint16_t port=5672) |
Shortcuts for setting the transport for the connection. | |
QMFE_EXTERN void | transportSsl (uint16_t port=5671) |
QMFE_EXTERN void | transportRdma (uint16_t port=5672) |
QMFE_EXTERN void | authAnonymous (const char *username=0) |
Shortcuts for setting authentication mechanisms. | |
QMFE_EXTERN void | authPlain (const char *username=0, const char *password=0) |
QMFE_EXTERN void | authGssapi (const char *serviceName, uint32_t minSsf=0, uint32_t maxSsf=256) |
QMFE_EXTERN void | setRetry (int delayMin=1, int delayMax=128, int delayFactor=2) |
Shortcut for setting connection retry attributes. |
Definition at line 37 of file ConnectionSettings.h.
QMFE_EXTERN qmf::engine::ConnectionSettings::ConnectionSettings | ( | ) |
Create a set of default connection settings.
If no further attributes are set, the settings will cause a connection to be made to the default broker (on localhost or at a host/port supplied by service discovery) and authentication will be the best-available (GSSAPI/Kerberos, Anonymous, Plain with prompts for username and password).
QMFE_EXTERN qmf::engine::ConnectionSettings::ConnectionSettings | ( | const char * | url | ) |
Create a set of connection settings by URL.
url | Universal resource locator describing the broker address and additional attributes. |
For example: amqp://localhost amqp://broker?transport=rdma&authmech=GSSAPI&authservice=qpidd amqps://broker?authmech=PLAIN&authuser=guest&authpass=guest
qmf::engine::ConnectionSettings::ConnectionSettings | ( | const ConnectionSettings & | from | ) |
Copy Constructor.
QMFE_EXTERN qmf::engine::ConnectionSettings::~ConnectionSettings | ( | ) |
Destroy the connection settings object.
QMFE_EXTERN void qmf::engine::ConnectionSettings::authAnonymous | ( | const char * | username = 0 |
) |
Shortcuts for setting authentication mechanisms.
username | Null-terminated authentication user name. | |
password | Null-terminated authentication password. | |
serviceName | Null-terminated GSSAPI service name (Kerberos service principal) | |
minSsf | Minimum security factor for connections. 0 = encryption not required. | |
maxSsf | Maximum security factor for connections. 0 = encryption not permitted. |
QMFE_EXTERN void qmf::engine::ConnectionSettings::authGssapi | ( | const char * | serviceName, | |
uint32_t | minSsf = 0 , |
|||
uint32_t | maxSsf = 256 | |||
) |
QMFE_EXTERN void qmf::engine::ConnectionSettings::authPlain | ( | const char * | username = 0 , |
|
const char * | password = 0 | |||
) |
QMFE_EXTERN Value qmf::engine::ConnectionSettings::getAttr | ( | const char * | key | ) | const |
Get the value of an attribute.
key | A null-terminated attribute name. |
QMFE_EXTERN const char* qmf::engine::ConnectionSettings::getAttrString | ( | ) | const |
Get the attribute string (the portion of the URL following the '?') for the settings.
QMFE_EXTERN bool qmf::engine::ConnectionSettings::setAttr | ( | const char * | key, | |
const Value & | value | |||
) |
Set an attribute to control connection setup.
key | A null-terminated string that is an attribute name. | |
value | Reference to a value to be stored as the attribute. The type of the value is specific to the key. |
QMFE_EXTERN void qmf::engine::ConnectionSettings::setRetry | ( | int | delayMin = 1 , |
|
int | delayMax = 128 , |
|||
int | delayFactor = 2 | |||
) |
Shortcut for setting connection retry attributes.
delayMin | Minimum delay (in seconds) between connection attempts. | |
delaxMax | Maximum delay (in seconds) between connection attempts. | |
delayFactor | Factor to multiply the delay by between failed connection attempts. |
QMFE_EXTERN void qmf::engine::ConnectionSettings::transportRdma | ( | uint16_t | port = 5672 |
) |
QMFE_EXTERN void qmf::engine::ConnectionSettings::transportSsl | ( | uint16_t | port = 5671 |
) |
QMFE_EXTERN void qmf::engine::ConnectionSettings::transportTcp | ( | uint16_t | port = 5672 |
) |
Shortcuts for setting the transport for the connection.
port | The port value for the connection address. |