blob: ac0514dc64f7ac45d5036ff2bf563b9bb0a7ab37 (
plain)
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
|
/**
* Copyright (C) 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 "mongo/base/disallow_copying.h"
#include "mongo/rpc/protocol.h"
namespace mongo {
class BSONObj;
class Message;
namespace rpc {
class DocumentRange;
/**
* An immutable view of an RPC Reply.
*/
class ReplyInterface {
MONGO_DISALLOW_COPYING(ReplyInterface);
public:
virtual ~ReplyInterface() = default;
/**
* Accessor for the metadata object. Metadata is generally used for information
* that is independent of any specific command, e.g. auditing information.
*/
virtual const BSONObj& getMetadata() const = 0;
/**
* The result of executing the command.
*/
virtual const BSONObj& getCommandReply() const = 0;
/**
* A variable number of BSON documents returned by the command. It is valid for the
* returned range to be empty.
*
* Example usage:
*
* for (auto&& doc : reply.getOutputDocs()) {
* ... do stuff with doc
* }
*/
virtual DocumentRange getOutputDocs() const = 0;
/**
* Gets the protocol used to deserialize this reply. This should be used for validity
* checks only - runtime behavior changes should be implemented with polymorphism.
*/
virtual Protocol getProtocol() const = 0;
protected:
ReplyInterface() = default;
};
} // namespace rpc
} // namespace mongo
|
