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
|
/**
* Copyright (C) 2014-2015 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/disallow_copying.h"
#include "mongo/executor/task_executor.h"
#include "mongo/stdx/functional.h"
namespace mongo {
namespace executor {
/**
* Interface to networking for use by TaskExecutor implementations.
*/
class NetworkInterface {
MONGO_DISALLOW_COPYING(NetworkInterface);
public:
// A flag to keep replication MessagingPorts open when all other sockets are disconnected.
static const unsigned int kMessagingPortKeepOpen = 1;
using Response = RemoteCommandResponse;
using RemoteCommandCompletionFn =
stdx::function<void (const TaskExecutor::ResponseStatus&)>;
virtual ~NetworkInterface();
/**
* Returns diagnostic info.
*/
virtual std::string getDiagnosticString() = 0;
/**
* Starts up the network interface.
*
* It is valid to call all methods except shutdown() before this method completes. That is,
* implementations may not assume that startup() completes before startCommand() first
* executes.
*
* Called by the owning TaskExecutor inside its run() method.
*/
virtual void startup() = 0;
/**
* Shuts down the network interface. Must be called before this instance gets deleted,
* if startup() is called.
*
* Called by the owning TaskExecutor inside its run() method.
*/
virtual void shutdown() = 0;
/**
* Blocks the current thread (presumably the executor thread) until the network interface
* knows of work for the executor to perform.
*/
virtual void waitForWork() = 0;
/**
* Similar to waitForWork, but only blocks until "when".
*/
virtual void waitForWorkUntil(Date_t when) = 0;
/**
* Signals to the network interface that there is new work (such as a signaled event) for
* the executor to process. Wakes the executor from waitForWork() and friends.
*/
virtual void signalWorkAvailable() = 0;
/**
* Returns the current time.
*/
virtual Date_t now() = 0;
/**
* Starts asynchronous execution of the command described by "request".
*/
virtual void startCommand(const TaskExecutor::CallbackHandle& cbHandle,
const RemoteCommandRequest& request,
const RemoteCommandCompletionFn& onFinish) = 0;
/**
* Requests cancelation of the network activity associated with "cbHandle" if it has not yet
* completed.
*/
virtual void cancelCommand(const TaskExecutor::CallbackHandle& cbHandle) = 0;
protected:
NetworkInterface();
};
} // namespace executor
} // namespace mongo
|
