Orxonox  0.0.5 Codename: Arcturus
Functions
ENet address functions

Functions

ENET_API int enet_address_get_host (const ENetAddress *address, char *hostName, size_t nameLength)
 Attempts to do a reverse lookup of the host field in the address parameter. More...
 
ENET_API int enet_address_get_host_ip (const ENetAddress *address, char *hostName, size_t nameLength)
 Gives the printable form of the ip address specified in the address parameter. More...
 
ENET_API ENetHostAddress enet_address_map4 (enet_uint32 address)
 Maps an IPv4 Address to an IPv6 address. More...
 
ENET_API int enet_address_set_host (ENetAddress *address, const char *hostName)
 Attempts to resolve the host named by the parameter hostName and sets the host field in the address parameter if successful. More...
 
ENET_API ENetAddressFamily enet_get_address_family (const ENetAddress *address)
 Returns the Address family of an (IPv4-mapped) IPv6 address. More...
 

Detailed Description

Function Documentation

ENET_API int enet_address_get_host ( const ENetAddress address,
char *  hostName,
size_t  nameLength 
)

Attempts to do a reverse lookup of the host field in the address parameter.

Parameters
addressaddress used for reverse lookup
hostNamedestination for name, must not be NULL
nameLengthmaximum length of hostName.
Returns
the null-terminated name of the host in hostName on success
Return values
0on success
<0 on failure
ENET_API int enet_address_get_host_ip ( const ENetAddress address,
char *  hostName,
size_t  nameLength 
)

Gives the printable form of the ip address specified in the address parameter.

Parameters
addressaddress printed
hostNamedestination for name, must not be NULL
nameLengthmaximum length of hostName.
Returns
the null-terminated name of the host in hostName on success
Return values
0on success
<0 on failure
ENET_API ENetHostAddress enet_address_map4 ( enet_uint32  address)

Maps an IPv4 Address to an IPv6 address.

Parameters
addressIPv4 address in network byte order
Returns
the IPv4-mapped IPv6 address in network byte order
ENET_API int enet_address_set_host ( ENetAddress address,
const char *  hostName 
)

Attempts to resolve the host named by the parameter hostName and sets the host field in the address parameter if successful.

Parameters
addressdestination to store resolved address
hostNamehost name to lookup
Return values
0on success
<0 on failure
Returns
the address of the given hostName in address on success
ENET_API ENetAddressFamily enet_get_address_family ( const ENetAddress address)

Returns the Address family of an (IPv4-mapped) IPv6 address.

Parameters
addressIPv6 address
Returns
address family