ppapi/api/private/ppb_network_monitor_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_NetworkMonitor_Private</code> interface.
   8  */
   9
  10 label Chrome {
  11   M19 = 0.2
  12 };
  13
  14 /**
  15  * <code>PPB_NetworkMonitor_Callback</code> is a callback function
  16  * type that is used to receive notifications about network
  17  * configuration changes. The <code>network_list</code> passed to this
  18  * callback is a <code>PPB_NetworkList_Private</code> resource that
  19  * contains current configuration of network interfaces.
  20  */
  21 typedef void PPB_NetworkMonitor_Callback([inout] mem_t user_data,
  22                                          [in] PP_Resource network_list);
  23
  24
  25 /**
  26  * The <code>PPB_NetworkMonitor_Private</code> provides access to
  27  * notifications of network configuration changes.
  28  */
  29 interface PPB_NetworkMonitor_Private {
  30   /**
  31    * Starts network change monitoring. The specified
  32    * <code>callback</code> will be called on the main thread once
  33    * after this method is called (to supply the initial network
  34    * configuration) and then later every time network configuration
  35    * changes. Notifications are stopped when the returned resource is
  36    * destroyed. If the plugin doesn't have access to the network list
  37    * then the callback will be called once with the
  38    * <code>network_list</code> parameter is set to 0.
  39    *
  40    * @param[in] callback The callback that will be called every time
  41    * network configuration changes or NULL to stop network monitoring.
  42    *
  43    * @param[inout] user_data The data to be passed to the callback on
  44    * each call.
  45    *
  46    * @return A <code>PP_Resource</code> containing the created
  47    * NetworkMonitor resource.
  48    */
  49   PP_Resource Create([in] PP_Instance instance,
  50                      [in] PPB_NetworkMonitor_Callback callback,
  51                      [inout] mem_t user_data);
  52
  53   /**
  54    * Determines if the specified <code>resource</code> is a
  55    * <code>NetworkMonitor</code> object.
  56    *
  57    * @param[in] resource A <code>PP_Resource</code> resource.
  58    *
  59    * @return Returns <code>PP_TRUE</code> if <code>resource</code> is
  60    * a <code>PPB_NetworkMonitor_Private</code>, <code>PP_FALSE</code>
  61    * otherwise.
  62    */
  63   PP_Bool IsNetworkMonitor([in] PP_Resource resource);
  64 };