Index: chrome/common/extensions/docs/apps/experimental.socket.html |
diff --git a/chrome/common/extensions/docs/apps/experimental.socket.html b/chrome/common/extensions/docs/apps/experimental.socket.html |
deleted file mode 100644 |
index b3dd71fd97bf60d3a7d274ed5fb7a2feee9f6024..0000000000000000000000000000000000000000 |
--- a/chrome/common/extensions/docs/apps/experimental.socket.html |
+++ /dev/null |
@@ -1,2022 +0,0 @@ |
-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: |
- 1) The <head> information in this page is significant, should be uniform |
- across api docs and should be edited only with knowledge of the |
- templating mechanism. |
- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a |
- browser, it will be re-generated from the template, json schema and |
- authored overview content. |
- 4) The <body>.innerHTML is also generated by an offline step so that this |
- page may easily be indexed by search engines. |
---><html xmlns="http://www.w3.org/1999/xhtml"><head> |
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
- <link href="../css/print.css" rel="stylesheet" type="text/css" media="print"> |
- <script type="text/javascript" src="../../../../third_party/jstemplate/jstemplate_compiled.js"> |
- </script> |
- <script type="text/javascript" src="../../../../../third_party/json_minify/minify-sans-regexp.js"> |
- </script> |
- <script type="text/javascript" src="../js/api_page_generator.js"></script> |
- <script type="text/javascript" src="../js/bootstrap.js"></script> |
- <script type="text/javascript" src="../js/sidebar.js"></script> |
- <meta name="description" content="Documentation for the chrome.experimental.socket module, which is part of the Google Chrome extension APIs."><title>chrome.experimental.socket - Google Chrome Extensions - Google Code</title></head> |
- <body doc-family="apps"> <link href="../css/ApiRefStyles_apps.css" rel="stylesheet" type="text/css"> |
- <link href="../css/prettify.css" rel="stylesheet" type="text/css"> |
- <link href="../css/shared.css" rel="stylesheet" type="text/css"> |
- <div id="devModeWarning" class="displayModeWarning"> |
- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. |
- </div> |
- <div id="branchWarning" class="displayModeWarning"> |
- <span>WARNING: This is the <span id="branchName">BETA</span> documentation. |
- It may not work with the stable release of Chrome.</span> |
- <select id="branchChooser"> |
- <option>Choose a different version... |
- </option><option value="">Stable |
- </option><option value="beta">Beta |
- </option><option value="dev">Dev |
- </option><option value="trunk">Trunk |
- </option></select> |
- </div> |
- <div id="unofficialWarning" class="displayModeWarning"> |
- <span>WARNING: This is unofficial documentation. It may not work with the |
- current release of Chrome.</span> |
- <button id="goToOfficialDocs">Go to the official docs</button> |
- </div> |
- <div id="gc-container" class="labs"> |
- <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> |
- <!-- In particular, sub-templates that recurse, must be used by allowing |
- jstemplate to make a copy of the template in this section which |
- are not operated on by way of the jsskip="true" --> |
- <!-- /SUBTEMPLATES --> |
- <a id="top"></a> |
- <div id="skipto"> |
- <a href="#gc-pagecontent">Skip to page content</a> |
- <a href="#gc-toc">Skip to main navigation</a> |
- </div> |
- <!-- API HEADER --> |
- <table id="header" width="100%" cellspacing="0" border="0"> |
- <tbody><tr> |
- <td valign="middle"><a href="http://code.google.com/"><img src="../images/chrome_logo.gif" alt="Google Code" style="border:0; margin:0;"></a></td> |
- <td valign="middle" width="100%" style="padding-left:0.6em;"> |
- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> |
- <div id="gsc-search-box"> |
- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> |
- <input type="hidden" name="ie" value="UTF-8"> |
- <input id="gsc-search-input" type="text" name="q" value="" size="55"> |
- <button class="gsc-search-button" type="submit" name="sa"> |
- <img class="gsc-search-button-lens" src="../images/search.png" alt="Search"> |
- </button> |
- <br> |
- <span class="greytext">e.g. "event page" or "alarms"</span> |
- </div> |
- </form> |
- <script type="text/javascript" src="https://www.google.com/jsapi"></script> |
- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> |
- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> |
- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script> |
- </td> |
- </tr> |
- </tbody></table> |
- <div id="codesiteContent" class=""> |
- <a id="gc-topnav-anchor"></a> |
- <div id="gc-topnav"> |
- <h1>Packaged Apps</h1> |
- <ul id="home" class="gc-topnav-tabs"> |
- <li id="home_link"> |
- <a href="about_apps.html" title="Packaged Apps home page"><span>Home</span></a> |
- </li> |
- <li id="docs_link"> |
- <a href="develop_apps.html" title="Packaged apps developer documentation"><span>Docs</span></a> |
- </li> |
- <li id="samples_link"> |
- <a href="https://github.com/GoogleChrome/chrome-app-samples" title="Packaged apps samples repository"><span>Samples</span></a> |
- </li> |
- <li id="group_link"> |
- <a href="http://groups.google.com/a/chromium.org/group/chromium-apps" title="Google Chrome Apps developer forum"><span>Group</span></a> |
- </li> |
- <li id="so_link"> |
- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><span>Questions?</span></a> |
- </li> |
- </ul> |
- </div> <!-- end gc-topnav --> |
- <div class="g-section g-tpl-170"> |
- <!-- SIDENAV --> |
- <div class="g-unit g-first" id="gc-toc"> |
- <ul> |
- <li><h2>Getting Started</h2> |
- <ul> |
- <li><a href="about_apps.html">What Are Packaged Apps?</a></li> |
- <li><a href="app_architecture.html">Understand the Architecture</a></li> |
- <li><a href="first_app.html">Create Your First App</a></li> |
- </ul> |
- </li> |
- <li><h2>Developing</h2> |
- <ul> |
- <li><a href="develop_apps.html">Before You Start</a></li> |
- <li><span>The Fundamentals</span> |
- <ul> |
- <li><a href="app_lifecycle.html">Manage App Lifecycle</a></li> |
- <li><a href="app_storage.html">Manage Data</a></li> |
- <li><a href="offline_apps.html">Offline First</a></li> |
- <li><a href="app_external.html">Embed Content</a></li> |
- </ul> |
- </li> |
- <li><span>Security & Privacy</span> |
- <ul> |
- <li><a href="app_identity.html">Identify User</a></li> |
- <li><a href="app_csp.html">Comply with CSP</a></li> |
- </ul> |
- </li> |
- <li><span>Advanced Technologies</span> |
- <ul> |
- <li><a href="app_network.html">Network Communications</a></li> |
- <li><a href="app_hardware.html">Access Hardware Devices</a></li> |
- <li><a href="app_intents.html">Connect Apps with Web Intents</a></li> |
- </ul> |
- </li> |
- <li><a href="app_frameworks.html">MVC Architecture</a></li> |
- </ul> |
- </li> |
- <li><h2>Deploying</h2> |
- <ul> |
- <li><a href="publish_app.html">Publish</a></li> |
- </ul> |
- </li> |
- <li><h2>Reference</h2> |
- <ul> |
- <li><a href="manifest.html">Manifest Files</a></li> |
- <li><a href="api_index.html">Chrome JavaScript APIs</a></li> |
- <li><a href="api_other.html">Supported Libraries</a></li> |
- <li><a href="app_deprecated.html">Disabled Web Features</a></li> |
- </ul> |
- </li> |
- <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">Samples</a></h2></li> |
- <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li> |
- </ul> |
- </div> |
- <script> |
- initToggles(); |
- </script> |
- <div class="g-unit" id="gc-pagecontent"> |
- <div id="pageTitle"> |
- <h1 class="page_title">chrome.experimental.socket</h1> |
- </div> |
- <!-- TABLE OF CONTENTS --> |
- <div id="toc"> |
- <h2>Contents</h2> |
- <ol> |
- <li> |
- <a href="#apiReference">API reference: chrome.experimental.socket</a> |
- <ol> |
- <li> |
- <a href="#global-methods">Methods</a> |
- <ol> |
- <li> |
- <a href="#method-bind">bind</a> |
- </li><li> |
- <a href="#method-connect">connect</a> |
- </li><li> |
- <a href="#method-create">create</a> |
- </li><li> |
- <a href="#method-destroy">destroy</a> |
- </li><li> |
- <a href="#method-disconnect">disconnect</a> |
- </li><li> |
- <a href="#method-read">read</a> |
- </li><li> |
- <a href="#method-recvFrom">recvFrom</a> |
- </li><li> |
- <a href="#method-sendTo">sendTo</a> |
- </li><li> |
- <a href="#method-setKeepAlive">setKeepAlive</a> |
- </li><li> |
- <a href="#method-setNoDelay">setNoDelay</a> |
- </li><li> |
- <a href="#method-write">write</a> |
- </li> |
- </ol> |
- </li> |
- <li> |
- <a href="#types">Types</a> |
- <ol> |
- <li> |
- <a href="#type-experimental.socket.SocketType">experimental.socket.SocketType</a> |
- <ol> |
- </ol> |
- </li><li> |
- <a href="#type-experimental.socket.CreateOptions">experimental.socket.CreateOptions</a> |
- <ol> |
- </ol> |
- </li><li> |
- <a href="#type-experimental.socket.CreateInfo">experimental.socket.CreateInfo</a> |
- <ol> |
- </ol> |
- </li><li> |
- <a href="#type-experimental.socket.ReadInfo">experimental.socket.ReadInfo</a> |
- <ol> |
- </ol> |
- </li><li> |
- <a href="#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a> |
- <ol> |
- </ol> |
- </li><li> |
- <a href="#type-experimental.socket.RecvFromInfo">experimental.socket.RecvFromInfo</a> |
- <ol> |
- </ol> |
- </li> |
- </ol> |
- </li> |
- </ol> |
- </li> |
- </ol> |
- </div> |
- <!-- /TABLE OF CONTENTS --> |
- <!-- Standard content lead-in for experimental API pages --> |
- <p id="classSummary"> |
- For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. |
- </p> |
- <!-- STATIC CONTENT PLACEHOLDER --> |
- <div id="static"></div> |
- <!-- API PAGE --> |
- <div class="apiPage"> |
- <a name="apiReference"></a> |
- <h2>API reference: chrome.experimental.socket</h2> |
- <!-- PROPERTIES --> |
- <!-- /apiGroup --> |
- <!-- METHODS --> |
- <div id="methodsTemplate" class="apiGroup"> |
- <a name="global-methods"></a> |
- <h3>Methods</h3> |
- <!-- iterates over all functions --> |
- <div class="apiItem"> |
- <a name="method-bind"></a> <!-- method-anchor --> |
- <h4>bind</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.bind</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span><span class="null"><span>, </span><span>string</span> |
- <var><span>address</span></var></span><span class="null"><span>, </span><span>integer</span> |
- <var><span>port</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>BindCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Binds the local address for socket. Currently, it does not support TCP socket.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>address</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>string</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The address of the local machine.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>port</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The port of the local machine.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>BindCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>result</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-connect"></a> <!-- method-anchor --> |
- <h4>connect</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.connect</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span><span class="null"><span>, </span><span>string</span> |
- <var><span>hostname</span></var></span><span class="null"><span>, </span><span>integer</span> |
- <var><span>port</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>ConnectCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Connects the socket to the remote machine.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>hostname</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>string</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The hostname or IP address of the remote machine.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>port</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The port of the remote machine.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>ConnectCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>result</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-create"></a> <!-- method-anchor --> |
- <h4>create</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.create</span>(<span class="null"><span>experimental.socket.SocketType</span> |
- <var><span>type</span></var></span><span class="optional"><span>, </span><span>experimental.socket.CreateOptions</span> |
- <var><span>options</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>CreateCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Creates a socket of the specified type that will connect to the specified remote machine.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>type</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <a href="experimental.socket.html#type-experimental.socket.SocketType">experimental.socket.SocketType</a> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The type of socket to create. Must be <code>tcp</code> or <code>udp</code>.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>options</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span class="optional">optional</span> |
- <span id="typeTemplate"> |
- <span> |
- <a href="experimental.socket.html#type-experimental.socket.CreateOptions">experimental.socket.CreateOptions</a> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socket options.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>CreateCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>createInfo</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <a href="experimental.socket.html#type-experimental.socket.CreateInfo">experimental.socket.CreateInfo</a> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-destroy"></a> <!-- method-anchor --> |
- <h4>destroy</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.destroy</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span>)</div> |
- <div class="description"> |
- <p>Destroys the socket. Each socket created should be destroyed after use.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-disconnect"></a> <!-- method-anchor --> |
- <h4>disconnect</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.disconnect</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span>)</div> |
- <div class="description"> |
- <p>Disconnects the socket. For UDP sockets, <code>disconnect</code> is a non-operation but is safe to call.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-read"></a> <!-- method-anchor --> |
- <h4>read</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.read</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span><span class="optional"><span>, </span><span>integer</span> |
- <var><span>bufferSize</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>ReadCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Reads data from the given connected socket.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>bufferSize</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span class="optional">optional</span> |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The read buffer size.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>ReadCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>readInfo</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <a href="experimental.socket.html#type-experimental.socket.ReadInfo">experimental.socket.ReadInfo</a> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-recvFrom"></a> <!-- method-anchor --> |
- <h4>recvFrom</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.recvFrom</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span><span class="optional"><span>, </span><span>integer</span> |
- <var><span>bufferSize</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>RecvFromCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Receives data from the given UDP socket.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>bufferSize</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span class="optional">optional</span> |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The receive buffer size.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>RecvFromCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>recvFromInfo</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <a href="experimental.socket.html#type-experimental.socket.RecvFromInfo">experimental.socket.RecvFromInfo</a> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-sendTo"></a> <!-- method-anchor --> |
- <h4>sendTo</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.sendTo</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span><span class="null"><span>, </span><span>ArrayBuffer</span> |
- <var><span>data</span></var></span><span class="null"><span>, </span><span>string</span> |
- <var><span>address</span></var></span><span class="null"><span>, </span><span>integer</span> |
- <var><span>port</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>SendToCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Sends data on the given UDP socket to the given address and port.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>data</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>ArrayBuffer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The data to write.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>address</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>string</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The address of the remote machine.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>port</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The port of the remote machine.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>SendToCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>writeInfo</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-setKeepAlive"></a> <!-- method-anchor --> |
- <h4>setKeepAlive</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.setKeepAlive</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span><span class="null"><span>, </span><span>boolean</span> |
- <var><span>enable</span></var></span><span class="optional"><span>, </span><span>integer</span> |
- <var><span>delay</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>SetKeepAliveCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Enable/disable keep-alive functionality for a TCP connection.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>enable</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>boolean</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>If true, enable keep-alive functionality.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>delay</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span class="optional">optional</span> |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>Set the delay seconds between the last data packet received and the first keepalive probe. Default is 0.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>SetKeepAliveCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>result</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>boolean</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-setNoDelay"></a> <!-- method-anchor --> |
- <h4>setNoDelay</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.setNoDelay</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span><span class="null"><span>, </span><span>boolean</span> |
- <var><span>noDelay</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>SetNoDelayCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Enable/disable Nagle algorithm.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>noDelay</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>boolean</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>If true, disable Nagle algorithm.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>SetNoDelayCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>result</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>boolean</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div><div class="apiItem"> |
- <a name="method-write"></a> <!-- method-anchor --> |
- <h4>write</h4> |
- <div class="summary"> |
- <!-- Note: intentionally longer 80 columns --> |
- <span>chrome.experimental.socket.write</span>(<span class="null"><span>integer</span> |
- <var><span>socketId</span></var></span><span class="null"><span>, </span><span>ArrayBuffer</span> |
- <var><span>data</span></var></span><span class="null"><span>, </span><span>function</span> |
- <var><span>WriteCallback</span></var></span>)</div> |
- <div class="description"> |
- <p>Writes data on the given connected socket.</p> |
- <!-- PARAMETERS --> |
- <h4>Parameters</h4> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The socketId.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>data</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>ArrayBuffer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The data to write.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>WriteCallback</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>function</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- <dd> |
- <div> |
- <h5>Parameters</h5> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>writeInfo</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </div> |
- </dd> |
- </div> |
- </div> |
- </dl> |
- <!-- RETURNS --> |
- <dl> |
- </dl> |
- <!-- CALLBACK --> |
- <!-- MIN_VERSION --> |
- </div> <!-- /description --> |
- </div> <!-- /apiItem --> |
- </div> <!-- /apiGroup --> |
- <!-- EVENTS --> |
- <!-- /apiGroup --> |
- <!-- TYPES --> |
- <div class="apiGroup"> |
- <a name="types"></a> |
- <h3 id="types">Types</h3> |
- <!-- iterates over all types --> |
- <div class="apiItem"> |
- <a name="type-experimental.socket.SocketType"></a> |
- <h4>experimental.socket.SocketType</h4> |
- <div> |
- <dt> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span class="enum">enumerated</span> |
- <span id="typeTemplate"> |
- <span> |
- <span>string</span> |
- <span>["tcp", "udp"]</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div class="apiItem"> |
- <a name="type-experimental.socket.CreateOptions"></a> |
- <h4>experimental.socket.CreateOptions</h4> |
- <div> |
- <dt> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>object</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <dd> |
- <dl> |
- </dl> |
- </dd> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div class="apiItem"> |
- <a name="type-experimental.socket.CreateInfo"></a> |
- <h4>experimental.socket.CreateInfo</h4> |
- <div> |
- <dt> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>object</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <dd> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>socketId</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The id of the newly created socket.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </dd> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div class="apiItem"> |
- <a name="type-experimental.socket.ReadInfo"></a> |
- <h4>experimental.socket.ReadInfo</h4> |
- <div> |
- <dt> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>object</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <dd> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>data</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>ArrayBuffer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>resultCode</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The resultCode returned from the underlying read() call.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </dd> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div class="apiItem"> |
- <a name="type-experimental.socket.WriteInfo"></a> |
- <h4>experimental.socket.WriteInfo</h4> |
- <div> |
- <dt> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>object</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <dd> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>bytesWritten</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The number of bytes sent, or a negative error code.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </dd> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div class="apiItem"> |
- <a name="type-experimental.socket.RecvFromInfo"></a> |
- <h4>experimental.socket.RecvFromInfo</h4> |
- <div> |
- <dt> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>object</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <dd> |
- <dl> |
- <div> |
- <div> |
- <dt> |
- <var>address</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>string</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The address of the remote machine.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>data</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>ArrayBuffer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>port</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd class="todo"> |
- Undocumented. |
- </dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div><div> |
- <div> |
- <dt> |
- <var>resultCode</var> |
- <em> |
- <!-- TYPE --> |
- <div style="display:inline"> |
- ( |
- <span id="typeTemplate"> |
- <span> |
- <span>integer</span> |
- </span> |
- </span> |
- ) |
- </div> |
- </em> |
- </dt> |
- <dd>The resultCode returned from the underlying recvfrom() call.</dd> |
- <!-- OBJECT PROPERTIES --> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> |
- </dl> |
- </dd> |
- <!-- OBJECT METHODS --> |
- <!-- OBJECT EVENT FIELDS --> |
- <!-- FUNCTION PARAMETERS --> |
- </div> |
- </div> <!-- /apiItem --> |
- </div> <!-- /apiGroup --> |
- </div> <!-- /apiPage --> |
- </div> <!-- /gc-pagecontent --> |
- </div> <!-- /g-section --> |
- </div> <!-- /codesiteContent --> |
- <div id="gc-footer" --=""> |
- <div class="text"> |
- <p> |
- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, |
- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons |
- Attribution 3.0 License</a>, and code samples are licensed under the |
- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. |
- </p> |
- <p> |
- ©2012 Google |
- </p> |
-<!-- begin analytics --> |
-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script> |
-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script> |
-<script src="../js/prettify.js" type="text/javascript"></script> |
-<script> |
- // Auto syntax highlight all pre tags. |
- var pres = document.querySelectorAll('pre'); |
- for (var i = 0, pre; pre = pres[i]; ++i) { |
- pre.className += ' prettyprint'; |
- }; |
- prettyPrint(); |
-</script> |
-<script type="text/javascript"> |
- // chrome doc tracking |
- try { |
- var engdocs = _gat._getTracker("YT-10763712-2"); |
- engdocs._trackPageview(); |
- } catch(err) {} |
- // code.google.com site-wide tracking |
- try { |
- _uacct="UA-18071-1"; |
- _uanchor=1; |
- _uff=0; |
- urchinTracker(); |
- } |
- catch(e) {/* urchinTracker not available. */} |
-</script> |
-<!-- end analytics --> |
- </div> |
- </div> <!-- /gc-footer --> |
- </div> <!-- /gc-container --> |
-</body></html> |