ppapi/api/private/ppb_network_list_private.idl

   1 /* Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * This file defines the <code>PPB_NetworkList_Private</code> interface.
   8  */
   9
  10 label Chrome {
  11   M19 = 0.2
  12 };
  13
  14 /**
  15  * Type of a network interface.
  16  */
  17 [assert_size(4)]
  18 enum PP_NetworkListType_Private {
  19   /**
  20    * Type of the network interface is not known.
  21    */
  22   PP_NETWORKLIST_UNKNOWN = 0,
  23
  24   /**
  25    * Wired Ethernet network.
  26    */
  27   PP_NETWORKLIST_ETHERNET = 1,
  28
  29   /**
  30    * Wireless Wi-Fi network.
  31    */
  32   PP_NETWORKLIST_WIFI = 2,
  33
  34   /**
  35    * Cellular network (e.g. LTE).
  36    */
  37   PP_NETWORKLIST_CELLULAR = 3
  38 };
  39
  40 /**
  41  * State of a network interface.
  42  */
  43 [assert_size(4)]
  44 enum PP_NetworkListState_Private  {
  45   /**
  46    * Network interface is down.
  47    */
  48   PP_NETWORKLIST_DOWN = 0,
  49
  50   /**
  51    * Network interface is up.
  52    */
  53   PP_NETWORKLIST_UP = 1
  54 };
  55
  56 /**
  57  * The <code>PPB_NetworkList_Private</code> is used to represent a
  58  * list of network interfaces and their configuration. The content of
  59  * the list is immutable. The current networks configuration can be
  60  * received using the <code>PPB_NetworkMonitor_Private</code>
  61  * interface.
  62  */
  63 interface PPB_NetworkList_Private {
  64   /**
  65    * Determines if the specified <code>resource</code> is a
  66    * <code>NetworkList</code> object.
  67    *
  68    * @param[in] resource A <code>PP_Resource</code> resource.
  69    *
  70    * @return Returns <code>PP_TRUE</code> if <code>resource</code> is
  71    * a <code>PPB_NetworkList_Private</code>, <code>PP_FALSE</code>
  72    * otherwise.
  73    */
  74   PP_Bool IsNetworkList([in] PP_Resource resource);
  75
  76   /**
  77    * @return Returns number of available network interfaces or 0 if
  78    * the list has never been updated.
  79    */
  80   uint32_t GetCount([in] PP_Resource resource);
  81
  82   /**
  83    * @return Returns name for the network interface with the specified
  84    * <code>index</code>.
  85    */
  86   PP_Var GetName([in] PP_Resource resource,
  87                  [in] uint32_t index);
  88
  89   /**
  90    * @return Returns type of the network interface with the specified
  91    * <code>index</code>.
  92    */
  93   PP_NetworkListType_Private GetType([in] PP_Resource resource,
  94                                      [in] uint32_t index);
  95
  96   /**
  97    * @return Returns current state of the network interface with the
  98    * specified <code>index</code>.
  99    */
 100   PP_NetworkListState_Private GetState([in] PP_Resource resource,
 101                                        [in] uint32_t index);
 102
 103   /**
 104    * Gets list of IP addresses for the network interface with the
 105    * specified <code>index</code> and stores them in
 106    * <code>addresses</code>. If the caller didn't allocate sufficient
 107    * space to store all addresses, then only the first
 108    * <code>count</code> addresses are filled in.
 109    *
 110    * @return Returns total number of IP addresses assigned to the
 111    * network interface or a negative error code.
 112    */
 113   int32_t GetIpAddresses(
 114       [in] PP_Resource resource,
 115       [in] uint32_t index,
 116       [inout, size_is(count)] PP_NetAddress_Private[] addresses,
 117       [in] uint32_t count);
 118
 119   /**
 120    * @return Returns display name for the network interface with the
 121    * specified <code>index</code>.
 122    */
 123   PP_Var GetDisplayName([in] PP_Resource resource,
 124                         [in] uint32_t index);
 125
 126   /**
 127    * @return Returns MTU for the network interface with the specified
 128    * <code>index</code> or 0 if MTU is unknown.
 129    */
 130   uint32_t GetMTU([in] PP_Resource resource,
 131                   [in] uint32_t index);
 132
 133 };