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
|
/**
* 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 "mongo/base/status.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/platform/bitwise_enum_operators.h"
#include "mongo/stdx/functional.h"
#include "mongo/transport/service_executor_task_names.h"
#include "mongo/transport/transport_mode.h"
#include "mongo/util/duration.h"
namespace mongo {
// This needs to be forward declared here because the service_context.h is a circular dependency.
class ServiceContext;
namespace transport {
/*
* This is the interface for all ServiceExecutors.
*/
class ServiceExecutor {
public:
virtual ~ServiceExecutor() = default;
using Task = stdx::function<void()>;
enum ScheduleFlags {
// No flags (kEmptyFlags) specifies that this is a normal task and that the executor should
// launch new threads as needed to run the task.
kEmptyFlags = 1 << 0,
// Deferred tasks will never get a new thread launched to run them.
kDeferredTask = 1 << 1,
// MayRecurse indicates that a task may be run recursively.
kMayRecurse = 1 << 2,
// MayYieldBeforeSchedule indicates that the executor may yield on the current thread before
// scheduling the task.
kMayYieldBeforeSchedule = 1 << 3,
};
/*
* Starts the ServiceExecutor. This may create threads even if no tasks are scheduled.
*/
virtual Status start() = 0;
/*
* Schedules a task with the ServiceExecutor and returns immediately.
*
* This is guaranteed to unwind the stack before running the task, although the task may be
* run later in the same thread.
*
* If defer is true, then the executor may defer execution of this Task until an available
* thread is available.
*/
virtual Status schedule(Task task, ScheduleFlags flags, ServiceExecutorTaskName taskName) = 0;
/*
* Stops and joins the ServiceExecutor. Any outstanding tasks will not be executed, and any
* associated callbacks waiting on I/O may get called with an error code.
*
* This should only be called during server shutdown to gracefully destroy the ServiceExecutor
*/
virtual Status shutdown(Milliseconds timeout) = 0;
/*
* Returns if this service executor is using asynchronous or synchronous networking.
*/
virtual Mode transportMode() const = 0;
/*
* Appends statistics about task scheduling to a BSONObjBuilder for serverStatus output.
*/
virtual void appendStats(BSONObjBuilder* bob) const = 0;
};
} // namespace transport
ENABLE_BITMASK_OPERATORS(transport::ServiceExecutor::ScheduleFlags)
} // namespace mongo
|
