documentation/3.0.1/IpAddress_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2025 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


Export.hpp

SFML_NETWORK_API
#define SFML_NETWORK_API
Definition Network/Export.hpp:42

Time.hpp

sf::IpAddress
Encapsulate an IPv4 network address.
Definition IpAddress.hpp:49

sf::IpAddress::getLocalAddress
static std::optional< IpAddress > getLocalAddress()
Get the computer's local address.

sf::IpAddress::getPublicAddress
static std::optional< IpAddress > getPublicAddress(Time timeout=Time::Zero)
Get the computer's public address.

sf::IpAddress::Any
static const IpAddress Any
Value representing any address (0.0.0.0)
Definition IpAddress.hpp:168

sf::IpAddress::resolve
static std::optional< IpAddress > resolve(std::string_view address)
Construct the address from a null-terminated string view.

sf::IpAddress::toInteger
std::uint32_t toInteger() const
Get an integer representation of the address.

sf::IpAddress::IpAddress
IpAddress(std::uint32_t address)
Construct the address from a 32-bits integer.

sf::IpAddress::LocalHost
static const IpAddress LocalHost
The "localhost" address (for connecting a computer to itself locally)
Definition IpAddress.hpp:169

sf::IpAddress::toString
std::string toString() const
Get a string representation of the address.

sf::IpAddress::Broadcast
static const IpAddress Broadcast
The "broadcast" address (for sending UDP messages to everyone on a local network)
Definition IpAddress.hpp:170

sf::IpAddress::operator<
friend bool operator<(IpAddress left, IpAddress right)
Overload of operator< to compare two IP addresses.

sf::IpAddress::IpAddress
IpAddress(std::uint8_t byte0, std::uint8_t byte1, std::uint8_t byte2, std::uint8_t byte3)
Construct the address from 4 bytes.

sf::Time
Represents a time value.
Definition Time.hpp:42

sf::Time::Zero
static const Time Zero
Predefined "zero" time value.
Definition Time.hpp:110

sf
Definition AudioResource.hpp:36

sf::operator!=
bool operator!=(IpAddress left, IpAddress right)
Overload of operator!= to compare two IP addresses.

sf::operator<
bool operator<(IpAddress left, IpAddress right)
Overload of operator< to compare two IP addresses.

sf::operator==
bool operator==(IpAddress left, IpAddress right)
Overload of operator== to compare two IP addresses.

sf::operator>
bool operator>(IpAddress left, IpAddress right)
Overload of operator> to compare two IP addresses.

sf::operator>=
bool operator>=(IpAddress left, IpAddress right)
Overload of operator>= to compare two IP addresses.

sf::operator>>
std::istream & operator>>(std::istream &stream, std::optional< IpAddress > &address)
Overload of operator>> to extract an IP address from an input stream.

sf::operator<=
bool operator<=(IpAddress left, IpAddress right)
Overload of operator<= to compare two IP addresses.

sf::operator<<
std::ostream & operator<<(std::ostream &stream, IpAddress address)
Overload of operator<< to print an IP address to an output stream.