summaryrefslogtreecommitdiff
path: root/src/mongo/util/net/hostandport.h
blob: 9f0a9de39ee474b8378dc20b862644c073a1f127 (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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*    Copyright 2009 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 <iosfwd>
#include <string>

#include "mongo/bson/util/builder.h"
#include "mongo/platform/hash_namespace.h"

namespace mongo {
    class Status;
    class StringData;
    template <typename T> class StatusWith;

    /**
     * Name of a process on the network.
     *
     * Composed of some name component, followed optionally by a colon and a numeric port.  The name
     * might be an IPv4 or IPv6 address or a relative or fully qualified host name, or an absolute
     * path to a unix socket.
     */
    struct HostAndPort {

        /**
         * Parses "text" to produce a HostAndPort.  Returns either that or an error
         * status describing the parse failure.
         */
        static StatusWith<HostAndPort> parse(const StringData& text);

        /**
         * Construct an empty/invalid HostAndPort.
         */
        HostAndPort();

        /**
         * Constructs a HostAndPort by parsing "text" of the form hostname[:portnumber]
         * Throws an AssertionException if bad config std::string or bad port #.
         */
        explicit HostAndPort(const StringData& text);

        /**
         * Constructs a HostAndPort with the hostname "h" and port "p".
         *
         * If "p" is -1, port() returns ServerGlobalParams::DefaultDBPort.
         */
        HostAndPort(const std::string& h, int p);

        /**
         * (Re-)initializes this HostAndPort by parsing "s".  Returns
         * Status::OK on success.  The state of this HostAndPort is unspecified
         * after initialize() returns a non-OK status, though it is safe to
         * assign to it or re-initialize it.
         */
        Status initialize(const StringData& s);

        bool operator<(const HostAndPort& r) const;
        bool operator==(const HostAndPort& r) const;
        bool operator!=(const HostAndPort& r) const { return !(*this == r); }

        /**
         * Returns true if the hostname looks localhost-y.
         *
         * TODO: Make a more rigorous implementation, perhaps elsewhere in
         * the networking library.
         */
        bool isLocalHost() const;

        /**
         * Returns a string representation of "host:port".
         */
        std::string toString() const;

        /**
         * Like toString(), above, but writes to "ss", instead.
         */
        void append( StringBuilder& ss ) const;

        /**
         * Returns true if this object represents no valid HostAndPort.
         */
        bool empty() const;

        const std::string& host() const {
            return _host;
        }
        int port() const;

        bool hasPort() const {
            return _port >= 0;
        }

    private:
        std::string _host;
        int _port; // -1 indicates unspecified
    };

    std::ostream& operator<<(std::ostream& os, const HostAndPort& hp);

}  // namespace mongo

MONGO_HASH_NAMESPACE_START

template <>
struct hash<mongo::HostAndPort> {
    size_t operator()(const mongo::HostAndPort& host) const;
};

MONGO_HASH_NAMESPACE_END