class EE::Network::IpAddress¶

Overview¶

Encapsulate an IPv4 network address. More…

#include <ipaddress.hpp>

class IpAddress {
public:
    // fields

    static const IpAddress None;
    static const IpAddress Any;
    static const IpAddress LocalHost;
    static const IpAddress Broadcast;

    // construction

    IpAddress();
    IpAddress(const std::string& address);
    IpAddress(const char* address);
    IpAddress(Uint8 byte0, Uint8 byte1, Uint8 byte2, Uint8 byte3);
    IpAddress(Uint32 address);

    // methods

    std::string toString() const;
    Uint32 toInteger() const;
    static IpAddress getLocalAddress();
    static IpAddress getPublicAddress(Time timeout = Time::Zero);
};

Detailed Documentation¶

Encapsulate an IPv4 network address.

IpAddress is a utility class for manipulating network addresses. It provides a set a implicit constructors and conversion functions to easily build or transform an IP address from/to various representations.

Usage example:

IpAddress a0;                                    // an invalid address
IpAddress a1 = IpAddress::None;            // an invalid address (same as a0)
IpAddress a2("127.0.0.1");                      // the local host address
IpAddress a3 = IpAddress::Broadcast;          // the broadcast address
IpAddress a4(192, 168, 1, 56);                  // a local address
IpAddress a5("my_computer");                      // a local address created from a network name
IpAddress a6("89.54.1.169");                      // a distant address
IpAddress a7("www.google.com");                // a distant address created from a network name
IpAddress a8 = IpAddress::getLocalAddress();  // my address on the local network
IpAddress a9 = IpAddress::getPublicAddress(); // my address on the internet

Note that IpAddress currently doesn’t support IPv6 nor other types of network addresses.

Fields¶

static const IpAddress None

Value representing an empty/invalid address.

static const IpAddress Any

Value representing any address (0.0.0.0)

static const IpAddress LocalHost

The “localhost” address (for connecting a computer to itself locally)

static const IpAddress Broadcast

The “broadcast” address (for sending UDP messages to everyone on a local network)

Construction¶

IpAddress()

Default constructor This constructor creates an empty (invalid) address.

IpAddress(const std::string& address)

Construct the address from a string Here address can be either a decimal address (ex: “192.168.1.56”) or a network name (ex: “localhost”).

Parameters:

address

IP address or network name

IpAddress(const char* address)

Construct the address from a string Here address can be either a decimal address (ex: “192.168.1.56”) or a network name (ex: “localhost”). This is equivalent to the constructor taking a std::string parameter, it is defined for convenience so that the implicit conversions from literal strings to IpAddress work.

Parameters:

address

IP address or network name

IpAddress(Uint8 byte0, Uint8 byte1, Uint8 byte2, Uint8 byte3)

Construct the address from 4 bytes Calling IpAddress(a, b, c, d) is equivalent to calling IpAddress (“a.b.c.d”), but safer as it doesn’t have to parse a string to get the address components.

Parameters:

byte0	First byte of the address
byte1	Second byte of the address
byte2	Third byte of the address
byte3	Fourth byte of the address

IpAddress(Uint32 address)

Construct the address from a 32-bits integer This constructor uses the internal representation of the address directly. It should be used for optimization purposes, and only if you got that representation from IpAddress::toInteger().

Parameters:

address

4 bytes of the address packed into a 32-bits integer

See also:

ToInteger

Methods¶

std::string toString() const

Get a string representation of the address The returned string is the decimal representation of the IP address (like “192.168.1.56”), even if it was constructed from a host name.

Returns:

String representation of the address

See also:

ToInteger

Uint32 toInteger() const

Get an integer representation of the address The returned number is the internal representation of the address, and should be used for optimization purposes only (like sending the address through a socket). The integer produced by this function can then be converted back to a IpAddress with the proper constructor.

Returns:

32-bits unsigned integer representation of the address

See also:

ToString

static IpAddress getLocalAddress()

Get the computer’s local address The local address is the address of the computer from the LAN point of view, i.e. something like 192.168.1.56. It is meaningful only for communications over the local network. Unlike GetPublicAddress, this function is fast and may be used safely anywhere.

Returns:

Local IP address of the computer

See also:

GetPublicAddress

static IpAddress getPublicAddress(Time timeout = Time::Zero)

Get the computer’s public address The public address is the address of the computer from the internet point of view, i.e. something like 89.54.1.169. It is necessary for communications over the world wide web. The only way to get a public address is to ask it to a distant website; as a consequence, this function depends on both your network connection and the server, and may be very slow. You should use it as few as possible. Because this function depends on the network connection and on a distant server, you may use a time limit if you don’t want your program to be possibly stuck waiting in case there is a problem; this limit is deactivated by default.

Parameters:

timeout

Maximum time to wait

Returns:

Public IP address of the computer

See also:

GetLocalAddress