{{+bindTo:partials.standard_nacl_article}}

PPB_NetworkList Struct Reference

{{- dummy div to appease doxygen -}}

Data Fields

PP_Bool(* IsNetworkList )(PP_Resource resource)
uint32_t(* GetCount )(PP_Resource resource)
struct PP_Var(* GetName )(PP_Resource resource, uint32_t index)
PP_NetworkList_Type(* GetType )(PP_Resource resource, uint32_t index)
PP_NetworkList_State(* GetState )(PP_Resource resource, uint32_t index)
int32_t(* GetIpAddresses )(PP_Resource resource, uint32_t index, struct PP_ArrayOutput output)
struct PP_Var(* GetDisplayName )(PP_Resource resource, uint32_t index)
uint32_t(* GetMTU )(PP_Resource resource, uint32_t index)

Detailed Description

The PPB_NetworkList is used to represent a list of network interfaces and their configuration.

The content of the list is immutable. The current networks configuration can be received using the PPB_NetworkMonitor interface.

Field Documentation

uint32_t(* PPB_NetworkList::GetCount)(PP_Resource resource)

Gets number of interfaces in the list.

Parameters:
[in]resourceA PP_Resource corresponding to a network list.
Returns:
Returns number of available network interfaces or 0 if the list has never been updated.
struct PP_Var(* PPB_NetworkList::GetDisplayName)(PP_Resource resource, uint32_t index) [read]

Gets display name of a network interface.

Parameters:
[in]resourceA PP_Resource corresponding to a network list.
[in]indexIndex of the network interface.
Returns:
Returns display name for the network interface with the specified index.
int32_t(* PPB_NetworkList::GetIpAddresses)(PP_Resource resource, uint32_t index, struct PP_ArrayOutput output)

Gets list of IP addresses for a network interface.

Parameters:
[in]resourceA PP_Resource corresponding to a network list.
[in]indexIndex of the network interface.
[in]outputAn output array which will receive PPB_NetAddress resources on success. Please note that the ref count of those resources has already been increased by 1 for the caller.
Returns:
An error code from pp_errors.h.
uint32_t(* PPB_NetworkList::GetMTU)(PP_Resource resource, uint32_t index)

Gets MTU (Maximum Transmission Unit) of a network interface.

Parameters:
[in]resourceA PP_Resource corresponding to a network list.
[in]indexIndex of the network interface.
Returns:
Returns MTU for the network interface with the specified index or 0 if MTU is unknown.
struct PP_Var(* PPB_NetworkList::GetName)(PP_Resource resource, uint32_t index) [read]

Gets name of a network interface.

Parameters:
[in]resourceA PP_Resource corresponding to a network list.
[in]indexIndex of the network interface.
Returns:
Returns name for the network interface with the specified index.
PP_NetworkList_State(* PPB_NetworkList::GetState)(PP_Resource resource, uint32_t index)

Gets state of a network interface.

Parameters:
[in]resourceA PP_Resource corresponding to a network list.
[in]indexIndex of the network interface.
Returns:
Returns current state of the network interface with the specified index.
PP_NetworkList_Type(* PPB_NetworkList::GetType)(PP_Resource resource, uint32_t index)

Gets type of a network interface.

Parameters:
[in]resourceA PP_Resource corresponding to a network list.
[in]indexIndex of the network interface.
Returns:
Returns type of the network interface with the specified index.
PP_Bool(* PPB_NetworkList::IsNetworkList)(PP_Resource resource)

Determines if the specified resource is a NetworkList object.

Parameters:
[in]resourceA PP_Resource resource.
Returns:
Returns PP_TRUE if resource is a PPB_NetworkList, PP_FALSE otherwise.
The documentation for this struct was generated from the following file:
{{/partials.standard_nacl_article}}