CSFML - C binding of the Simple and Fast Multimedia Library

CSFML
IpAddress.h
Go to the documentation of this file.
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages arising from the use of this software.
8 //
9 // Permission is granted to anyone to use this software for any purpose,
10 // including commercial applications, and to alter it and redistribute it freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24
25 #ifndef SFML_IPADDRESS_H
26 #define SFML_IPADDRESS_H
27
29 // Headers
31 #include <SFML/Network/Export.h>
32 #include <SFML/System/Time.h>
33
34
39 typedef struct
40 {
41 char address[16];
42 } sfIpAddress;
43
44
49 CSFML_NETWORK_API const sfIpAddress sfIpAddress_None;
50
55 CSFML_NETWORK_API const sfIpAddress sfIpAddress_Any;
56
61 CSFML_NETWORK_API const sfIpAddress sfIpAddress_LocalHost;
62
67 CSFML_NETWORK_API const sfIpAddress sfIpAddress_Broadcast;
68
80 CSFML_NETWORK_API sfIpAddress sfIpAddress_fromString(const char* address);
81
98 CSFML_NETWORK_API sfIpAddress sfIpAddress_fromBytes(sfUint8 byte0, sfUint8 byte1, sfUint8 byte2, sfUint8 byte3);
99
113 CSFML_NETWORK_API sfIpAddress sfIpAddress_fromInteger(sfUint32 address);
114
126 CSFML_NETWORK_API void sfIpAddress_toString(sfIpAddress address, char* string);
127
142 CSFML_NETWORK_API sfUint32 sfIpAddress_toInteger(sfIpAddress address);
143
156 CSFML_NETWORK_API sfIpAddress sfIpAddress_getLocalAddress(void);
157
178 CSFML_NETWORK_API sfIpAddress sfIpAddress_getPublicAddress(sfTime timeout);
179
180
181 #endif // SFML_IPADDRESS_H
sfIpAddress_LocalHost
CSFML_NETWORK_API const sfIpAddress sfIpAddress_LocalHost
Local host IP address (127.0.0.1, or "localhost")
Definition: IpAddress.h:61
CSFML_NETWORK_API
#define CSFML_NETWORK_API
Definition: Network/Export.h:43
sfIpAddress_None
CSFML_NETWORK_API const sfIpAddress sfIpAddress_None
Empty object that represents invalid addresses.
Definition: IpAddress.h:49
sfIpAddress
Encapsulate an IPv4 network address.
Definition: IpAddress.h:39
sfTime
Represents a time value.
Definition: Time.h:38
sfIpAddress_toString
CSFML_NETWORK_API void sfIpAddress_toString(sfIpAddress address, char *string)
Get a string representation of an address.
sfIpAddress_fromInteger
CSFML_NETWORK_API sfIpAddress sfIpAddress_fromInteger(sfUint32 address)
Construct an address from a 32-bits integer.
sfUint32
unsigned int sfUint32
Definition: Config.h:176
sfIpAddress_getPublicAddress
CSFML_NETWORK_API sfIpAddress sfIpAddress_getPublicAddress(sfTime timeout)
Get the computer&#39;s public address.
sfIpAddress_getLocalAddress
CSFML_NETWORK_API sfIpAddress sfIpAddress_getLocalAddress(void)
Get the computer&#39;s local address.
sfIpAddress_Any
CSFML_NETWORK_API const sfIpAddress sfIpAddress_Any
Value representing any address (0.0.0.0)
Definition: IpAddress.h:55
sfIpAddress_toInteger
CSFML_NETWORK_API sfUint32 sfIpAddress_toInteger(sfIpAddress address)
Get an integer representation of the address.
sfUint8
unsigned char sfUint8
Definition: Config.h:168
sfIpAddress_Broadcast
CSFML_NETWORK_API const sfIpAddress sfIpAddress_Broadcast
UDP broadcast address (255.255.255.255)
Definition: IpAddress.h:67
sfIpAddress_fromString
CSFML_NETWORK_API sfIpAddress sfIpAddress_fromString(const char *address)
Create an address from a string.
Export.h
Time.h
sfIpAddress_fromBytes
CSFML_NETWORK_API sfIpAddress sfIpAddress_fromBytes(sfUint8 byte0, sfUint8 byte1, sfUint8 byte2, sfUint8 byte3)
Create an address from 4 bytes.