0e2297af28
Renamed the CSFML directory to c Renamed the DSFML directory to d --> bindings must now be updated to match the new organization! git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1630 4e206d99-4929-0410-ac5d-dfc041789085
131 lines
4.9 KiB
C
131 lines
4.9 KiB
C
////////////////////////////////////////////////////////////
|
|
//
|
|
// SFML - Simple and Fast Multimedia Library
|
|
// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
|
|
//
|
|
// 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.
|
|
//
|
|
////////////////////////////////////////////////////////////
|
|
|
|
#ifndef SFML_IPADDRESS_H
|
|
#define SFML_IPADDRESS_H
|
|
|
|
////////////////////////////////////////////////////////////
|
|
// Headers
|
|
////////////////////////////////////////////////////////////
|
|
#include <SFML/Config.h>
|
|
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// sfIpAddress provides easy manipulation of IP v4 addresses
|
|
////////////////////////////////////////////////////////////
|
|
typedef struct
|
|
{
|
|
char Address[16];
|
|
} sfIpAddress;
|
|
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Construct an address from a string
|
|
///
|
|
/// \param string : IP address ("xxx.xxx.xxx.xxx") or network name
|
|
///
|
|
/// \return Resulting address
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API sfIpAddress sfIpAddress_FromString(const char* string);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Construct an address from 4 bytes
|
|
///
|
|
/// \param byte0 : First byte of the address
|
|
/// \param byte1 : Second byte of the address
|
|
/// \param byte2 : Third byte of the address
|
|
/// \param byte3 : Fourth byte of the address
|
|
///
|
|
/// \return Resulting address
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API sfIpAddress sfIpAddress_FromBytes(sfUint8 byte0, sfUint8 byte1, sfUint8 byte2, sfUint8 byte3);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Construct the address from a 32-bits integer
|
|
///
|
|
/// \param address : 4 bytes of the address packed into a 32-bits integer
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API sfIpAddress sfIpAddress_FromInteger(sfUint32 address);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Get a string representation of an address
|
|
///
|
|
/// \param address : Address to convert
|
|
/// \param string : Char array to fill (size must be >= 16)
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API void sfIpAddress_ToString(sfIpAddress address, char* string);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Get an integer representation of the address
|
|
///
|
|
/// \param address : Address to convert
|
|
///
|
|
/// \return 32-bits integer containing the 4 bytes of the address, in system endianness
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API sfUint32 sfIpAddress_ToInteger(sfIpAddress address);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Get the computer's local IP address (from the LAN point of view)
|
|
///
|
|
/// \return Local IP address
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API sfIpAddress sfIpAddress_GetLocalAddress(void);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Get the computer's public IP address (from the web point of view).
|
|
/// The only way to get a public address is to ask it to a
|
|
/// distant website ; as a consequence, this function may be
|
|
/// very slow -- use it as few as possible !
|
|
///
|
|
/// \param timeout : Maximum time to wait, in seconds (use 0 for no timeout)
|
|
///
|
|
/// \return Public IP address
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API sfIpAddress sfIpAddress_GetPublicAddress(float timeout);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Get the computer's loopback address
|
|
///
|
|
/// \return Local host IP address (127.0.0.1, or "localhost")
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API sfIpAddress sfIpAddress_LocalHost(void);
|
|
|
|
////////////////////////////////////////////////////////////
|
|
/// Get the empty/invalid address
|
|
///
|
|
/// \return Empty object that represents invalid addresses
|
|
///
|
|
////////////////////////////////////////////////////////////
|
|
CSFML_API sfIpAddress sfIpAddress_None(void);
|
|
|
|
|
|
#endif // SFML_IPADDRESS_H
|