summaryrefslogtreecommitdiff
path: root/src/mongo/db/client_basic.h
blob: 3fc6409c99d5d0b92b96446f337febd69c930dda (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
/**
*    Copyright (C) 2008 10gen 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 <boost/scoped_ptr.hpp>
#include <memory>

#include "mongo/base/disallow_copying.h"
#include "mongo/util/decorable.h"
#include "mongo/util/net/hostandport.h"
#include "mongo/util/net/message_port.h"

namespace mongo {

    class ServiceContext;

    /**
     * this is the base class for Client and ClientInfo
     * Client is for mongod
     * ClientInfo is for mongos
     * They should converge slowly
     * The idea is this has the basic api so that not all code has to be duplicated
     */
    class ClientBasic : public Decorable<ClientBasic> {
        MONGO_DISALLOW_COPYING(ClientBasic);
    public:
        bool getIsLocalHostConnection() {
            if (!hasRemote()) {
                return false;
            }
            return getRemote().isLocalHost();
        }

        bool hasRemote() const { return _messagingPort; }
        HostAndPort getRemote() const {
            verify( _messagingPort );
            return _messagingPort->remote();
        }

        /**
         * Returns the ServiceContext that owns this client session context.
         */
        ServiceContext* getServiceContext() const { return _serviceContext; }

        /**
         * Returns the AbstractMessagePort to which this client session is bound, if any.
         */
        AbstractMessagingPort * port() const { return _messagingPort; }

        static ClientBasic* getCurrent();

    protected:
        ClientBasic(ServiceContext* serviceContext, AbstractMessagingPort* messagingPort);
        ~ClientBasic();

    private:
        ServiceContext* const _serviceContext;
        AbstractMessagingPort* const _messagingPort;
    };
}