chrome/common/extensions/docs/extensions/experimental.socket.html - Issue 10440097: Move socket API from experimental to dev channel and remove some dead code

Unified Diff: chrome/common/extensions/docs/extensions/experimental.socket.html

Issue 10440097: Move socket API from experimental to dev channel and remove some dead code (Closed) Base URL: http://git.chromium.org/chromium/src.git@master

Patch Set: Update Created 8 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« no previous file with comments | « chrome/common/extensions/docs/extensions/experimental.html ('k') | chrome/common/extensions/docs/extensions/samples.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/extensions/experimental.socket.html

diff --git a/chrome/common/extensions/docs/extensions/experimental.socket.html b/chrome/common/extensions/docs/extensions/experimental.socket.html

deleted file mode 100644

index 58000f76e3f721475e355e9b2fe7c0f70bb098ff..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/extensions/experimental.socket.html

+++ /dev/null

@@ -1,2393 +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="extensions"> <link href="../css/ApiRefStyles.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">

-

- <!-- 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" -->

-

- <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>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="../images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" 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 type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</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>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </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>

-

- <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">SocketType</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-experimental.socket.CreateOptions">CreateOptions</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-experimental.socket.CreateInfo">CreateInfo</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-experimental.socket.ReadInfo">ReadInfo</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-experimental.socket.WriteInfo">WriteInfo</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-experimental.socket.RecvFromInfo">RecvFromInfo</a>

- <ol>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

- <p id="classSummary">

- For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.

- </p>

-

- <div id="static"></div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.experimental.socket</h2>

-

-

-

- <div id="methodsTemplate" class="apiGroup">

- <a name="global-methods"></a>

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a name="method-bind"></a>

- <h4>bind</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>address</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The address of the local machine.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>port</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The port of the local machine.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>BindCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>integer result</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-connect"></a>

- <h4>connect</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>hostname</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The hostname or IP address of the remote machine.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>port</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The port of the remote machine.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>ConnectCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>integer result</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-create"></a>

- <h4>create</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>type</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.SocketType">experimental.socket.SocketType</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The type of socket to create. Must be <code>tcp</code> or <code>udp</code>.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>options</var>

- <em>

-

- <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>

- )

- </div>

- </em>

- </dt>

- <dd>The socket options.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>CreateCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>createInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.CreateInfo">experimental.socket.CreateInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>experimental.socket.CreateInfo createInfo</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>createInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.CreateInfo">experimental.socket.CreateInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-destroy"></a>

- <h4>destroy</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div><div class="apiItem">

- <a name="method-disconnect"></a>

- <h4>disconnect</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div><div class="apiItem">

- <a name="method-read"></a>

- <h4>read</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>bufferSize</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The read buffer size.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>ReadCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>readInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.ReadInfo">experimental.socket.ReadInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>experimental.socket.ReadInfo readInfo</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>readInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.ReadInfo">experimental.socket.ReadInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-recvFrom"></a>

- <h4>recvFrom</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>bufferSize</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The receive buffer size.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>RecvFromCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>recvFromInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.RecvFromInfo">experimental.socket.RecvFromInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>experimental.socket.RecvFromInfo recvFromInfo</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>recvFromInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.RecvFromInfo">experimental.socket.RecvFromInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-sendTo"></a>

- <h4>sendTo</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>data</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>ArrayBuffer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The data to write.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>address</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The address of the remote machine.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>port</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The port of the remote machine.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>SendToCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>writeInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>experimental.socket.WriteInfo writeInfo</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>writeInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-setKeepAlive"></a>

- <h4>setKeepAlive</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>enable</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>If true, enable keep-alive functionality.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>delay</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>integer</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>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>SetKeepAliveCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>boolean result</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-setNoDelay"></a>

- <h4>setNoDelay</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>noDelay</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>If true, disable Nagle algorithm.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>SetNoDelayCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>boolean result</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-write"></a>

- <h4>write</h4>

- <div class="summary">

-

- <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>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The socketId.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>data</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>ArrayBuffer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The data to write.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>WriteCallback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>writeInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>experimental.socket.WriteInfo writeInfo</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>writeInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div>

- </div>

-

-

-

- <div class="apiGroup">

- <a name="types"></a>

- <h3 id="types">Types</h3>

-

- <div class="apiItem">

- <a name="type-experimental.socket.SocketType"></a>

- <h4>experimental.socket.SocketType</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["tcp", "udp"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-experimental.socket.CreateOptions"></a>

- <h4>experimental.socket.CreateOptions</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-experimental.socket.CreateInfo"></a>

- <h4>experimental.socket.CreateInfo</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>socketId</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The id of the newly created socket.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-experimental.socket.ReadInfo"></a>

- <h4>experimental.socket.ReadInfo</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>data</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>ArrayBuffer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>resultCode</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The resultCode returned from the underlying read() call.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-experimental.socket.WriteInfo"></a>

- <h4>experimental.socket.WriteInfo</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>bytesWritten</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The number of bytes sent, or a negative error code.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-experimental.socket.RecvFromInfo"></a>

- <h4>experimental.socket.RecvFromInfo</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>address</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The address of the remote machine.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>data</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>ArrayBuffer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>port</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>resultCode</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The resultCode returned from the underlying recvfrom() call.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- <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>

- </p>

-

-<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 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>

-

- </div>

- </div>

- </div>

-</body></html>