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
|
#ifndef _client_Connection_
#define _client_Connection_
/*
*
* 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 <map>
#include <string>
#include "ConnectionImpl.h"
#include "qpid/client/Session.h"
#include "qpid/framing/AMQP_HighestVersion.h"
namespace qpid {
/**
* The client namespace contains all classes that make up a client
* implementation of the AMQP protocol. The key classes that form
* the basis of the client API to be used by applications are
* Connection and Channel.
*/
namespace client {
class ConnectionSettings;
/**
* \defgroup clientapi Application API for an AMQP client.
*/
/**
* Represents a connection to an AMQP broker. All communication is
* initiated by establishing a connection, then opening one or
* more Channels over that connection.
*
* \ingroup clientapi
*/
class Connection
{
framing::ChannelId channelIdCounter;
framing::ProtocolVersion version;
uint16_t max_frame_size;
protected:
boost::shared_ptr<ConnectionImpl> impl;
public:
/**
* Creates a connection object, but does not open the
* connection.
*
* @param _version the version of the protocol to connect with.
*/
Connection(framing::ProtocolVersion=framing::highestProtocolVersion);
~Connection();
/**
* Opens a connection to a broker.
*
* @param host the host on which the broker is running.
*
* @param port the port on the which the broker is listening.
*
* @param uid the userid to connect with.
*
* @param pwd the password to connect with (currently SASL
* PLAIN is the only authentication method supported so this
* is sent in clear text).
*
* @param virtualhost the AMQP virtual host to use (virtual
* hosts, where implemented(!), provide namespace partitioning
* within a single broker).
*/
void open(const std::string& host, int port = 5672,
const std::string& uid = "guest",
const std::string& pwd = "guest",
const std::string& virtualhost = "/", uint16_t maxFrameSize=65535);
/**
* Opens a connection to a broker.
*
* @param the settings to use (host, port etc) @see ConnectionSettings
*/
void open(const ConnectionSettings& settings);
/**
* Close the connection.
*
* Any further use of this connection (without reopening it) will
* not succeed.
*/
void close();
/**
* Create a new session on this connection. Sessions allow
* multiple streams of work to be multiplexed over the same
* connection.
*
*@param name: A name to identify the session. @see qpid::SessionId
* If the name is empty (the default) then a unique name will be
* chosen using a Universally-unique identifier (UUID) algorithm.
*/
Session newSession(const std::string& name=std::string());
/**
* Resume a suspended session. A session may be resumed
* on a different connection to the one that created it.
*/
void resume(Session& session);
};
}} // namespace qpid::client
#endif
|
