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

Side by Side Diff: chrome/common/extensions/docs/apps/socket.html

Issue 10790137: Adds socket.getInfo to the socket API (Closed) Base URL: http://git.chromium.org/chromium/src.git@master
Patch Set: Check for NULL TCPSocket, updated test Created 8 years, 4 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 unified diff | Download patch
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
(...skipping 162 matching lines...) Expand 10 before | Expand all | Expand 10 after
173 <a href="#method-bind">bind</a> 173 <a href="#method-bind">bind</a>
174 </li><li> 174 </li><li>
175 <a href="#method-connect">connect</a> 175 <a href="#method-connect">connect</a>
176 </li><li> 176 </li><li>
177 <a href="#method-create">create</a> 177 <a href="#method-create">create</a>
178 </li><li> 178 </li><li>
179 <a href="#method-destroy">destroy</a> 179 <a href="#method-destroy">destroy</a>
180 </li><li> 180 </li><li>
181 <a href="#method-disconnect">disconnect</a> 181 <a href="#method-disconnect">disconnect</a>
182 </li><li> 182 </li><li>
183 <a href="#method-getInfo">getInfo</a>
184 </li><li>
183 <a href="#method-read">read</a> 185 <a href="#method-read">read</a>
184 </li><li> 186 </li><li>
185 <a href="#method-recvFrom">recvFrom</a> 187 <a href="#method-recvFrom">recvFrom</a>
186 </li><li> 188 </li><li>
187 <a href="#method-sendTo">sendTo</a> 189 <a href="#method-sendTo">sendTo</a>
188 </li><li> 190 </li><li>
189 <a href="#method-setKeepAlive">setKeepAlive</a> 191 <a href="#method-setKeepAlive">setKeepAlive</a>
190 </li><li> 192 </li><li>
191 <a href="#method-setNoDelay">setNoDelay</a> 193 <a href="#method-setNoDelay">setNoDelay</a>
192 </li><li> 194 </li><li>
(...skipping 21 matching lines...) Expand all
214 <ol> 216 <ol>
215 </ol> 217 </ol>
216 </li><li> 218 </li><li>
217 <a href="#type-socket.WriteInfo">socket.WriteInfo</a> 219 <a href="#type-socket.WriteInfo">socket.WriteInfo</a>
218 <ol> 220 <ol>
219 </ol> 221 </ol>
220 </li><li> 222 </li><li>
221 <a href="#type-socket.RecvFromInfo">socket.RecvFromInfo</a> 223 <a href="#type-socket.RecvFromInfo">socket.RecvFromInfo</a>
222 <ol> 224 <ol>
223 </ol> 225 </ol>
226 </li><li>
227 <a href="#type-experimental.socket.SocketInfo">experimental.sock et.SocketInfo</a>
228 <ol>
229 </ol>
224 </li> 230 </li>
225 </ol> 231 </ol>
226 </li> 232 </li>
227 </ol> 233 </ol>
228 </li> 234 </li>
229 </ol> 235 </ol>
230 </div> 236 </div>
231 <!-- /TABLE OF CONTENTS --> 237 <!-- /TABLE OF CONTENTS -->
232 <!-- Standard content lead-in for experimental API pages --> 238 <!-- Standard content lead-in for experimental API pages -->
233 <p class="warning"> 239 <p class="warning">
(...skipping 174 matching lines...) Expand 10 before | Expand all | Expand 10 after
408 <a name="method-connect"></a> <!-- method-anchor --> 414 <a name="method-connect"></a> <!-- method-anchor -->
409 <h4>connect</h4> 415 <h4>connect</h4>
410 <div class="summary"> 416 <div class="summary">
411 <!-- Note: intentionally longer 80 columns --> 417 <!-- Note: intentionally longer 80 columns -->
412 <span>chrome.socket.connect</span>(<span class="null"><span>in teger</span> 418 <span>chrome.socket.connect</span>(<span class="null"><span>in teger</span>
413 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>string</span> 419 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>string</span>
414 <var><span>hostname</span></var></span><span class="null"> <span>, </span><span>integer</span> 420 <var><span>hostname</span></var></span><span class="null"> <span>, </span><span>integer</span>
415 <var><span>port</span></var></span><span class="null"><spa n>, </span><span>function</span> 421 <var><span>port</span></var></span><span class="null"><spa n>, </span><span>function</span>
416 <var><span>ConnectCallback</span></var></span>)</div> 422 <var><span>ConnectCallback</span></var></span>)</div>
417 <div class="description"> 423 <div class="description">
418 <p>Connects the socket to the remote machine.</p> 424 <p>Connects the socket to the remote machine (for a <code>tcp</c ode> socket). For a <code>udp</code> socket, this sets the default address which packets are sent to and read from for <code>read()</code> and <code>write()</co de> calls.</p>
419 <!-- PARAMETERS --> 425 <!-- PARAMETERS -->
420 <h4>Parameters</h4> 426 <h4>Parameters</h4>
421 <dl> 427 <dl>
422 <div> 428 <div>
423 <div> 429 <div>
424 <dt> 430 <dt>
425 <var>socketId</var> 431 <var>socketId</var>
426 <em> 432 <em>
427 <!-- TYPE --> 433 <!-- TYPE -->
428 <div style="display:inline"> 434 <div style="display:inline">
(...skipping 332 matching lines...) Expand 10 before | Expand all | Expand 10 after
761 </div> 767 </div>
762 </div> 768 </div>
763 </dl> 769 </dl>
764 <!-- RETURNS --> 770 <!-- RETURNS -->
765 <dl> 771 <dl>
766 </dl> 772 </dl>
767 <!-- CALLBACK --> 773 <!-- CALLBACK -->
768 <!-- MIN_VERSION --> 774 <!-- MIN_VERSION -->
769 </div> <!-- /description --> 775 </div> <!-- /description -->
770 </div><div class="apiItem"> 776 </div><div class="apiItem">
777 <a name="method-getInfo"></a> <!-- method-anchor -->
778 <h4>getInfo</h4>
779 <div class="summary">
780 <!-- Note: intentionally longer 80 columns -->
781 <span>chrome.experimental.socket.getInfo</span>(<span class="n ull"><span>integer</span>
782 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>function</span>
783 <var><span>GetInfoCallback</span></var></span>)</div>
784 <div class="description">
785 <p>Retrieves the state of the given socket.</p>
786 <!-- PARAMETERS -->
787 <h4>Parameters</h4>
788 <dl>
789 <div>
790 <div>
791 <dt>
792 <var>socketId</var>
793 <em>
794 <!-- TYPE -->
795 <div style="display:inline">
796 (
797 <span id="typeTemplate">
798 <span>
799 <span>integer</span>
800 </span>
801 </span>
802 )
803 </div>
804 </em>
805 </dt>
806 <dd>The socketId.</dd>
807 <!-- OBJECT PROPERTIES -->
808 <!-- OBJECT METHODS -->
809 <!-- OBJECT EVENT FIELDS -->
810 <!-- FUNCTION PARAMETERS -->
811 </div>
812 </div><div>
813 <div>
814 <dt>
815 <var>GetInfoCallback</var>
816 <em>
817 <!-- TYPE -->
818 <div style="display:inline">
819 (
820 <span id="typeTemplate">
821 <span>
822 <span>function</span>
823 </span>
824 </span>
825 )
826 </div>
827 </em>
828 </dt>
829 <dd class="todo">
830 Undocumented.
831 </dd>
832 <!-- OBJECT PROPERTIES -->
833 <!-- OBJECT METHODS -->
834 <!-- OBJECT EVENT FIELDS -->
835 <!-- FUNCTION PARAMETERS -->
836 <dd>
837 <div>
838 <h5>Parameters</h5>
839 <dl>
840 <div>
841 <div>
842 <dt>
843 <var>result</var>
844 <em>
845 <!-- TYPE -->
846 <div style="display:inline">
847 (
848 <span id="typeTemplate">
849 <span>
850 <a href="experimental.socket.html#type-experimental.sock et.SocketInfo">experimental.socket.SocketInfo</a>
851 </span>
852 </span>
853 )
854 </div>
855 </em>
856 </dt>
857 <dd class="todo">
858 Undocumented.
859 </dd>
860 <!-- OBJECT PROPERTIES -->
861 <!-- OBJECT METHODS -->
862 <!-- OBJECT EVENT FIELDS -->
863 <!-- FUNCTION PARAMETERS -->
864 </div>
865 </div>
866 </dl>
867 </div>
868 </dd>
869 </div>
870 </div>
871 </dl>
872 <!-- RETURNS -->
873 <dl>
874 </dl>
875 <!-- CALLBACK -->
876 <!-- MIN_VERSION -->
877 </div> <!-- /description -->
878 </div><div class="apiItem">
771 <a name="method-read"></a> <!-- method-anchor --> 879 <a name="method-read"></a> <!-- method-anchor -->
772 <h4>read</h4> 880 <h4>read</h4>
773 <div class="summary"> 881 <div class="summary">
774 <!-- Note: intentionally longer 80 columns --> 882 <!-- Note: intentionally longer 80 columns -->
775 <span>chrome.socket.read</span>(<span class="null"><span>integ er</span> 883 <span>chrome.socket.read</span>(<span class="null"><span>integ er</span>
776 <var><span>socketId</span></var></span><span class="option al"><span>, </span><span>integer</span> 884 <var><span>socketId</span></var></span><span class="option al"><span>, </span><span>integer</span>
777 <var><span>bufferSize</span></var></span><span class="null "><span>, </span><span>function</span> 885 <var><span>bufferSize</span></var></span><span class="null "><span>, </span><span>function</span>
778 <var><span>ReadCallback</span></var></span>)</div> 886 <var><span>ReadCallback</span></var></span>)</div>
779 <div class="description"> 887 <div class="description">
780 <p>Reads data from the given connected socket.</p> 888 <p>Reads data from the given connected socket.</p>
(...skipping 418 matching lines...) Expand 10 before | Expand all | Expand 10 after
1199 <a name="method-setKeepAlive"></a> <!-- method-anchor --> 1307 <a name="method-setKeepAlive"></a> <!-- method-anchor -->
1200 <h4>setKeepAlive</h4> 1308 <h4>setKeepAlive</h4>
1201 <div class="summary"> 1309 <div class="summary">
1202 <!-- Note: intentionally longer 80 columns --> 1310 <!-- Note: intentionally longer 80 columns -->
1203 <span>chrome.socket.setKeepAlive</span>(<span class="null"><sp an>integer</span> 1311 <span>chrome.socket.setKeepAlive</span>(<span class="null"><sp an>integer</span>
1204 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>boolean</span> 1312 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>boolean</span>
1205 <var><span>enable</span></var></span><span class="optional "><span>, </span><span>integer</span> 1313 <var><span>enable</span></var></span><span class="optional "><span>, </span><span>integer</span>
1206 <var><span>delay</span></var></span><span class="null"><sp an>, </span><span>function</span> 1314 <var><span>delay</span></var></span><span class="null"><sp an>, </span><span>function</span>
1207 <var><span>SetKeepAliveCallback</span></var></span>)</div> 1315 <var><span>SetKeepAliveCallback</span></var></span>)</div>
1208 <div class="description"> 1316 <div class="description">
1209 <p>Enable/disable keep-alive functionality for a TCP connection. </p> 1317 <p>Enables or disables the keep-alive functionality for a TCP co nnection.</p>
1210 <!-- PARAMETERS --> 1318 <!-- PARAMETERS -->
1211 <h4>Parameters</h4> 1319 <h4>Parameters</h4>
1212 <dl> 1320 <dl>
1213 <div> 1321 <div>
1214 <div> 1322 <div>
1215 <dt> 1323 <dt>
1216 <var>socketId</var> 1324 <var>socketId</var>
1217 <em> 1325 <em>
1218 <!-- TYPE --> 1326 <!-- TYPE -->
1219 <div style="display:inline"> 1327 <div style="display:inline">
(...skipping 129 matching lines...) Expand 10 before | Expand all | Expand 10 after
1349 </div><div class="apiItem"> 1457 </div><div class="apiItem">
1350 <a name="method-setNoDelay"></a> <!-- method-anchor --> 1458 <a name="method-setNoDelay"></a> <!-- method-anchor -->
1351 <h4>setNoDelay</h4> 1459 <h4>setNoDelay</h4>
1352 <div class="summary"> 1460 <div class="summary">
1353 <!-- Note: intentionally longer 80 columns --> 1461 <!-- Note: intentionally longer 80 columns -->
1354 <span>chrome.socket.setNoDelay</span>(<span class="null"><span >integer</span> 1462 <span>chrome.socket.setNoDelay</span>(<span class="null"><span >integer</span>
1355 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>boolean</span> 1463 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>boolean</span>
1356 <var><span>noDelay</span></var></span><span class="null">< span>, </span><span>function</span> 1464 <var><span>noDelay</span></var></span><span class="null">< span>, </span><span>function</span>
1357 <var><span>SetNoDelayCallback</span></var></span>)</div> 1465 <var><span>SetNoDelayCallback</span></var></span>)</div>
1358 <div class="description"> 1466 <div class="description">
1359 <p>Enable/disable Nagle algorithm.</p> 1467 <p>Sets or clears <code>TCP_NODELAY</code> for a TCP connection. Nagle's algorithm will be disabled when <code>TCP_NODELAY</code> is set.</p>
1360 <!-- PARAMETERS --> 1468 <!-- PARAMETERS -->
1361 <h4>Parameters</h4> 1469 <h4>Parameters</h4>
1362 <dl> 1470 <dl>
1363 <div> 1471 <div>
1364 <div> 1472 <div>
1365 <dt> 1473 <dt>
1366 <var>socketId</var> 1474 <var>socketId</var>
1367 <em> 1475 <em>
1368 <!-- TYPE --> 1476 <!-- TYPE -->
1369 <div style="display:inline"> 1477 <div style="display:inline">
(...skipping 23 matching lines...) Expand all
1393 ( 1501 (
1394 <span id="typeTemplate"> 1502 <span id="typeTemplate">
1395 <span> 1503 <span>
1396 <span>boolean</span> 1504 <span>boolean</span>
1397 </span> 1505 </span>
1398 </span> 1506 </span>
1399 ) 1507 )
1400 </div> 1508 </div>
1401 </em> 1509 </em>
1402 </dt> 1510 </dt>
1403 <dd>If true, disable Nagle algorithm.</dd> 1511 <dd>If true, disables Nagle's algorithm.</dd>
1404 <!-- OBJECT PROPERTIES --> 1512 <!-- OBJECT PROPERTIES -->
1405 <!-- OBJECT METHODS --> 1513 <!-- OBJECT METHODS -->
1406 <!-- OBJECT EVENT FIELDS --> 1514 <!-- OBJECT EVENT FIELDS -->
1407 <!-- FUNCTION PARAMETERS --> 1515 <!-- FUNCTION PARAMETERS -->
1408 </div> 1516 </div>
1409 </div><div> 1517 </div><div>
1410 <div> 1518 <div>
1411 <dt> 1519 <dt>
1412 <var>SetNoDelayCallback</var> 1520 <var>SetNoDelayCallback</var>
1413 <em> 1521 <em>
(...skipping 558 matching lines...) Expand 10 before | Expand all | Expand 10 after
1972 <!-- OBJECT EVENT FIELDS --> 2080 <!-- OBJECT EVENT FIELDS -->
1973 <!-- FUNCTION PARAMETERS --> 2081 <!-- FUNCTION PARAMETERS -->
1974 </div> 2082 </div>
1975 </div> 2083 </div>
1976 </dl> 2084 </dl>
1977 </dd> 2085 </dd>
1978 <!-- OBJECT METHODS --> 2086 <!-- OBJECT METHODS -->
1979 <!-- OBJECT EVENT FIELDS --> 2087 <!-- OBJECT EVENT FIELDS -->
1980 <!-- FUNCTION PARAMETERS --> 2088 <!-- FUNCTION PARAMETERS -->
1981 </div> 2089 </div>
2090 </div><div class="apiItem">
2091 <a name="type-experimental.socket.SocketInfo"></a>
2092 <h4>experimental.socket.SocketInfo</h4>
2093 <div>
2094 <dt>
2095 <em>
2096 <!-- TYPE -->
2097 <div style="display:inline">
2098 (
2099 <span id="typeTemplate">
2100 <span>
2101 <span>object</span>
2102 </span>
2103 </span>
2104 )
2105 </div>
2106 </em>
2107 </dt>
2108 <dd class="todo">
2109 Undocumented.
2110 </dd>
2111 <!-- OBJECT PROPERTIES -->
2112 <dd>
2113 <dl>
2114 <div>
2115 <div>
2116 <dt>
2117 <var>connected</var>
2118 <em>
2119 <!-- TYPE -->
2120 <div style="display:inline">
2121 (
2122 <span id="typeTemplate">
2123 <span>
2124 <span>boolean</span>
2125 </span>
2126 </span>
2127 )
2128 </div>
2129 </em>
2130 </dt>
2131 <dd>Whether or not the underlying socket is connected. For <code>tcp</ code> sockets, this will remain true even if the remote peer has disconnected. R eading or writing to the socket may then result in an error, hinting that this s ocket should be disconnected via <code>disconnect()</code>. For <code>udp</code> sockets, this just represents whether a default remote address has been specifi ed for reading and writing packets.</dd>
2132 <!-- OBJECT PROPERTIES -->
2133 <!-- OBJECT METHODS -->
2134 <!-- OBJECT EVENT FIELDS -->
2135 <!-- FUNCTION PARAMETERS -->
2136 </div>
2137 </div><div>
2138 <div>
2139 <dt>
2140 <var>localAddress</var>
2141 <em>
2142 <!-- TYPE -->
2143 <div style="display:inline">
2144 (
2145 <span class="optional">optional</span>
2146 <span id="typeTemplate">
2147 <span>
2148 <span>string</span>
2149 </span>
2150 </span>
2151 )
2152 </div>
2153 </em>
2154 </dt>
2155 <dd>If the underlying socket is bound or connected, contains its local IPv4/6 address.</dd>
2156 <!-- OBJECT PROPERTIES -->
2157 <!-- OBJECT METHODS -->
2158 <!-- OBJECT EVENT FIELDS -->
2159 <!-- FUNCTION PARAMETERS -->
2160 </div>
2161 </div><div>
2162 <div>
2163 <dt>
2164 <var>localPort</var>
2165 <em>
2166 <!-- TYPE -->
2167 <div style="display:inline">
2168 (
2169 <span class="optional">optional</span>
2170 <span id="typeTemplate">
2171 <span>
2172 <span>integer</span>
2173 </span>
2174 </span>
2175 )
2176 </div>
2177 </em>
2178 </dt>
2179 <dd>If the underlying socket is bound or connected, contains its local port.</dd>
2180 <!-- OBJECT PROPERTIES -->
2181 <!-- OBJECT METHODS -->
2182 <!-- OBJECT EVENT FIELDS -->
2183 <!-- FUNCTION PARAMETERS -->
2184 </div>
2185 </div><div>
2186 <div>
2187 <dt>
2188 <var>peerAddress</var>
2189 <em>
2190 <!-- TYPE -->
2191 <div style="display:inline">
2192 (
2193 <span class="optional">optional</span>
2194 <span id="typeTemplate">
2195 <span>
2196 <span>string</span>
2197 </span>
2198 </span>
2199 )
2200 </div>
2201 </em>
2202 </dt>
2203 <dd>If the underlying socket is connected, contains the IPv4/6 address of the peer.</dd>
2204 <!-- OBJECT PROPERTIES -->
2205 <!-- OBJECT METHODS -->
2206 <!-- OBJECT EVENT FIELDS -->
2207 <!-- FUNCTION PARAMETERS -->
2208 </div>
2209 </div><div>
2210 <div>
2211 <dt>
2212 <var>peerPort</var>
2213 <em>
2214 <!-- TYPE -->
2215 <div style="display:inline">
2216 (
2217 <span class="optional">optional</span>
2218 <span id="typeTemplate">
2219 <span>
2220 <span>integer</span>
2221 </span>
2222 </span>
2223 )
2224 </div>
2225 </em>
2226 </dt>
2227 <dd>If the underlying socket is connected, contains the port of the co nnected peer.</dd>
2228 <!-- OBJECT PROPERTIES -->
2229 <!-- OBJECT METHODS -->
2230 <!-- OBJECT EVENT FIELDS -->
2231 <!-- FUNCTION PARAMETERS -->
2232 </div>
2233 </div><div>
2234 <div>
2235 <dt>
2236 <var>socketType</var>
2237 <em>
2238 <!-- TYPE -->
2239 <div style="display:inline">
2240 (
2241 <span id="typeTemplate">
2242 <span>
2243 <a href="experimental.socket.html#type-experimental.sock et.SocketType">experimental.socket.SocketType</a>
2244 </span>
2245 </span>
2246 )
2247 </div>
2248 </em>
2249 </dt>
2250 <dd>The type of the passed socket. This will be <code>tcp</code> or <c ode>udp</code>.</dd>
2251 <!-- OBJECT PROPERTIES -->
2252 <!-- OBJECT METHODS -->
2253 <!-- OBJECT EVENT FIELDS -->
2254 <!-- FUNCTION PARAMETERS -->
2255 </div>
2256 </div>
2257 </dl>
2258 </dd>
2259 <!-- OBJECT METHODS -->
2260 <!-- OBJECT EVENT FIELDS -->
2261 <!-- FUNCTION PARAMETERS -->
2262 </div>
1982 </div> <!-- /apiItem --> 2263 </div> <!-- /apiItem -->
1983 </div> <!-- /apiGroup --> 2264 </div> <!-- /apiGroup -->
1984 </div> <!-- /apiPage --> 2265 </div> <!-- /apiPage -->
1985 </div> <!-- /gc-pagecontent --> 2266 </div> <!-- /gc-pagecontent -->
1986 </div> <!-- /g-section --> 2267 </div> <!-- /g-section -->
1987 </div> <!-- /codesiteContent --> 2268 </div> <!-- /codesiteContent -->
1988 <div id="gc-footer" --=""> 2269 <div id="gc-footer" --="">
1989 <div class="text"> 2270 <div class="text">
1990 <p> 2271 <p>
1991 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>, 2272 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
(...skipping 29 matching lines...) Expand all
2021 _uff=0; 2302 _uff=0;
2022 urchinTracker(); 2303 urchinTracker();
2023 } 2304 }
2024 catch(e) {/* urchinTracker not available. */} 2305 catch(e) {/* urchinTracker not available. */}
2025 </script> 2306 </script>
2026 <!-- end analytics --> 2307 <!-- end analytics -->
2027 </div> 2308 </div>
2028 </div> <!-- /gc-footer --> 2309 </div> <!-- /gc-footer -->
2029 </div> <!-- /gc-container --> 2310 </div> <!-- /gc-container -->
2030 </body></html> 2311 </body></html>
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698