diff options
author | Adam Midvidy <amidvidy@gmail.com> | 2015-05-15 19:22:07 -0400 |
---|---|---|
committer | Adam Midvidy <amidvidy@gmail.com> | 2015-05-18 09:52:09 -0400 |
commit | 4e0acbc7b67c5386a3a9ed60795f9cab672a3262 (patch) | |
tree | a57f1fd8e7021f088f8bfcc91f53bd47aee81e50 /src/mongo/rpc/request_interface.h | |
parent | 4f0e70b66182cbb872c4e5eefda23f1c58bdaab7 (diff) | |
download | mongo-4e0acbc7b67c5386a3a9ed60795f9cab672a3262.tar.gz |
SERVER-18288 implement a common interface for OP_COMMAND and OP_QUERY
Diffstat (limited to 'src/mongo/rpc/request_interface.h')
-rw-r--r-- | src/mongo/rpc/request_interface.h | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/src/mongo/rpc/request_interface.h b/src/mongo/rpc/request_interface.h new file mode 100644 index 00000000000..27f407f3f5c --- /dev/null +++ b/src/mongo/rpc/request_interface.h @@ -0,0 +1,88 @@ +/** + * 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" + +namespace mongo { + class BSONObj; + class Message; + class StringData; + +namespace rpc { + class DocumentRange; + + /** + * An immutable view of an RPC message. + */ + class RequestInterface { + MONGO_DISALLOW_COPYING(RequestInterface); + public: + virtual ~RequestInterface() = default; + + /** + * Gets the database that the command is to be executed on. + */ + virtual StringData getDatabase() const = 0; + + /** + * Gets the name of the command to execute. + */ + virtual StringData getCommandName() const = 0; + + /** + * Gets the metadata associated with the command request. This is information that is + * independent of any specific command, i.e. auditing information. See metadata.h for + * further details. + */ + virtual const BSONObj& getMetadata() const = 0; + + /** + * Gets the arguments to the command - this is passed to the command's run() method. + */ + virtual const BSONObj& getCommandArgs() const = 0; + + /** + * A variable number of BSON documents to pass to the command. It is valid for + * the returned range to be empty. + * + * Example usage: + * + * for (auto&& doc : req.getInputDocs()) { + * ... do stuff with doc + * } + */ + virtual DocumentRange getInputDocs() const = 0; + + protected: + RequestInterface() = default; + }; + +} // namespace rpc +} // namespace mongo |