#include <sofia-sip/su.h>
Include dependency graph for su_localinfo.h:
Go to the source code of this file.
Data Structures | |
struct | su_localinfo_s |
Local address info structure. More... | |
Enumerations | |
enum | { LI_V4MAPPED, LI_CANONNAME, LI_NAMEREQD, LI_NUMERIC, LI_IFNAME } |
Localinfo flags - li_flags. More... | |
enum | { LI_SCOPE_HOST, LI_SCOPE_LINK, LI_SCOPE_SITE, LI_SCOPE_GLOBAL } |
Localinfo scope - li_scope. More... | |
enum | { ELI_NOADDRESS, ELI_MEMORY, ELI_FAMILY, ELI_RESOLVER, ELI_SYSTEM, ELI_BADHINTS, ELI_NOERROR } |
Localinfo error codes. More... | |
Functions | |
SOFIAPUBFUN int | su_getlocalinfo (su_localinfo_t const *hints, su_localinfo_t **res) |
Request local address information. | |
SOFIAPUBFUN void | su_freelocalinfo (su_localinfo_t *) |
Free local address information. | |
SOFIAPUBFUN char const * | su_gli_strerror (int error) |
Describe su_localinfo errors. | |
SOFIAPUBFUN su_localinfo_t * | su_copylocalinfo (su_localinfo_t const *li0) |
Copy a localinfo structure. | |
SOFIAPUBFUN int | su_sockaddr_scope (su_sockaddr_t const *su, socklen_t sulen) |
Return the scope of address in the sockaddr structure. |
anonymous enum |
anonymous enum |
Localinfo flags - li_flags.
anonymous enum |
SOFIAPUBFUN int su_getlocalinfo | ( | su_localinfo_t const * | hints, | |
su_localinfo_t ** | return_localinfo | |||
) |
Request local address information.
The function su_getlocalinfo() gathers the network interfaces and the addresses corresponding to them, checks if they match to the search criteria specifed by hints and returns a list of matching local address information in the res. The local address information may include IPv4/IPv6 addresses, interface name, interface index, address scope, and domain names corresponding to the local addresses.
hints | specifies selection criteria | |
return_localinfo | return list of local addresses |
LI_V4MAPPED:
when returning IPv4 addresses, map them as IPv6 addresses. If this flag is specified, IPv4 addresses are returned even if hints->li_family is set to AF_INET6
.LI_CANONNAME:
return the domain name (DNS PTR) corresponding to the local address in li_canonname.LI_NAMEREQD:
Do not return addresses not in DNS.LI_NUMERIC:
instead of domain name, return the text presentation of the addresss in li_canonname.LI_IFNAME:
return the interface name in li_ifname.
su_if_names()
.
su_if_names()
.
LI_SCOPE_GLOBAL
| LI_SCOPE_SITE
, both the global and site-local addresses are returned.
SOFIAPUBFUN char const* su_gli_strerror | ( | int | error | ) |
Describe su_localinfo errors.
The function su_gli_strerror() returns a string describing the error condition indicated by the code that was returned by the function su_getlocalinfo().
error | error code returned by su_getlocalinfo() |