IpAddress.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#pragma once

// Headers
#include <SFML/Network/Export.hpp>
 
#include <SFML/System/Time.hpp>
 
#include <iosfwd>
#include <optional>
#include <string>
#include <string_view>
 
#include <cstdint>
 
 
namespace sf
{
class SFML_NETWORK_API IpAddress
{
public:
    [[nodiscard]] static std::optional<IpAddress> resolve(std::string_view address);

    IpAddress(std::uint8_t byte0, std::uint8_t byte1, std::uint8_t byte2, std::uint8_t byte3);

    explicit IpAddress(std::uint32_t address);

    [[nodiscard]] std::string toString() const;

    [[nodiscard]] std::uint32_t toInteger() const;

    [[nodiscard]] static std::optional<IpAddress> getLocalAddress();

    [[nodiscard]] static std::optional<IpAddress> getPublicAddress(Time timeout = Time::Zero);

    // Static member data
    // NOLINTBEGIN(readability-identifier-naming)
    static const IpAddress Any;       
    static const IpAddress LocalHost; 
    static const IpAddress Broadcast; 
    // NOLINTEND(readability-identifier-naming)
 
private:
    friend SFML_NETWORK_API bool operator<(IpAddress left, IpAddress right);

    // Member data
    std::uint32_t m_address; 
};

[[nodiscard]] SFML_NETWORK_API bool operator==(IpAddress left, IpAddress right);

[[nodiscard]] SFML_NETWORK_API bool operator!=(IpAddress left, IpAddress right);

[[nodiscard]] SFML_NETWORK_API bool operator<(IpAddress left, IpAddress right);

[[nodiscard]] SFML_NETWORK_API bool operator>(IpAddress left, IpAddress right);

[[nodiscard]] SFML_NETWORK_API bool operator<=(IpAddress left, IpAddress right);

[[nodiscard]] SFML_NETWORK_API bool operator>=(IpAddress left, IpAddress right);

SFML_NETWORK_API std::istream& operator>>(std::istream& stream, std::optional<IpAddress>& address);

SFML_NETWORK_API std::ostream& operator<<(std::ostream& stream, IpAddress address);
 
} // namespace sf