summaryrefslogtreecommitdiff
path: root/src/mongo/s/client/scc_fast_query_handler.h
blob: c2079e717ff34b605e3080111a2998e2fbd0e203 (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
/**
 *    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/syncclusterconnection.h"
#include "mongo/s/client/multi_host_query.h"

namespace mongo {

/**
 * Query handler that plugs in to a SyncClusterConnection and allows query on fastest host
 * (if enabled).
 *
 * Glue code which shields the MultiHostQuery and server parameters from the separate client
 * module which knows about neither.
 *
 * There is a *single* SCCFastQueryHandler for every SCC.  Each SCCFastQueryHandler contains
 * its own thread pool (lazily initialized) so that at maximum there is a thread-per-SCC-host
 * and this thread may have an open connection to the host until it times out.
 * If using the "fastestConfigReads" options, clients must be ready for the additional thread
 * and connection load when configs are slow.
 */
class SCCFastQueryHandler : public SyncClusterConnection::QueryHandler {
public:
    SCCFastQueryHandler();

    virtual ~SCCFastQueryHandler() {}

    virtual bool canHandleQuery(const std::string& ns, Query query);

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

private:
    // The thread pool itself is scoped to the handler and SCC, and lazily creates threads
    // per-host as needed.  This ensures query starvation cannot occur due to other active
    // client threads - though a thread must be created for every client.
    HostThreadPools _queryThreads;
};
}