tcp_address.hpp 3.72 KB
Newer Older
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq 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 Lesser General Public
    License for more details.
25 26 27 28 29 30 31 32 33 34

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __ZMQ_TCP_ADDRESS_HPP_INCLUDED__
#define __ZMQ_TCP_ADDRESS_HPP_INCLUDED__

#include "platform.hpp"

Martin Sustrik's avatar
Martin Sustrik committed
35 36 37
#if defined ZMQ_HAVE_WINDOWS
#include "windows.hpp"
#else
38 39
#include <sys/socket.h>
#include <netinet/in.h>
Martin Sustrik's avatar
Martin Sustrik committed
40
#endif
41 42 43 44 45 46 47 48 49

namespace zmq
{

    class tcp_address_t
    {
    public:

        tcp_address_t ();
50
        tcp_address_t (const sockaddr *sa, socklen_t sa_len);
Sergey KHripchenko's avatar
Sergey KHripchenko committed
51
        virtual ~tcp_address_t ();
52 53

        //  This function translates textual TCP address into an address
54
        //  structure. If 'local' is true, names are resolved as local interface
55
        //  names. If it is false, names are resolved as remote hostnames.
Pieter Hintjens's avatar
Pieter Hintjens committed
56
        //  If 'ipv6' is true, the name may resolve to IPv6 address.
57
        int resolve (const char *name_, bool local_, bool ipv6_, bool is_src_ = false);
58

59 60 61
        //  The opposite to resolve()
        virtual int to_string (std::string &addr_);

Martin Sustrik's avatar
Martin Sustrik committed
62
#if defined ZMQ_HAVE_WINDOWS
63
        unsigned short family () const;
Martin Sustrik's avatar
Martin Sustrik committed
64
#else
65
        sa_family_t family () const;
Martin Sustrik's avatar
Martin Sustrik committed
66
#endif
67 68
        const sockaddr *addr () const;
        socklen_t addrlen () const;
69

70 71 72 73
        const sockaddr *src_addr () const;
        socklen_t src_addrlen () const;
        bool has_src_addr () const;

74
    protected:
75 76 77
        int resolve_nic_name (const char *nic_, bool ipv6_, bool is_src_ = false);
        int resolve_interface (const char *interface_, bool ipv6_, bool is_src_ = false);
        int resolve_hostname (const char *hostname_, bool ipv6_, bool is_src_ = false);
78 79 80 81 82 83

        union {
            sockaddr generic;
            sockaddr_in ipv4;
            sockaddr_in6 ipv6;
        } address;
84 85 86 87 88 89 90

        union {
            sockaddr generic;
            sockaddr_in ipv4;
            sockaddr_in6 ipv6;
        } source_address;
        bool _has_src_addr;
91 92 93 94 95 96 97 98 99 100
    };

    class tcp_address_mask_t : public tcp_address_t
    {
    public:
        tcp_address_mask_t ();

        // This function enhances tcp_address_t::resolve() with ability to parse
        // additional cidr-like(/xx) mask value at the end of the name string.
        // Works only with remote hostnames.
Pieter Hintjens's avatar
Pieter Hintjens committed
101
        int resolve (const char *name_, bool ipv6_);
102

103 104 105
        // The opposite to resolve()
        int to_string (std::string &addr_);

106
        int mask () const;
107

108
        bool match_address (const struct sockaddr *ss, const socklen_t ss_len) const;
109 110 111

    private:
        int address_mask;
112
    };
113

114 115 116
}

#endif