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
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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 <limits>
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/db/client.h"
#include "mongo/db/dbmessage.h"
#include "mongo/logv2/log_severity.h"
#include "mongo/transport/session.h"
#include "mongo/util/future.h"
namespace mongo {
/**
* This is the entrypoint from the transport layer into mongod or mongos.
*
* The ServiceEntryPoint accepts new Sessions from the TransportLayer, and is
* responsible for running these Sessions in a get-Message, run-Message,
* reply-with-Message loop. It may not do this on the TransportLayer’s thread.
*/
class ServiceEntryPoint {
ServiceEntryPoint(const ServiceEntryPoint&) = delete;
ServiceEntryPoint& operator=(const ServiceEntryPoint&) = delete;
public:
virtual ~ServiceEntryPoint() = default;
/**
* Begin running a new Session. This method returns immediately.
*/
virtual void startSession(std::shared_ptr<transport::Session> session) = 0;
/**
* End all sessions that do not match the mask in tags.
*/
virtual void endAllSessions(transport::Session::TagMask tags) = 0;
/**
* Starts the service entry point
*/
virtual Status start() = 0;
/**
* Shuts down the service entry point.
*/
virtual bool shutdown(Milliseconds timeout) = 0;
/**
* Append high-level stats to a BSONObjBuilder for serverStatus
*/
virtual void appendStats(BSONObjBuilder* bob) const = 0;
/**
* Returns the number of sessions currently open.
*/
virtual size_t numOpenSessions() const = 0;
/**
* Returns the maximum number of sessions that can be open.
*/
virtual size_t maxOpenSessions() const {
return std::numeric_limits<size_t>::max();
}
/**
* Returns the current severity to log slow SessionWorkflow lifecycles. Returns a suppressed
* severity every X seconds (defined in SEP::impl) to prevent logs from overwhelming the rest
* of the system.
*/
virtual logv2::LogSeverity slowSessionWorkflowLogSeverity() = 0;
/**
* Processes a request and fills out a DbResponse.
*/
virtual Future<DbResponse> handleRequest(OperationContext* opCtx,
const Message& request) noexcept = 0;
/**
* Optional handler which is invoked after a session ends.
*
* This function implies that the Session itself will soon be destructed.
*/
virtual void onEndSession(const std::shared_ptr<transport::Session>&) {}
/**
* Optional handler which is invoked after a client connects.
*/
virtual void onClientConnect(Client* client) {}
/**
* Optional handler which is invoked after a client disconnect. A client disconnect occurs when
* the connection between the mongo process and client is closed for any reason, and is defined
* by the destruction and cleanup of the SessionWorkflow that manages the client.
*/
virtual void onClientDisconnect(Client* client) {}
protected:
ServiceEntryPoint() = default;
};
} // namespace mongo
|
