Encapsulate an IPv4 network address. More...
#include <IpAddress.hpp>
Public Member Functions | |
IpAddress () | |
Default constructor. | |
IpAddress (const std::string &address) | |
Construct the address from a string. | |
IpAddress (const char *address) | |
Construct the address from a string. | |
IpAddress (Uint8 byte0, Uint8 byte1, Uint8 byte2, Uint8 byte3) | |
Construct the address from 4 bytes. | |
IpAddress (Uint32 address) | |
Construct the address from a 32-bits integer. | |
std::string | ToString () const |
Get a string representation of the address. | |
Uint32 | ToInteger () const |
Get an integer representation of the address. | |
Static Public Member Functions | |
static IpAddress | GetLocalAddress () |
Get the computer's local address. | |
static IpAddress | GetPublicAddress (Uint32 timeout=0) |
Get the computer's public address. | |
Static Public Attributes | |
static const IpAddress | None |
Value representing an empty/invalid address. | |
static const IpAddress | LocalHost |
The "localhost" address (for connecting a computer to itself locally). |
Encapsulate an IPv4 network address.
sf::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:
sf::IpAddress a0; // an invalid address sf::IpAddress a1 = sf::IpAddress::None; // an invalid address (same as a0) sf::IpAddress a2("127.0.0.1"); // the local host address sf::IpAddress a3 = sf::IpAddress::LocalHost; // the local host address (same as a2) sf::IpAddress a4(192, 168, 1, 56); // a local address sf::IpAddress a5("my_computer"); // a local address created from a network name sf::IpAddress a6("89.54.1.169"); // a distant address sf::IpAddress a7("www.google.com"); // a distant address created from a network name sf::IpAddress a8 = sf::IpAddress::GetLocalAddress(); // my address on the local network sf::IpAddress a9 = sf::IpAddress::GetPublicAddress(); // my address on the internet
Note that sf::IpAddress currently doesn't support IPv6 nor other types of network addresses.
Definition at line 43 of file IpAddress.hpp.
sf::IpAddress::IpAddress | ( | ) |
Default constructor.
This constructor creates an empty (invalid) address
sf::IpAddress::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").
address | IP address or network name |
sf::IpAddress::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.
address | IP address or network name |
sf::IpAddress::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.
byte0 | First byte of the address | |
byte1 | Second byte of the address | |
byte2 | Third byte of the address | |
byte3 | Fourth byte of the address |
sf::IpAddress::IpAddress | ( | Uint32 | address | ) | [explicit] |
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().
address | 4 bytes of the address packed into a 32-bits integer |
static IpAddress sf::IpAddress::GetLocalAddress | ( | ) | [static] |
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.
static IpAddress sf::IpAddress::GetPublicAddress | ( | Uint32 | timeout = 0 |
) | [static] |
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.
timeout | Maximum time to wait, in milliseconds |
Uint32 sf::IpAddress::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 sf::IpAddress with the proper constructor.
std::string sf::IpAddress::ToString | ( | ) | const |
const IpAddress sf::IpAddress::LocalHost [static] |
The "localhost" address (for connecting a computer to itself locally).
Definition at line 184 of file IpAddress.hpp.
const IpAddress sf::IpAddress::None [static] |
Value representing an empty/invalid address.
Definition at line 183 of file IpAddress.hpp.