Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(6564)

Unified Diff: chrome/common/extensions/docs/extensions/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
Index: chrome/common/extensions/docs/extensions/socket.html
diff --git a/chrome/common/extensions/docs/extensions/experimental.socket.html b/chrome/common/extensions/docs/extensions/socket.html
similarity index 93%
rename from chrome/common/extensions/docs/extensions/experimental.socket.html
rename to chrome/common/extensions/docs/extensions/socket.html
index 58000f76e3f721475e355e9b2fe7c0f70bb098ff..fcdd438cfd1d1c5c618dca8224fdda07417d4de3 100644
--- a/chrome/common/extensions/docs/extensions/experimental.socket.html
+++ b/chrome/common/extensions/docs/extensions/socket.html
@@ -17,7 +17,7 @@
<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>
+ <meta name="description" content="Documentation for the chrome.socket module, which is part of the Google Chrome extension APIs."><title>chrome.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">
@@ -186,14 +186,14 @@
</script>
<div class="g-unit" id="gc-pagecontent">
<div id="pageTitle">
- <h1 class="page_title">chrome.experimental.socket</h1>
+ <h1 class="page_title">chrome.socket</h1>
</div>
<!-- TABLE OF CONTENTS -->
<div id="toc">
<h2>Contents</h2>
<ol>
<li>
- <a href="#apiReference">API reference: chrome.experimental.socket</a>
+ <a href="#apiReference">API reference: chrome.socket</a>
<ol>
<li>
<a href="#global-methods">Methods</a>
@@ -227,27 +227,27 @@
<a href="#types">Types</a>
<ol>
<li>
- <a href="#type-experimental.socket.SocketType">SocketType</a>
+ <a href="#type-socket.SocketType">SocketType</a>
<ol>
</ol>
</li><li>
- <a href="#type-experimental.socket.CreateOptions">CreateOptions</a>
+ <a href="#type-socket.CreateOptions">CreateOptions</a>
<ol>
</ol>
</li><li>
- <a href="#type-experimental.socket.CreateInfo">CreateInfo</a>
+ <a href="#type-socket.CreateInfo">CreateInfo</a>
<ol>
</ol>
</li><li>
- <a href="#type-experimental.socket.ReadInfo">ReadInfo</a>
+ <a href="#type-socket.ReadInfo">ReadInfo</a>
<ol>
</ol>
</li><li>
- <a href="#type-experimental.socket.WriteInfo">WriteInfo</a>
+ <a href="#type-socket.WriteInfo">WriteInfo</a>
<ol>
</ol>
</li><li>
- <a href="#type-experimental.socket.RecvFromInfo">RecvFromInfo</a>
+ <a href="#type-socket.RecvFromInfo">RecvFromInfo</a>
<ol>
</ol>
</li>
@@ -259,15 +259,23 @@
</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 class="warning">
+ <!-- Standard content lead-in for APIs that are not yet available on
+ the stable channel. -->
+ <em>Warning:</em> This API is still under development. It is only
+ available for Chrome users on the
+ <span>
+ <strong>dev</strong>
+ <a href="http://www.chromium.org/getting-involved/dev-channel">early
+ release channel</a>.</span>
+ <a href="TODO">Learn more</a>.
</p>
<!-- STATIC CONTENT PLACEHOLDER -->
<div id="static"></div>
<!-- API PAGE -->
<div class="apiPage">
<a name="apiReference"></a>
- <h2>API reference: chrome.experimental.socket</h2>
+ <h2>API reference: chrome.socket</h2>
<!-- PROPERTIES -->
<!-- /apiGroup -->
<!-- METHODS -->
@@ -280,7 +288,7 @@
<h4>bind</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.bind</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -469,7 +477,7 @@
<h4>connect</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.connect</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -658,8 +666,8 @@
<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>
+ <span>chrome.socket.create</span>(<span class="null"><span>socket.SocketType</span>
+ <var><span>type</span></var></span><span class="optional"><span>, </span><span>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">
@@ -677,7 +685,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.SocketType">experimental.socket.SocketType</a>
+ <a href="socket.html#type-socket.SocketType">socket.SocketType</a>
</span>
</span>
)
@@ -701,7 +709,7 @@
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.CreateOptions">experimental.socket.CreateOptions</a>
+ <a href="socket.html#type-socket.CreateOptions">socket.CreateOptions</a>
</span>
</span>
)
@@ -752,7 +760,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.CreateInfo">experimental.socket.CreateInfo</a>
+ <a href="socket.html#type-socket.CreateInfo">socket.CreateInfo</a>
</span>
</span>
)
@@ -786,7 +794,7 @@
that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>experimental.socket.CreateInfo createInfo</span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>socket.CreateInfo createInfo</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
@@ -798,7 +806,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.CreateInfo">experimental.socket.CreateInfo</a>
+ <a href="socket.html#type-socket.CreateInfo">socket.CreateInfo</a>
</span>
</span>
)
@@ -824,7 +832,7 @@
<h4>destroy</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.destroy</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -867,7 +875,7 @@
<h4>disconnect</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.disconnect</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -910,7 +918,7 @@
<h4>read</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.read</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -1004,7 +1012,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.ReadInfo">experimental.socket.ReadInfo</a>
+ <a href="socket.html#type-socket.ReadInfo">socket.ReadInfo</a>
</span>
</span>
)
@@ -1038,7 +1046,7 @@
that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>experimental.socket.ReadInfo readInfo</span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>socket.ReadInfo readInfo</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
@@ -1050,7 +1058,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.ReadInfo">experimental.socket.ReadInfo</a>
+ <a href="socket.html#type-socket.ReadInfo">socket.ReadInfo</a>
</span>
</span>
)
@@ -1076,7 +1084,7 @@
<h4>recvFrom</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.recvFrom</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -1170,7 +1178,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.RecvFromInfo">experimental.socket.RecvFromInfo</a>
+ <a href="socket.html#type-socket.RecvFromInfo">socket.RecvFromInfo</a>
</span>
</span>
)
@@ -1204,7 +1212,7 @@
that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>experimental.socket.RecvFromInfo recvFromInfo</span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>socket.RecvFromInfo recvFromInfo</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
@@ -1216,7 +1224,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.RecvFromInfo">experimental.socket.RecvFromInfo</a>
+ <a href="socket.html#type-socket.RecvFromInfo">socket.RecvFromInfo</a>
</span>
</span>
)
@@ -1242,7 +1250,7 @@
<h4>sendTo</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.sendTo</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -1383,7 +1391,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a>
+ <a href="socket.html#type-socket.WriteInfo">socket.WriteInfo</a>
</span>
</span>
)
@@ -1417,7 +1425,7 @@
that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>experimental.socket.WriteInfo writeInfo</span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>socket.WriteInfo writeInfo</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
@@ -1429,7 +1437,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a>
+ <a href="socket.html#type-socket.WriteInfo">socket.WriteInfo</a>
</span>
</span>
)
@@ -1455,7 +1463,7 @@
<h4>setKeepAlive</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.setKeepAlive</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -1645,7 +1653,7 @@
<h4>setNoDelay</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.setNoDelay</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -1810,7 +1818,7 @@
<h4>write</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.socket.write</span>(<span class="null"><span>integer</span>
+ <span>chrome.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>
@@ -1903,7 +1911,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a>
+ <a href="socket.html#type-socket.WriteInfo">socket.WriteInfo</a>
</span>
</span>
)
@@ -1937,7 +1945,7 @@
that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>experimental.socket.WriteInfo writeInfo</span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>socket.WriteInfo writeInfo</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
@@ -1949,7 +1957,7 @@
(
<span id="typeTemplate">
<span>
- <a href="experimental.socket.html#type-experimental.socket.WriteInfo">experimental.socket.WriteInfo</a>
+ <a href="socket.html#type-socket.WriteInfo">socket.WriteInfo</a>
</span>
</span>
)
@@ -1980,8 +1988,8 @@
<h3 id="types">Types</h3>
<!-- iterates over all types -->
<div class="apiItem">
- <a name="type-experimental.socket.SocketType"></a>
- <h4>experimental.socket.SocketType</h4>
+ <a name="type-socket.SocketType"></a>
+ <h4>socket.SocketType</h4>
<div>
<dt>
<em>
@@ -2008,8 +2016,8 @@
<!-- FUNCTION PARAMETERS -->
</div>
</div><div class="apiItem">
- <a name="type-experimental.socket.CreateOptions"></a>
- <h4>experimental.socket.CreateOptions</h4>
+ <a name="type-socket.CreateOptions"></a>
+ <h4>socket.CreateOptions</h4>
<div>
<dt>
<em>
@@ -2038,8 +2046,8 @@
<!-- FUNCTION PARAMETERS -->
</div>
</div><div class="apiItem">
- <a name="type-experimental.socket.CreateInfo"></a>
- <h4>experimental.socket.CreateInfo</h4>
+ <a name="type-socket.CreateInfo"></a>
+ <h4>socket.CreateInfo</h4>
<div>
<dt>
<em>
@@ -2092,8 +2100,8 @@
<!-- FUNCTION PARAMETERS -->
</div>
</div><div class="apiItem">
- <a name="type-experimental.socket.ReadInfo"></a>
- <h4>experimental.socket.ReadInfo</h4>
+ <a name="type-socket.ReadInfo"></a>
+ <h4>socket.ReadInfo</h4>
<div>
<dt>
<em>
@@ -2171,8 +2179,8 @@
<!-- FUNCTION PARAMETERS -->
</div>
</div><div class="apiItem">
- <a name="type-experimental.socket.WriteInfo"></a>
- <h4>experimental.socket.WriteInfo</h4>
+ <a name="type-socket.WriteInfo"></a>
+ <h4>socket.WriteInfo</h4>
<div>
<dt>
<em>
@@ -2225,8 +2233,8 @@
<!-- FUNCTION PARAMETERS -->
</div>
</div><div class="apiItem">
- <a name="type-experimental.socket.RecvFromInfo"></a>
- <h4>experimental.socket.RecvFromInfo</h4>
+ <a name="type-socket.RecvFromInfo"></a>
+ <h4>socket.RecvFromInfo</h4>
<div>
<dt>
<em>
« no previous file with comments | « chrome/common/extensions/docs/extensions/samples.html ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698