summaryrefslogtreecommitdiff
path: root/src/mongo/executor/downconvert_find_and_getmore_commands.h
blob: dea13150dddbc7afb325e4adcbb24553c5bf6a11 (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
/**
 *    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.
 */

#include <cstdint>
#include <memory>

namespace mongo {

class Message;

template <typename T>
class StatusWith;

class StringData;
class NamespaceString;

namespace executor {
struct RemoteCommandRequest;
struct RemoteCommandResponse;

/**
 * Downconverts a find command request to the legacy (non-command) OP_QUERY format. The returned
 * message is formed, with the exception of the messageId header field, which must be set by
 * the caller before sending the message over the wire. Note that our legacy socket code sets the
 * messageId in MessagingPort::say().
 */
StatusWith<Message> downconvertFindCommandRequest(const RemoteCommandRequest& request);

/**
 * Upconverts the OP_REPLY received in response to a legacy OP_QUERY to a semantically equivalent
 * find command response. The 'requestId' parameter is the messageId of the original OP_QUERY, and
 * the 'cursorNamespace' is the full namespace of the collection the query ran on.
 */
StatusWith<RemoteCommandResponse> upconvertLegacyQueryResponse(std::uint32_t requestId,
                                                               StringData cursorNamespace,
                                                               const Message& response);

/**
 * Downconverts a getMore command request to the legacy OP_GET_MORE format. The returned message
 * is fully formed, with the exception of the messageId header field, which must be set by the
 * the caller before sending the message over the wire. Note that our legacy socket code sets the
 * messageId in MessagingPort::say().
 */
StatusWith<Message> downconvertGetMoreCommandRequest(const RemoteCommandRequest& request);

/**
 * Upconverts the OP_REPLY received in response to a legacy OP_GET_MORE to a semantically equivalent
 * getMore command response. The 'requestId' parameter is the messageId of the original OP_GET_MORE,
 * and the 'curesorNamespace' is the full namespace of the collection the original query ran on.
 */
StatusWith<RemoteCommandResponse> upconvertLegacyGetMoreResponse(std::uint32_t requestId,
                                                                 StringData cursorNamespace,
                                                                 const Message& response);

}  // namespace mongo
}  // namespace executor