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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/**
* Copyright (C) 2016 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <memory>
#include "mongo/base/disallow_copying.h"
#include "mongo/transport/message_compressor_manager.h"
#include "mongo/transport/session_id.h"
#include "mongo/transport/ticket.h"
#include "mongo/util/net/hostandport.h"
#include "mongo/util/net/message.h"
#include "mongo/util/time_support.h"
namespace mongo {
struct SSLPeerInfo;
namespace transport {
class TransportLayer;
class Session;
using SessionHandle = std::shared_ptr<Session>;
using ConstSessionHandle = std::shared_ptr<const Session>;
/**
* This type contains data needed to associate Messages with connections
* (on the transport side) and Messages with Client objects (on the database side).
*/
class Session : public std::enable_shared_from_this<Session> {
MONGO_DISALLOW_COPYING(Session);
public:
/**
* Type to indicate the internal id for this session.
*/
using Id = SessionId;
/**
* Tags for groups of connections.
*/
using TagMask = uint32_t;
static const Status ClosedStatus;
static constexpr TagMask kEmptyTagMask = 0;
static constexpr TagMask kKeepOpen = 1;
/**
* Destroys a session, calling end() for this session in its TransportLayer.
*/
~Session();
/**
* A factory for sessions.
*/
static SessionHandle create(HostAndPort remote, HostAndPort local, TransportLayer* tl);
/**
* Return the id for this session.
*/
Id id() const {
return _id;
}
/**
* Return the remote host for this session.
*/
const HostAndPort& remote() const {
return _remote;
}
/**
* Return the local host information for this session.
*/
const HostAndPort& local() const {
return _local;
}
/**
* Return the X509 peer information for this connection (SSL only).
*/
SSLPeerInfo getX509PeerInfo() const;
/**
* Set this session's tags. This Session will register
* its new tags with its TransportLayer.
*/
void replaceTags(TagMask tags);
/**
* Get this session's tags.
*/
TagMask getTags() const {
return _tags;
}
/**
* Source (receive) a new Message for this Session.
*
* This method will forward to sourceMessage on this Session's transport layer.
*/
Ticket sourceMessage(Message* message, Date_t expiration = Ticket::kNoExpirationDate);
/**
* Sink (send) a new Message for this Session. This method should be used
* to send replies to a given host.
*
* This method will forward to sinkMessage on this Session's transport layer.
*/
Ticket sinkMessage(const Message& message, Date_t expiration = Ticket::kNoExpirationDate);
/**
* The TransportLayer for this Session.
*/
TransportLayer* getTransportLayer() const {
return _tl;
}
MessageCompressorManager& getCompressorManager() {
return _messageCompressorManager;
}
private:
/**
* Construct a new session.
*/
Session(HostAndPort remote, HostAndPort local, TransportLayer* tl);
Id _id;
HostAndPort _remote;
HostAndPort _local;
TagMask _tags;
TransportLayer* _tl;
MessageCompressorManager _messageCompressorManager;
};
} // namespace transport
} // namespace mongo
|
