blob: 2b6b86f89107e436d993d35de9d76fe3b2c09ca1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
|
#ifndef QPID_CLIENT_CONNECTIONSETTINGS_H
#define QPID_CLIENT_CONNECTIONSETTINGS_H
/*
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
#include "qpid/client/ClientImportExport.h"
#include "qpid/sys/IntegerTypes.h"
#include <string>
namespace qpid {
namespace sys {
class Socket;
}
namespace client {
/**
* Settings for a Connection.
*/
struct QPID_CLIENT_CLASS_EXTERN ConnectionSettings {
QPID_CLIENT_EXTERN ConnectionSettings();
QPID_CLIENT_EXTERN virtual ~ConnectionSettings();
/**
* Allows socket to be configured; default only sets tcp-nodelay
* based on the flag set. Can be overridden.
*/
QPID_CLIENT_EXTERN virtual void configureSocket(qpid::sys::Socket&) const;
/**
* The protocol used for the connection (defaults to 'tcp')
*/
std::string protocol;
/**
* The host (or ip address) to connect to (defaults to 'localhost').
*/
std::string host;
/**
* The port to connect to (defaults to 5672).
*/
uint16_t port;
/**
* Allows an AMQP 'virtual host' to be specified for the
* connection.
*/
std::string virtualhost;
/**
* The username to use when authenticating the connection. If not
* specified the current users login is used if available.
*/
std::string username;
/**
* The password to use when authenticating the connection.
*/
std::string password;
/**
* The SASL mechanism to use when authenticating the connection;
* the options are currently PLAIN or ANONYMOUS.
*/
std::string mechanism;
/**
* Allows a locale to be specified for the connection.
*/
std::string locale;
/**
* Allows a heartbeat frequency to be specified
*/
uint16_t heartbeat;
/**
* The maximum number of channels that the client will request for
* use on this connection.
*/
uint16_t maxChannels;
/**
* The maximum frame size that the client will request for this
* connection.
*/
uint16_t maxFrameSize;
/**
* Limit the size of the connections send buffer . The buffer
* is limited to bounds * maxFrameSize.
*/
unsigned int bounds;
/**
* If true, TCP_NODELAY will be set for the connection.
*/
bool tcpNoDelay;
/**
* SASL service name
*/
std::string service;
/**
* Minimum acceptable strength of any SASL negotiated security
* layer. 0 means no security layer required.
*/
unsigned int minSsf;
/**
* Maximum acceptable strength of any SASL negotiated security
* layer. 0 means no security layer allowed.
*/
unsigned int maxSsf;
/**
* SSL cert-name for the connection. Overrides global SSL
* settings. Used only when a client connects to the broker.
*/
std::string sslCertName;
};
}} // namespace qpid::client
#endif /*!QPID_CLIENT_CONNECTIONSETTINGS_H*/
|
