Data Fields
PP_Resource(* | CreateFromIPv4Address )(PP_Instance instance, const struct PP_NetAddress_IPv4 *ipv4_addr) |
PP_Resource(* | CreateFromIPv6Address )(PP_Instance instance, const struct PP_NetAddress_IPv6 *ipv6_addr) |
PP_Bool(* | IsNetAddress )(PP_Resource resource) |
PP_NetAddress_Family(* | GetFamily )(PP_Resource addr) |
struct PP_Var(* | DescribeAsString )(PP_Resource addr, PP_Bool include_port) |
PP_Bool(* | DescribeAsIPv4Address )(PP_Resource addr, struct PP_NetAddress_IPv4 *ipv4_addr) |
PP_Bool(* | DescribeAsIPv6Address )(PP_Resource addr, struct PP_NetAddress_IPv6 *ipv6_addr) |
Detailed Description
The PPB_NetAddress
interface provides operations on network addresses.
Field Documentation
PP_Resource(* PPB_NetAddress::CreateFromIPv4Address)(PP_Instance instance, const struct PP_NetAddress_IPv4 *ipv4_addr) |
Creates a PPB_NetAddress
resource with the specified IPv4 address.
- Parameters:
[in] instance A PP_Instance
identifying one instance of a module.[in] ipv4_addr An IPv4 address.
- Returns:
- A
PP_Resource
representing the same address asipv4_addr
or 0 on failure.
PP_Resource(* PPB_NetAddress::CreateFromIPv6Address)(PP_Instance instance, const struct PP_NetAddress_IPv6 *ipv6_addr) |
Creates a PPB_NetAddress
resource with the specified IPv6 address.
- Parameters:
[in] instance A PP_Instance
identifying one instance of a module.[in] ipv6_addr An IPv6 address.
- Returns:
- A
PP_Resource
representing the same address asipv6_addr
or 0 on failure.
PP_Bool(* PPB_NetAddress::DescribeAsIPv4Address)(PP_Resource addr, struct PP_NetAddress_IPv4 *ipv4_addr) |
Fills a PP_NetAddress_IPv4
structure if the network address is of PP_NETADDRESS_FAMILY_IPV4
address family.
Note that passing a network address of PP_NETADDRESS_FAMILY_IPV6
address family will fail even if the address is an IPv4-mapped IPv6 address.
- Parameters:
[in] addr A PP_Resource
corresponding to a network address.[out] ipv4_addr A PP_NetAddress_IPv4
structure to store the result.
- Returns:
- A
PP_Bool
value indicating whether the operation succeeded.
PP_Bool(* PPB_NetAddress::DescribeAsIPv6Address)(PP_Resource addr, struct PP_NetAddress_IPv6 *ipv6_addr) |
Fills a PP_NetAddress_IPv6
structure if the network address is of PP_NETADDRESS_FAMILY_IPV6
address family.
Note that passing a network address of PP_NETADDRESS_FAMILY_IPV4
address family will fail - this method doesn't map it to an IPv6 address.
- Parameters:
[in] addr A PP_Resource
corresponding to a network address.[out] ipv6_addr A PP_NetAddress_IPv6
structure to store the result.
- Returns:
- A
PP_Bool
value indicating whether the operation succeeded.
struct PP_Var(* PPB_NetAddress::DescribeAsString)(PP_Resource addr, PP_Bool include_port) [read] |
Returns a human-readable description of the network address.
The description is in the form of host [ ":" port ] and conforms to http://tools.ietf.org/html/rfc3986#section-3.2 for IPv4 and IPv6 addresses (e.g., "192.168.0.1", "192.168.0.1:99", or "[::1]:80").
- Parameters:
[in] addr A PP_Resource
corresponding to a network address.[in] include_port Whether to include the port number in the description.
Gets the address family.
- Parameters:
[in] addr A PP_Resource
corresponding to a network address.
- Returns:
- The address family on success;
PP_NETADDRESS_FAMILY_UNSPECIFIED
on failure.
PP_Bool(* PPB_NetAddress::IsNetAddress)(PP_Resource resource) |
Determines if a given resource is a network address.
- Parameters:
[in] resource A PP_Resource
to check.
- Returns:
PP_TRUE
if the input is aPPB_NetAddress
resource;PP_FALSE
otherwise.
The documentation for this struct was generated from the following file: