summaryrefslogtreecommitdiff
path: root/src/mongo/db/dbdirectclient.h
blob: 835b63eab46bc66b5693f901959ddb7118a07fb6 (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
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
/**
 *    Copyright (C) 2014 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/client/dbclientinterface.h"
#include "mongo/db/dbmessage.h"
#include "mongo/util/net/hostandport.h"

namespace mongo {

    class OperationContext;

    /**
     * Embedded calls to the local server using the DBClientBase API without going over the network.
     *
     * Caller does not need to lock, that is handled within.
     *
     * All operations are performed within the scope of a passed-in OperationContext (except when
     * using the deprecated constructor). You must ensure that the OperationContext is valid when
     * calling into any function. If you ever need to change the OperationContext, that can be done
     * without the overhead of creating a new DBDirectClient by calling setOpCtx(), after which all
     * operations will use the new OperationContext.
     */
    class DBDirectClient : public DBClientBase {
    public:
        static const HostAndPort dummyHost;

        DBDirectClient(OperationContext* txn);

        using DBClientBase::query;

        // XXX: is this valid or useful?
        void setOpCtx(OperationContext* txn);

        virtual std::unique_ptr<DBClientCursor> query(const std::string &ns,
                                                    Query query,
                                                    int nToReturn = 0,
                                                    int nToSkip = 0,
                                                    const BSONObj* fieldsToReturn = 0,
                                                    int queryOptions = 0,
                                                    int batchSize = 0);

        virtual bool isFailed() const;

        virtual bool isStillConnected();

        virtual std::string toString() const;

        virtual std::string getServerAddress() const;

        virtual bool call(Message& toSend,
                          Message& response,
                          bool assertOk = true,
                          std::string* actualServer = 0);

        virtual void say(Message& toSend,
                         bool isRetry = false,
                         std::string* actualServer = 0);

        virtual void sayPiggyBack(Message& toSend);

        virtual void killCursor(long long cursorID);

        virtual bool callRead(Message& toSend, Message& response);
        
        virtual unsigned long long count(const std::string &ns,
                                         const BSONObj& query = BSONObj(),
                                         int options = 0,
                                         int limit = 0,
                                         int skip = 0);
        
        virtual ConnectionString::ConnectionType type() const;

        double getSoTimeout() const;

        virtual bool lazySupported() const;

        virtual QueryOptions _lookupAvailableOptions();

    private:
        OperationContext* _txn;
    };

}  // namespace mongo