| Index: ppapi/c/dev/ppb_net_address_dev.h
|
| diff --git a/ppapi/c/dev/ppb_net_address_dev.h b/ppapi/c/dev/ppb_net_address_dev.h
|
| index 3ce3f523b78fc393ca68dacd06a0130dfdee998a..445679e73c05b18e53d9bce456a76d0417df8405 100644
|
| --- a/ppapi/c/dev/ppb_net_address_dev.h
|
| +++ b/ppapi/c/dev/ppb_net_address_dev.h
|
| @@ -3,7 +3,7 @@
|
| * found in the LICENSE file.
|
| */
|
|
|
| -/* From dev/ppb_net_address_dev.idl modified Mon Jun 10 17:42:43 2013. */
|
| +/* From dev/ppb_net_address_dev.idl modified Thu Jun 20 12:10:09 2013. */
|
|
|
| #ifndef PPAPI_C_DEV_PPB_NET_ADDRESS_DEV_H_
|
| #define PPAPI_C_DEV_PPB_NET_ADDRESS_DEV_H_
|
| @@ -28,6 +28,9 @@
|
| * @addtogroup Enums
|
| * @{
|
| */
|
| +/**
|
| + * Network address family types.
|
| + */
|
| typedef enum {
|
| /**
|
| * The address family is unspecified.
|
| @@ -96,6 +99,13 @@ struct PPB_NetAddress_Dev_0_1 {
|
| /**
|
| * Creates a <code>PPB_NetAddress_Dev</code> resource with the specified IPv4
|
| * address.
|
| + *
|
| + * @param[in] instance A <code>PP_Instance</code> identifying one instance of
|
| + * a module.
|
| + * @param[in] ipv4_addr An IPv4 address.
|
| + *
|
| + * @return A <code>PP_Resource</code> representing the same address as
|
| + * <code>ipv4_addr</code> or 0 on failure.
|
| */
|
| PP_Resource (*CreateFromIPv4Address)(
|
| PP_Instance instance,
|
| @@ -103,16 +113,34 @@ struct PPB_NetAddress_Dev_0_1 {
|
| /**
|
| * Creates a <code>PPB_NetAddress_Dev</code> resource with the specified IPv6
|
| * address.
|
| + *
|
| + * @param[in] instance A <code>PP_Instance</code> identifying one instance of
|
| + * a module.
|
| + * @param[in] ipv6_addr An IPv6 address.
|
| + *
|
| + * @return A <code>PP_Resource</code> representing the same address as
|
| + * <code>ipv6_addr</code> or 0 on failure.
|
| */
|
| PP_Resource (*CreateFromIPv6Address)(
|
| PP_Instance instance,
|
| const struct PP_NetAddress_IPv6_Dev* ipv6_addr);
|
| /**
|
| * Determines if a given resource is a network address.
|
| + *
|
| + * @param[in] resource A <code>PP_Resource</code> to check.
|
| + *
|
| + * @return <code>PP_TRUE</code> if the input is a
|
| + * <code>PPB_NetAddress_Dev</code> resource; <code>PP_FALSE</code> otherwise.
|
| */
|
| - PP_Bool (*IsNetAddress)(PP_Resource addr);
|
| + PP_Bool (*IsNetAddress)(PP_Resource resource);
|
| /**
|
| * Gets the address family.
|
| + *
|
| + * @param[in] addr A <code>PP_Resource</code> corresponding to a network
|
| + * address.
|
| + *
|
| + * @return The address family on success;
|
| + * <code>PP_NETADDRESS_FAMILY_UNSPECIFIED</code> on failure.
|
| */
|
| PP_NetAddress_Family_Dev (*GetFamily)(PP_Resource addr);
|
| /**
|
| @@ -120,24 +148,47 @@ struct PPB_NetAddress_Dev_0_1 {
|
| * 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").
|
| - * Returns an undefined var on failure.
|
| + *
|
| + * @param[in] addr A <code>PP_Resource</code> corresponding to a network
|
| + * address.
|
| + * @param[in] include_port Whether to include the port number in the
|
| + * description.
|
| + *
|
| + * @return A string <code>PP_Var</code> on success; an undefined
|
| + * <code>PP_Var</code> on failure.
|
| */
|
| struct PP_Var (*DescribeAsString)(PP_Resource addr, PP_Bool include_port);
|
| /**
|
| * Fills a <code>PP_NetAddress_IPv4_Dev</code> structure if the network
|
| * address is of <code>PP_NETADDRESS_FAMILY_IPV4</code> address family.
|
| - * Returns PP_FALSE on failure. Note that passing a network address of
|
| + * Note that passing a network address of
|
| * <code>PP_NETADDRESS_FAMILY_IPV6</code> address family will fail even if the
|
| * address is an IPv4-mapped IPv6 address.
|
| + *
|
| + * @param[in] addr A <code>PP_Resource</code> corresponding to a network
|
| + * address.
|
| + * @param[out] ipv4_addr A <code>PP_NetAddress_IPv4_Dev</code> structure to
|
| + * store the result.
|
| + *
|
| + * @return A <code>PP_Bool</code> value indicating whether the operation
|
| + * succeeded.
|
| */
|
| PP_Bool (*DescribeAsIPv4Address)(PP_Resource addr,
|
| struct PP_NetAddress_IPv4_Dev* ipv4_addr);
|
| /**
|
| * Fills a <code>PP_NetAddress_IPv6_Dev</code> structure if the network
|
| * address is of <code>PP_NETADDRESS_FAMILY_IPV6</code> address family.
|
| - * Returns PP_FALSE on failure. Note that passing a network address of
|
| + * Note that passing a network address of
|
| * <code>PP_NETADDRESS_FAMILY_IPV4</code> address family will fail - this
|
| * method doesn't map it to an IPv6 address.
|
| + *
|
| + * @param[in] addr A <code>PP_Resource</code> corresponding to a network
|
| + * address.
|
| + * @param[out] ipv6_addr A <code>PP_NetAddress_IPv6_Dev</code> structure to
|
| + * store the result.
|
| + *
|
| + * @return A <code>PP_Bool</code> value indicating whether the operation
|
| + * succeeded.
|
| */
|
| PP_Bool (*DescribeAsIPv6Address)(PP_Resource addr,
|
| struct PP_NetAddress_IPv6_Dev* ipv6_addr);
|
|
|