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
|
/**
* 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 <tuple>
#include "mongo/base/status_with.h"
#include "mongo/stdx/functional.h"
namespace mongo {
class BSONObj;
class BSONObjBuilder;
class OperationContext;
class StringData;
/**
* Utilities for converting metadata between the legacy OP_QUERY format and the new
* OP_COMMAND format.
*/
namespace rpc {
/**
* Returns an empty metadata object.
*/
BSONObj makeEmptyMetadata();
/**
* Reads metadata from a metadata object and sets it on this OperationContext.
*/
Status readRequestMetadata(OperationContext* opCtx, const BSONObj& metadataObj);
/**
* Writes metadata from an OperationContext to a metadata object.
*/
Status writeRequestMetadata(OperationContext* opCtx, BSONObjBuilder* metadataBob);
/**
* A command object and a corresponding metadata object.
*/
using CommandAndMetadata = std::tuple<BSONObj, BSONObj>;
/**
* A legacy command object and a corresponding query flags bitfield. The legacy command object
* may contain metadata fields, so it cannot safely be passed to a command's run method.
*/
using LegacyCommandAndFlags = std::tuple<BSONObj, int>;
/**
* Given a legacy command object and a query flags bitfield, attempts to parse and remove
* the metadata from the command object and construct a corresponding metadata object.
*/
StatusWith<CommandAndMetadata> upconvertRequestMetadata(BSONObj legacyCmdObj, int queryFlags);
/**
* Given a command object and a metadata object, attempts to construct a legacy command
* object and query flags bitfield augmented with the given metadata.
*/
StatusWith<LegacyCommandAndFlags> downconvertRequestMetadata(BSONObj cmdObj, BSONObj metadata);
/**
* A command reply and associated metadata object.
*/
using CommandReplyWithMetadata = std::tuple<BSONObj, BSONObj>;
/**
* Given a legacy command reply, attempts to strip the metadata from the reply and construct
* a metadata object.
*/
StatusWith<CommandReplyWithMetadata> upconvertReplyMetadata(const BSONObj& legacyReply);
/**
* Given a command reply object and an associated metadata object,
* attempts to construct a legacy command object.
*/
StatusWith<BSONObj> downconvertReplyMetadata(const BSONObj& commandReply,
const BSONObj& replyMetadata);
/**
* A function type for writing request metadata. The function takes a pointer to an optional
* OperationContext so metadata associated with a Client can be appended, a pointer to a
* BSONObjBuilder used to construct the metadata object and the server address of the target of the
* request and returns a Status indicating if the metadata was written successfully.
*/
using RequestMetadataWriter =
stdx::function<Status(OperationContext*, BSONObjBuilder*, StringData)>;
/**
* A function type for reading reply metadata. The function takes a a reference to a
* metadata object received in a command reply and the server address of the
* host that executed the command and returns a Status indicating if the
* metadata was read successfully.
*
* TODO: would it be a layering violation if this hook took an OperationContext* ?
*/
using ReplyMetadataReader = stdx::function<Status(const BSONObj&, StringData)>;
} // namespace rpc
} // namespace mongo
|
