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
|
/**
* Copyright (C) 2017 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 <string>
#include "mongo/base/status_with.h"
#include "mongo/db/logical_session_id_gen.h"
#include "mongo/util/uuid.h"
namespace mongo {
class BSONObjBuilder;
/**
* A 128-bit identifier for a logical session.
*/
class LogicalSessionId : public Logical_session_id {
public:
friend class Logical_session_id;
friend class Logical_session_record;
/**
* Create and return a new LogicalSessionId with a random UUID.
*/
static LogicalSessionId gen();
/**
* If the given string represents a valid LogicalSessionId, constructs and returns,
* the id, otherwise returns an error.
*/
static StatusWith<LogicalSessionId> parse(const std::string& s);
/**
* Constructs a new LogicalSessionId out of a BSONObj. For IDL.
*/
static LogicalSessionId parse(const BSONObj& doc);
/**
* Returns a string representation of this session id.
*/
std::string toString() const;
/**
* Serialize this object to BSON.
*/
BSONObj toBSON() const;
inline bool operator==(const LogicalSessionId& rhs) const {
return getId() == rhs.getId();
}
inline bool operator!=(const LogicalSessionId& rhs) const {
return !(*this == rhs);
}
/**
* Custom hasher so LogicalSessionIds can be used in unordered data structures.
*
* ex: std::unordered_set<LogicalSessionId, LogicalSessionId::Hash> lsidSet;
*/
struct Hash {
std::size_t operator()(const LogicalSessionId& lsid) const {
return _hasher(lsid.getId());
}
private:
UUID::Hash _hasher;
};
/**
* This constructor exists for IDL only.
*/
LogicalSessionId();
private:
/**
* Construct a LogicalSessionId from a UUID.
*/
LogicalSessionId(UUID id);
};
inline std::ostream& operator<<(std::ostream& s, const LogicalSessionId& lsid) {
return (s << lsid.toString());
}
inline StringBuilder& operator<<(StringBuilder& s, const LogicalSessionId& lsid) {
return (s << lsid.toString());
}
} // namespace mongo
|
