address.hpp

Go to the documentation of this file.

/*
 * Copyright © 2018 Max Mazurov (fox.cpp) <fox.cpp [at] disroot [dot] org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#pragma once

#include <cstdint>
#include <array>
#include <string_view>
#include <string>
#include <libwire/protocols.hpp>
#include <libwire/memory_view.hpp>

/*
 * If you had to open this file to find answer for your question - we are so
 * sorry. Please open issue with your question so we can update documentation
 * to answer it.
 */

namespace libwire {
    struct address {
        address() = default;

        address(const memory_view&) noexcept;

        address(uint8_t, uint8_t, uint8_t, uint8_t) noexcept;

        address(uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t,
                uint8_t, uint8_t, uint8_t, uint8_t, uint8_t) noexcept;

        address(const std::string& text_ip, ip assume_ipver = ip(0)) noexcept(!LIBWIRE_EXCEPTIONS_ENABLED_BOOL);

        std::string to_string() const noexcept;

        bool is_invalid() const noexcept;

        bool operator==(const address&) const noexcept;
        bool operator!=(const address&) const noexcept;

        ip version = ip(0);
        std::array<uint8_t, 16> parts{};

        static const address invalid;
    };

    namespace ipv4 {
        inline address any = {0, 0, 0, 0}, broadcast = {255, 255, 255, 255}, loopback = {127, 0, 0, 1};
    } // namespace ipv4

    namespace ipv6 {
        inline address any = {0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0},
                       broadcast = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
                                    0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff},
                       loopback = {0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x1};
    } // namespace ipv6
} // namespace libwire

namespace std {
    template<>
    struct hash<libwire::address> {
        std::size_t operator()(const libwire::address&) const noexcept;
    };
} // namespace std