Index: ppapi/api/ppb_network_proxy.idl |
diff --git a/ppapi/api/ppb_network_proxy.idl b/ppapi/api/ppb_network_proxy.idl |
new file mode 100644 |
index 0000000000000000000000000000000000000000..4452841f5e4bfcc4c2be20de9966612e14e7a5c5 |
--- /dev/null |
+++ b/ppapi/api/ppb_network_proxy.idl |
@@ -0,0 +1,53 @@ |
+/* Copyright (c) 2013 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. |
+ */ |
+ |
+/** |
+ * This file defines the <code>PPB_NetworkProxy</code> interface. |
+ */ |
+ |
+[generate_thunk] |
+ |
+label Chrome { |
+ M29 = 1.0 |
+}; |
+ |
+/** |
+ * This interface provides a way to determine the appropriate proxy settings |
+ * for a given URL. |
+ * |
+ * Permissions: Apps permission <code>socket</code> with subrule |
+ * <code>resolve-proxy</code> is required for using this API. |
+ * For more details about network communication permissions, please see: |
+ * http://developer.chrome.com/apps/app_network.html |
+ */ |
+[singleton] |
+interface PPB_NetworkProxy { |
+ /** |
+ * Retrieves the proxy that will be used for the given URL. The result will |
+ * be a string in PAC format. For more details about PAC format, please see |
+ * http://en.wikipedia.org/wiki/Proxy_auto-config |
+ * |
+ * @param[in] instance A <code>PP_Instance</code> identifying one instance |
+ * of a module. |
+ * |
+ * @param[in] url A string <code>PP_Var</code> containing a URL. |
+ * |
+ * @param[out] proxy_string A <code>PP_Var</code> that GetProxyForURL will |
+ * set upon successful completion. If the call fails, <code>proxy_string |
+ * </code> will be unchanged. Otherwise, it will be set to a string <code> |
+ * PP_Var</code> containing the appropriate PAC string for <code>url</code>. |
+ * If set, <code>proxy_string</code> will have a reference count of 1 which |
+ * the plugin must manage. |
+ * |
+ * @param[in] callback A <code>PP_CompletionCallback</code> to be called upon |
+ * completion. |
+ * |
+ * @return An int32_t containing an error code from <code>pp_errors.h</code>. |
+ */ |
+ int32_t GetProxyForURL([in] PP_Instance instance, |
+ [in] PP_Var url, |
+ [out] PP_Var proxy_string, |
+ [in] PP_CompletionCallback callback); |
+}; |