ppapi: PPB_VpnProvider: Define API

ppapi/c/ppb_vpn_provider.h

+/* Copyright 2016 The Chromium Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+/* From ppb_vpn_provider.idl modified Wed Apr 27 17:33:07 2016. */
+
+#ifndef PPAPI_C_PPB_VPN_PROVIDER_H_
+#define PPAPI_C_PPB_VPN_PROVIDER_H_
+
+#include "ppapi/c/pp_bool.h"
+#include "ppapi/c/pp_completion_callback.h"
+#include "ppapi/c/pp_instance.h"
+#include "ppapi/c/pp_macros.h"
+#include "ppapi/c/pp_resource.h"
+#include "ppapi/c/pp_stdint.h"
+#include "ppapi/c/pp_var.h"
+
+#define PPB_VPNPROVIDER_INTERFACE_0_1 "PPB_VpnProvider;0.1" /* dev */
+/**
+ * @file
+ * This file defines the <code>PPB_VpnProvider</code> interface.
+ */
+
+
+/**
+ * @addtogroup Interfaces
+ * @{
+ */
+/**
+ * Use the <code>PPB_VpnProvider</code> interface to implement a VPN client.
+ * Important: This API is available only on Chrome OS.
+ */
+struct PPB_VpnProvider_0_1 { /* dev */
+  /**
+   * Create() creates a VpnProvider instance.
+   *
+   * @param[in] instance A <code>PP_Instance</code> identifying the instance
+   * with the VpnProvider.
+   *
+   * @return A <code>PP_Resource</code> corresponding to a VpnProvider if
+   * successful.
+   */
+  PP_Resource (*Create)(PP_Instance instance);
+  /**
+   * IsVpnProvider() determines if the provided <code>resource</code> is a
+   * VpnProvider instance.
+   *
+   * @param[in] resource A <code>PP_Resource</code> corresponding to a
+   * VpnProvider.
+   *
+   * @return Returns <code>PP_TRUE</code> if <code>resource</code> is a
+   * <code>PPB_VpnProvider</code>, <code>PP_FALSE</code> if the
+   * <code>resource</code> is invalid or some type other than
+   * <code>PPB_VpnProvider</code>.
+   */
+  PP_Bool (*IsVpnProvider)(PP_Resource resource);
+  /**
+   * Bind() binds to an existing configuration created by
+   * <code>chrome.vpnProvider.createConfig</code>. All packets will be routed
+   * via <code>SendPacket</code> and <code>ReceivePacket</code>.
+   *
+   * @param[in] vpn_provider A <code>PP_Resource</code> corresponding to a
+   * VpnProvider.
+   *
+   * @param[in] configuration_id A <code>PP_VARTYPE_STRING</code> representing
+   * the configuration id from the callback of
+   * <code>chrome.vpnProvider.createConfig</code>.
+   *
+   * @param[in] configuration_name A <code>PP_VARTYPE_STRING</code> representing
+   * the configuration name as defined by the user when calling
+   * <code>chrome.vpnProvider.createConfig</code>.
+   *
+   * @param[in] callback A <code>PP_CompletionCallback</code> called when
+   * the configuration gets bound.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*Bind)(PP_Resource vpn_provider,
+                  struct PP_Var configuration_id,
+                  struct PP_Var configuration_name,
+                  struct PP_CompletionCallback callback);
+  /**
+   * GetUnbindEvent() registers a callback that will be called when the current
+   * configuration gets unbound.
+   *
+   * @param[in] vpn_provider A <code>PP_Resource</code> corresponding to a
+   * VpnProvider.
+   *
+   * @param[in] callback A <code>PP_CompletionCallback</code> called when
+   * the current configuration gets unbound.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*GetUnbindEvent)(PP_Resource vpn_provider,
+                            struct PP_CompletionCallback callback);
+  /**
+   * SendPacket() sends an IP packet through the tunnel created for the VPN
+   * session. This will succeed only when the VPN session is owned by the
+   * module.
+   *
+   * @param[in] vpn_provider A <code>PP_Resource</code> corresponding to a
+   * VpnProvider.
+   *
+   * @param[in] packet A <code>PP_VARTYPE_ARRAY_BUFFER</code> corresponding to
+   * an IP packet to be sent to the platform.
+   *
+   * @param[in] callback A <code>PP_CompletionCallback</code> called
+   * when SendPacket() completes.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   */
+  int32_t (*SendPacket)(PP_Resource vpn_provider,
+                        struct PP_Var packet,
+                        struct PP_CompletionCallback callback);
+  /**
+   * ReceivePacket() receives an IP packet from the tunnel for the VPN session.
+   * This function only returns a single packet. That is, this function must
+   * be called at least N times to receive N packets, no matter the size of
+   * each packet.
+   *
+   * @param[in] vpn_provider A <code>PP_Resource</code> corresponding to a
+   * VpnProvider.
+   *
+   * @param[out] packet The received packet is copied to provided
+   * <code>packet</code>. The <code>packet</code> must remain valid until
+   * ReceivePacket() completes. Its received <code>PP_VarType</code> will be
+   * <code>PP_VARTYPE_ARRAY_BUFFER</code>.
+   *
+   * @param[in] callback A <code>PP_CompletionCallback</code> called
+   * when ReceivePacket() completes.
+   *
+   * @return An int32_t containing an error code from <code>pp_errors.h</code>.
+   * If an error is detected or connection is closed, ReceivePacket() returns
+   * <code>PP_ERROR_FAILED</code> after all buffered messages are received.
+   * Until buffered packets become empty, ReceivePacket() continues to return
+   * <code>PP_OK</code> as if connection is still established without errors.
+   */
+  int32_t (*ReceivePacket)(PP_Resource vpn_provider,
+                           struct PP_Var* packet,
+                           struct PP_CompletionCallback callback);
+};
+/**
+ * @}
+ */
+
+#endif  /* PPAPI_C_PPB_VPN_PROVIDER_H_ */
+