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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/apps/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, 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
« no previous file with comments | « chrome/common/extensions/docs/apps/experimental.html ('k') | chrome/common/extensions/docs/apps/socket.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
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
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
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
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="../css/print.css" rel="stylesheet" type="text/css" media="print" >
13 <script type="text/javascript" src="../../../../third_party/jstemplate/jstem plate_compiled.js">
14 </script>
15 <script type="text/javascript" src="../../../../../third_party/json_minify/m inify-sans-regexp.js">
16 </script>
17 <script type="text/javascript" src="../js/api_page_generator.js"></script>
18 <script type="text/javascript" src="../js/bootstrap.js"></script>
19 <script type="text/javascript" src="../js/sidebar.js"></script>
20 <meta name="description" content="Documentation for the chrome.experimental.so cket module, which is part of the Google Chrome extension APIs."><title>chrome. experimental.socket - Google Chrome Extensions - Google Code</title></head>
21 <body doc-family="apps"> <link href="../css/ApiRefStyles_apps.css" rel="style sheet" type="text/css">
22 <link href="../css/prettify.css" rel="stylesheet" type="text/css">
23 <link href="../css/shared.css" rel="stylesheet" type="text/css">
24 <div id="devModeWarning" class="displayModeWarning">
25 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
26 </div>
27 <div id="branchWarning" class="displayModeWarning">
28 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
29 It may not work with the stable release of Chrome.</span>
30 <select id="branchChooser">
31 <option>Choose a different version...
32 </option><option value="">Stable
33 </option><option value="beta">Beta
34 </option><option value="dev">Dev
35 </option><option value="trunk">Trunk
36 </option></select>
37 </div>
38 <div id="unofficialWarning" class="displayModeWarning">
39 <span>WARNING: This is unofficial documentation. It may not work with the
40 current release of Chrome.</span>
41 <button id="goToOfficialDocs">Go to the official docs</button>
42 </div>
43 <div id="gc-container" class="labs">
44 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
45 <!-- In particular, sub-templates that recurse, must be used by allowing
46 jstemplate to make a copy of the template in this section which
47 are not operated on by way of the jsskip="true" -->
48 <!-- /SUBTEMPLATES -->
49 <a id="top"></a>
50 <div id="skipto">
51 <a href="#gc-pagecontent">Skip to page content</a>
52 <a href="#gc-toc">Skip to main navigation</a>
53 </div>
54 <!-- API HEADER -->
55 <table id="header" width="100%" cellspacing="0" border="0">
56 <tbody><tr>
57 <td valign="middle"><a href="http://code.google.com/"><img src="../image s/chrome_logo.gif" alt="Google Code" style="border:0; margin:0;"></a></td>
58 <td valign="middle" width="100%" style="padding-left:0.6em;">
59 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
60 <div id="gsc-search-box">
61 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
62 <input type="hidden" name="ie" value="UTF-8">
63 <input id="gsc-search-input" type="text" name="q" value="" size="5 5">
64 <button class="gsc-search-button" type="submit" name="sa">
65 <img class="gsc-search-button-lens" src="../images/search.png" a lt="Search">
66 </button>
67 <br>
68 <span class="greytext">e.g. "event page" or "alarms"</span>
69 </div>
70 </form>
71 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
72 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
73 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
74 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
75 </td>
76 </tr>
77 </tbody></table>
78 <div id="codesiteContent" class="">
79 <a id="gc-topnav-anchor"></a>
80 <div id="gc-topnav">
81 <h1>Packaged Apps</h1>
82 <ul id="home" class="gc-topnav-tabs">
83 <li id="home_link">
84 <a href="about_apps.html" title="Packaged Apps home page"><span>Home </span></a>
85 </li>
86 <li id="docs_link">
87 <a href="develop_apps.html" title="Packaged apps developer documenta tion"><span>Docs</span></a>
88 </li>
89 <li id="samples_link">
90 <a href="https://github.com/GoogleChrome/chrome-app-samples" title=" Packaged apps samples repository"><span>Samples</span></a>
91 </li>
92 <li id="group_link">
93 <a href="http://groups.google.com/a/chromium.org/group/chromium-apps " title="Google Chrome Apps developer forum"><span>Group</span></a>
94 </li>
95 <li id="so_link">
96 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow"><span>Questions? </span></a>
97 </li>
98 </ul>
99 </div> <!-- end gc-topnav -->
100 <div class="g-section g-tpl-170">
101 <!-- SIDENAV -->
102 <div class="g-unit g-first" id="gc-toc">
103 <ul>
104 <li><h2>Getting Started</h2>
105 <ul>
106 <li><a href="about_apps.html">What Are Packaged Apps?</a></li>
107 <li><a href="app_architecture.html">Understand the Architecture</a ></li>
108 <li><a href="first_app.html">Create Your First App</a></li>
109 </ul>
110 </li>
111 <li><h2>Developing</h2>
112 <ul>
113 <li><a href="develop_apps.html">Before You Start</a></li>
114 <li><span>The Fundamentals</span>
115 <ul>
116 <li><a href="app_lifecycle.html">Manage App Lifecycle</a></li>
117 <li><a href="app_storage.html">Manage Data</a></li>
118 <li><a href="offline_apps.html">Offline First</a></li>
119 <li><a href="app_external.html">Embed Content</a></li>
120 </ul>
121 </li>
122 <li><span>Security &amp; Privacy</span>
123 <ul>
124 <li><a href="app_identity.html">Identify User</a></li>
125 <li><a href="app_csp.html">Comply with CSP</a></li>
126 </ul>
127 </li>
128 <li><span>Advanced Technologies</span>
129 <ul>
130 <li><a href="app_network.html">Network Communications</a></li>
131 <li><a href="app_hardware.html">Access Hardware Devices</a></l i>
132 <li><a href="app_intents.html">Connect Apps with Web Intents</ a></li>
133 </ul>
134 </li>
135 <li><a href="app_frameworks.html">MVC Architecture</a></li>
136 </ul>
137 </li>
138 <li><h2>Deploying</h2>
139 <ul>
140 <li><a href="publish_app.html">Publish</a></li>
141 </ul>
142 </li>
143 <li><h2>Reference</h2>
144 <ul>
145 <li><a href="manifest.html">Manifest Files</a></li>
146 <li><a href="api_index.html">Chrome JavaScript APIs</a></li>
147 <li><a href="api_other.html">Supported Libraries</a></li>
148 <li><a href="app_deprecated.html">Disabled Web Features</a></li>
149 </ul>
150 </li>
151 <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">S amples</a></h2></li>
152 <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li>
153 </ul>
154 </div>
155 <script>
156 initToggles();
157 </script>
158 <div class="g-unit" id="gc-pagecontent">
159 <div id="pageTitle">
160 <h1 class="page_title">chrome.experimental.socket</h1>
161 </div>
162 <!-- TABLE OF CONTENTS -->
163 <div id="toc">
164 <h2>Contents</h2>
165 <ol>
166 <li>
167 <a href="#apiReference">API reference: chrome.experimental.socke t</a>
168 <ol>
169 <li>
170 <a href="#global-methods">Methods</a>
171 <ol>
172 <li>
173 <a href="#method-bind">bind</a>
174 </li><li>
175 <a href="#method-connect">connect</a>
176 </li><li>
177 <a href="#method-create">create</a>
178 </li><li>
179 <a href="#method-destroy">destroy</a>
180 </li><li>
181 <a href="#method-disconnect">disconnect</a>
182 </li><li>
183 <a href="#method-read">read</a>
184 </li><li>
185 <a href="#method-recvFrom">recvFrom</a>
186 </li><li>
187 <a href="#method-sendTo">sendTo</a>
188 </li><li>
189 <a href="#method-setKeepAlive">setKeepAlive</a>
190 </li><li>
191 <a href="#method-setNoDelay">setNoDelay</a>
192 </li><li>
193 <a href="#method-write">write</a>
194 </li>
195 </ol>
196 </li>
197 <li>
198 <a href="#types">Types</a>
199 <ol>
200 <li>
201 <a href="#type-experimental.socket.SocketType">experimental.sock et.SocketType</a>
202 <ol>
203 </ol>
204 </li><li>
205 <a href="#type-experimental.socket.CreateOptions">experimental.s ocket.CreateOptions</a>
206 <ol>
207 </ol>
208 </li><li>
209 <a href="#type-experimental.socket.CreateInfo">experimental.sock et.CreateInfo</a>
210 <ol>
211 </ol>
212 </li><li>
213 <a href="#type-experimental.socket.ReadInfo">experimental.socket .ReadInfo</a>
214 <ol>
215 </ol>
216 </li><li>
217 <a href="#type-experimental.socket.WriteInfo">experimental.socke t.WriteInfo</a>
218 <ol>
219 </ol>
220 </li><li>
221 <a href="#type-experimental.socket.RecvFromInfo">experimental.so cket.RecvFromInfo</a>
222 <ol>
223 </ol>
224 </li>
225 </ol>
226 </li>
227 </ol>
228 </li>
229 </ol>
230 </div>
231 <!-- /TABLE OF CONTENTS -->
232 <!-- Standard content lead-in for experimental API pages -->
233 <p id="classSummary">
234 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
235 </p>
236 <!-- STATIC CONTENT PLACEHOLDER -->
237 <div id="static"></div>
238 <!-- API PAGE -->
239 <div class="apiPage">
240 <a name="apiReference"></a>
241 <h2>API reference: chrome.experimental.socket</h2>
242 <!-- PROPERTIES -->
243 <!-- /apiGroup -->
244 <!-- METHODS -->
245 <div id="methodsTemplate" class="apiGroup">
246 <a name="global-methods"></a>
247 <h3>Methods</h3>
248 <!-- iterates over all functions -->
249 <div class="apiItem">
250 <a name="method-bind"></a> <!-- method-anchor -->
251 <h4>bind</h4>
252 <div class="summary">
253 <!-- Note: intentionally longer 80 columns -->
254 <span>chrome.experimental.socket.bind</span>(<span class="null "><span>integer</span>
255 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>string</span>
256 <var><span>address</span></var></span><span class="null">< span>, </span><span>integer</span>
257 <var><span>port</span></var></span><span class="null"><spa n>, </span><span>function</span>
258 <var><span>BindCallback</span></var></span>)</div>
259 <div class="description">
260 <p>Binds the local address for socket. Currently, it does not su pport TCP socket.</p>
261 <!-- PARAMETERS -->
262 <h4>Parameters</h4>
263 <dl>
264 <div>
265 <div>
266 <dt>
267 <var>socketId</var>
268 <em>
269 <!-- TYPE -->
270 <div style="display:inline">
271 (
272 <span id="typeTemplate">
273 <span>
274 <span>integer</span>
275 </span>
276 </span>
277 )
278 </div>
279 </em>
280 </dt>
281 <dd>The socketId.</dd>
282 <!-- OBJECT PROPERTIES -->
283 <!-- OBJECT METHODS -->
284 <!-- OBJECT EVENT FIELDS -->
285 <!-- FUNCTION PARAMETERS -->
286 </div>
287 </div><div>
288 <div>
289 <dt>
290 <var>address</var>
291 <em>
292 <!-- TYPE -->
293 <div style="display:inline">
294 (
295 <span id="typeTemplate">
296 <span>
297 <span>string</span>
298 </span>
299 </span>
300 )
301 </div>
302 </em>
303 </dt>
304 <dd>The address of the local machine.</dd>
305 <!-- OBJECT PROPERTIES -->
306 <!-- OBJECT METHODS -->
307 <!-- OBJECT EVENT FIELDS -->
308 <!-- FUNCTION PARAMETERS -->
309 </div>
310 </div><div>
311 <div>
312 <dt>
313 <var>port</var>
314 <em>
315 <!-- TYPE -->
316 <div style="display:inline">
317 (
318 <span id="typeTemplate">
319 <span>
320 <span>integer</span>
321 </span>
322 </span>
323 )
324 </div>
325 </em>
326 </dt>
327 <dd>The port of the local machine.</dd>
328 <!-- OBJECT PROPERTIES -->
329 <!-- OBJECT METHODS -->
330 <!-- OBJECT EVENT FIELDS -->
331 <!-- FUNCTION PARAMETERS -->
332 </div>
333 </div><div>
334 <div>
335 <dt>
336 <var>BindCallback</var>
337 <em>
338 <!-- TYPE -->
339 <div style="display:inline">
340 (
341 <span id="typeTemplate">
342 <span>
343 <span>function</span>
344 </span>
345 </span>
346 )
347 </div>
348 </em>
349 </dt>
350 <dd class="todo">
351 Undocumented.
352 </dd>
353 <!-- OBJECT PROPERTIES -->
354 <!-- OBJECT METHODS -->
355 <!-- OBJECT EVENT FIELDS -->
356 <!-- FUNCTION PARAMETERS -->
357 <dd>
358 <div>
359 <h5>Parameters</h5>
360 <dl>
361 <div>
362 <div>
363 <dt>
364 <var>result</var>
365 <em>
366 <!-- TYPE -->
367 <div style="display:inline">
368 (
369 <span id="typeTemplate">
370 <span>
371 <span>integer</span>
372 </span>
373 </span>
374 )
375 </div>
376 </em>
377 </dt>
378 <dd class="todo">
379 Undocumented.
380 </dd>
381 <!-- OBJECT PROPERTIES -->
382 <!-- OBJECT METHODS -->
383 <!-- OBJECT EVENT FIELDS -->
384 <!-- FUNCTION PARAMETERS -->
385 </div>
386 </div>
387 </dl>
388 </div>
389 </dd>
390 </div>
391 </div>
392 </dl>
393 <!-- RETURNS -->
394 <dl>
395 </dl>
396 <!-- CALLBACK -->
397 <!-- MIN_VERSION -->
398 </div> <!-- /description -->
399 </div><div class="apiItem">
400 <a name="method-connect"></a> <!-- method-anchor -->
401 <h4>connect</h4>
402 <div class="summary">
403 <!-- Note: intentionally longer 80 columns -->
404 <span>chrome.experimental.socket.connect</span>(<span class="n ull"><span>integer</span>
405 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>string</span>
406 <var><span>hostname</span></var></span><span class="null"> <span>, </span><span>integer</span>
407 <var><span>port</span></var></span><span class="null"><spa n>, </span><span>function</span>
408 <var><span>ConnectCallback</span></var></span>)</div>
409 <div class="description">
410 <p>Connects the socket to the remote machine.</p>
411 <!-- PARAMETERS -->
412 <h4>Parameters</h4>
413 <dl>
414 <div>
415 <div>
416 <dt>
417 <var>socketId</var>
418 <em>
419 <!-- TYPE -->
420 <div style="display:inline">
421 (
422 <span id="typeTemplate">
423 <span>
424 <span>integer</span>
425 </span>
426 </span>
427 )
428 </div>
429 </em>
430 </dt>
431 <dd>The socketId.</dd>
432 <!-- OBJECT PROPERTIES -->
433 <!-- OBJECT METHODS -->
434 <!-- OBJECT EVENT FIELDS -->
435 <!-- FUNCTION PARAMETERS -->
436 </div>
437 </div><div>
438 <div>
439 <dt>
440 <var>hostname</var>
441 <em>
442 <!-- TYPE -->
443 <div style="display:inline">
444 (
445 <span id="typeTemplate">
446 <span>
447 <span>string</span>
448 </span>
449 </span>
450 )
451 </div>
452 </em>
453 </dt>
454 <dd>The hostname or IP address of the remote machine.</dd>
455 <!-- OBJECT PROPERTIES -->
456 <!-- OBJECT METHODS -->
457 <!-- OBJECT EVENT FIELDS -->
458 <!-- FUNCTION PARAMETERS -->
459 </div>
460 </div><div>
461 <div>
462 <dt>
463 <var>port</var>
464 <em>
465 <!-- TYPE -->
466 <div style="display:inline">
467 (
468 <span id="typeTemplate">
469 <span>
470 <span>integer</span>
471 </span>
472 </span>
473 )
474 </div>
475 </em>
476 </dt>
477 <dd>The port of the remote machine.</dd>
478 <!-- OBJECT PROPERTIES -->
479 <!-- OBJECT METHODS -->
480 <!-- OBJECT EVENT FIELDS -->
481 <!-- FUNCTION PARAMETERS -->
482 </div>
483 </div><div>
484 <div>
485 <dt>
486 <var>ConnectCallback</var>
487 <em>
488 <!-- TYPE -->
489 <div style="display:inline">
490 (
491 <span id="typeTemplate">
492 <span>
493 <span>function</span>
494 </span>
495 </span>
496 )
497 </div>
498 </em>
499 </dt>
500 <dd class="todo">
501 Undocumented.
502 </dd>
503 <!-- OBJECT PROPERTIES -->
504 <!-- OBJECT METHODS -->
505 <!-- OBJECT EVENT FIELDS -->
506 <!-- FUNCTION PARAMETERS -->
507 <dd>
508 <div>
509 <h5>Parameters</h5>
510 <dl>
511 <div>
512 <div>
513 <dt>
514 <var>result</var>
515 <em>
516 <!-- TYPE -->
517 <div style="display:inline">
518 (
519 <span id="typeTemplate">
520 <span>
521 <span>integer</span>
522 </span>
523 </span>
524 )
525 </div>
526 </em>
527 </dt>
528 <dd class="todo">
529 Undocumented.
530 </dd>
531 <!-- OBJECT PROPERTIES -->
532 <!-- OBJECT METHODS -->
533 <!-- OBJECT EVENT FIELDS -->
534 <!-- FUNCTION PARAMETERS -->
535 </div>
536 </div>
537 </dl>
538 </div>
539 </dd>
540 </div>
541 </div>
542 </dl>
543 <!-- RETURNS -->
544 <dl>
545 </dl>
546 <!-- CALLBACK -->
547 <!-- MIN_VERSION -->
548 </div> <!-- /description -->
549 </div><div class="apiItem">
550 <a name="method-create"></a> <!-- method-anchor -->
551 <h4>create</h4>
552 <div class="summary">
553 <!-- Note: intentionally longer 80 columns -->
554 <span>chrome.experimental.socket.create</span>(<span class="nu ll"><span>experimental.socket.SocketType</span>
555 <var><span>type</span></var></span><span class="optional"> <span>, </span><span>experimental.socket.CreateOptions</span>
556 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>
557 <var><span>CreateCallback</span></var></span>)</div>
558 <div class="description">
559 <p>Creates a socket of the specified type that will connect to t he specified remote machine.</p>
560 <!-- PARAMETERS -->
561 <h4>Parameters</h4>
562 <dl>
563 <div>
564 <div>
565 <dt>
566 <var>type</var>
567 <em>
568 <!-- TYPE -->
569 <div style="display:inline">
570 (
571 <span id="typeTemplate">
572 <span>
573 <a href="experimental.socket.html#type-experimental.sock et.SocketType">experimental.socket.SocketType</a>
574 </span>
575 </span>
576 )
577 </div>
578 </em>
579 </dt>
580 <dd>The type of socket to create. Must be <code>tcp</code> or <code>ud p</code>.</dd>
581 <!-- OBJECT PROPERTIES -->
582 <!-- OBJECT METHODS -->
583 <!-- OBJECT EVENT FIELDS -->
584 <!-- FUNCTION PARAMETERS -->
585 </div>
586 </div><div>
587 <div>
588 <dt>
589 <var>options</var>
590 <em>
591 <!-- TYPE -->
592 <div style="display:inline">
593 (
594 <span class="optional">optional</span>
595 <span id="typeTemplate">
596 <span>
597 <a href="experimental.socket.html#type-experimental.sock et.CreateOptions">experimental.socket.CreateOptions</a>
598 </span>
599 </span>
600 )
601 </div>
602 </em>
603 </dt>
604 <dd>The socket options.</dd>
605 <!-- OBJECT PROPERTIES -->
606 <!-- OBJECT METHODS -->
607 <!-- OBJECT EVENT FIELDS -->
608 <!-- FUNCTION PARAMETERS -->
609 </div>
610 </div><div>
611 <div>
612 <dt>
613 <var>CreateCallback</var>
614 <em>
615 <!-- TYPE -->
616 <div style="display:inline">
617 (
618 <span id="typeTemplate">
619 <span>
620 <span>function</span>
621 </span>
622 </span>
623 )
624 </div>
625 </em>
626 </dt>
627 <dd class="todo">
628 Undocumented.
629 </dd>
630 <!-- OBJECT PROPERTIES -->
631 <!-- OBJECT METHODS -->
632 <!-- OBJECT EVENT FIELDS -->
633 <!-- FUNCTION PARAMETERS -->
634 <dd>
635 <div>
636 <h5>Parameters</h5>
637 <dl>
638 <div>
639 <div>
640 <dt>
641 <var>createInfo</var>
642 <em>
643 <!-- TYPE -->
644 <div style="display:inline">
645 (
646 <span id="typeTemplate">
647 <span>
648 <a href="experimental.socket.html#type-experimental.sock et.CreateInfo">experimental.socket.CreateInfo</a>
649 </span>
650 </span>
651 )
652 </div>
653 </em>
654 </dt>
655 <dd class="todo">
656 Undocumented.
657 </dd>
658 <!-- OBJECT PROPERTIES -->
659 <!-- OBJECT METHODS -->
660 <!-- OBJECT EVENT FIELDS -->
661 <!-- FUNCTION PARAMETERS -->
662 </div>
663 </div>
664 </dl>
665 </div>
666 </dd>
667 </div>
668 </div>
669 </dl>
670 <!-- RETURNS -->
671 <dl>
672 </dl>
673 <!-- CALLBACK -->
674 <!-- MIN_VERSION -->
675 </div> <!-- /description -->
676 </div><div class="apiItem">
677 <a name="method-destroy"></a> <!-- method-anchor -->
678 <h4>destroy</h4>
679 <div class="summary">
680 <!-- Note: intentionally longer 80 columns -->
681 <span>chrome.experimental.socket.destroy</span>(<span class="n ull"><span>integer</span>
682 <var><span>socketId</span></var></span>)</div>
683 <div class="description">
684 <p>Destroys the socket. Each socket created should be destroyed after use.</p>
685 <!-- PARAMETERS -->
686 <h4>Parameters</h4>
687 <dl>
688 <div>
689 <div>
690 <dt>
691 <var>socketId</var>
692 <em>
693 <!-- TYPE -->
694 <div style="display:inline">
695 (
696 <span id="typeTemplate">
697 <span>
698 <span>integer</span>
699 </span>
700 </span>
701 )
702 </div>
703 </em>
704 </dt>
705 <dd>The socketId.</dd>
706 <!-- OBJECT PROPERTIES -->
707 <!-- OBJECT METHODS -->
708 <!-- OBJECT EVENT FIELDS -->
709 <!-- FUNCTION PARAMETERS -->
710 </div>
711 </div>
712 </dl>
713 <!-- RETURNS -->
714 <dl>
715 </dl>
716 <!-- CALLBACK -->
717 <!-- MIN_VERSION -->
718 </div> <!-- /description -->
719 </div><div class="apiItem">
720 <a name="method-disconnect"></a> <!-- method-anchor -->
721 <h4>disconnect</h4>
722 <div class="summary">
723 <!-- Note: intentionally longer 80 columns -->
724 <span>chrome.experimental.socket.disconnect</span>(<span class ="null"><span>integer</span>
725 <var><span>socketId</span></var></span>)</div>
726 <div class="description">
727 <p>Disconnects the socket. For UDP sockets, <code>disconnect</co de> is a non-operation but is safe to call.</p>
728 <!-- PARAMETERS -->
729 <h4>Parameters</h4>
730 <dl>
731 <div>
732 <div>
733 <dt>
734 <var>socketId</var>
735 <em>
736 <!-- TYPE -->
737 <div style="display:inline">
738 (
739 <span id="typeTemplate">
740 <span>
741 <span>integer</span>
742 </span>
743 </span>
744 )
745 </div>
746 </em>
747 </dt>
748 <dd>The socketId.</dd>
749 <!-- OBJECT PROPERTIES -->
750 <!-- OBJECT METHODS -->
751 <!-- OBJECT EVENT FIELDS -->
752 <!-- FUNCTION PARAMETERS -->
753 </div>
754 </div>
755 </dl>
756 <!-- RETURNS -->
757 <dl>
758 </dl>
759 <!-- CALLBACK -->
760 <!-- MIN_VERSION -->
761 </div> <!-- /description -->
762 </div><div class="apiItem">
763 <a name="method-read"></a> <!-- method-anchor -->
764 <h4>read</h4>
765 <div class="summary">
766 <!-- Note: intentionally longer 80 columns -->
767 <span>chrome.experimental.socket.read</span>(<span class="null "><span>integer</span>
768 <var><span>socketId</span></var></span><span class="option al"><span>, </span><span>integer</span>
769 <var><span>bufferSize</span></var></span><span class="null "><span>, </span><span>function</span>
770 <var><span>ReadCallback</span></var></span>)</div>
771 <div class="description">
772 <p>Reads data from the given connected socket.</p>
773 <!-- PARAMETERS -->
774 <h4>Parameters</h4>
775 <dl>
776 <div>
777 <div>
778 <dt>
779 <var>socketId</var>
780 <em>
781 <!-- TYPE -->
782 <div style="display:inline">
783 (
784 <span id="typeTemplate">
785 <span>
786 <span>integer</span>
787 </span>
788 </span>
789 )
790 </div>
791 </em>
792 </dt>
793 <dd>The socketId.</dd>
794 <!-- OBJECT PROPERTIES -->
795 <!-- OBJECT METHODS -->
796 <!-- OBJECT EVENT FIELDS -->
797 <!-- FUNCTION PARAMETERS -->
798 </div>
799 </div><div>
800 <div>
801 <dt>
802 <var>bufferSize</var>
803 <em>
804 <!-- TYPE -->
805 <div style="display:inline">
806 (
807 <span class="optional">optional</span>
808 <span id="typeTemplate">
809 <span>
810 <span>integer</span>
811 </span>
812 </span>
813 )
814 </div>
815 </em>
816 </dt>
817 <dd>The read buffer size.</dd>
818 <!-- OBJECT PROPERTIES -->
819 <!-- OBJECT METHODS -->
820 <!-- OBJECT EVENT FIELDS -->
821 <!-- FUNCTION PARAMETERS -->
822 </div>
823 </div><div>
824 <div>
825 <dt>
826 <var>ReadCallback</var>
827 <em>
828 <!-- TYPE -->
829 <div style="display:inline">
830 (
831 <span id="typeTemplate">
832 <span>
833 <span>function</span>
834 </span>
835 </span>
836 )
837 </div>
838 </em>
839 </dt>
840 <dd class="todo">
841 Undocumented.
842 </dd>
843 <!-- OBJECT PROPERTIES -->
844 <!-- OBJECT METHODS -->
845 <!-- OBJECT EVENT FIELDS -->
846 <!-- FUNCTION PARAMETERS -->
847 <dd>
848 <div>
849 <h5>Parameters</h5>
850 <dl>
851 <div>
852 <div>
853 <dt>
854 <var>readInfo</var>
855 <em>
856 <!-- TYPE -->
857 <div style="display:inline">
858 (
859 <span id="typeTemplate">
860 <span>
861 <a href="experimental.socket.html#type-experimental.sock et.ReadInfo">experimental.socket.ReadInfo</a>
862 </span>
863 </span>
864 )
865 </div>
866 </em>
867 </dt>
868 <dd class="todo">
869 Undocumented.
870 </dd>
871 <!-- OBJECT PROPERTIES -->
872 <!-- OBJECT METHODS -->
873 <!-- OBJECT EVENT FIELDS -->
874 <!-- FUNCTION PARAMETERS -->
875 </div>
876 </div>
877 </dl>
878 </div>
879 </dd>
880 </div>
881 </div>
882 </dl>
883 <!-- RETURNS -->
884 <dl>
885 </dl>
886 <!-- CALLBACK -->
887 <!-- MIN_VERSION -->
888 </div> <!-- /description -->
889 </div><div class="apiItem">
890 <a name="method-recvFrom"></a> <!-- method-anchor -->
891 <h4>recvFrom</h4>
892 <div class="summary">
893 <!-- Note: intentionally longer 80 columns -->
894 <span>chrome.experimental.socket.recvFrom</span>(<span class=" null"><span>integer</span>
895 <var><span>socketId</span></var></span><span class="option al"><span>, </span><span>integer</span>
896 <var><span>bufferSize</span></var></span><span class="null "><span>, </span><span>function</span>
897 <var><span>RecvFromCallback</span></var></span>)</div>
898 <div class="description">
899 <p>Receives data from the given UDP socket.</p>
900 <!-- PARAMETERS -->
901 <h4>Parameters</h4>
902 <dl>
903 <div>
904 <div>
905 <dt>
906 <var>socketId</var>
907 <em>
908 <!-- TYPE -->
909 <div style="display:inline">
910 (
911 <span id="typeTemplate">
912 <span>
913 <span>integer</span>
914 </span>
915 </span>
916 )
917 </div>
918 </em>
919 </dt>
920 <dd>The socketId.</dd>
921 <!-- OBJECT PROPERTIES -->
922 <!-- OBJECT METHODS -->
923 <!-- OBJECT EVENT FIELDS -->
924 <!-- FUNCTION PARAMETERS -->
925 </div>
926 </div><div>
927 <div>
928 <dt>
929 <var>bufferSize</var>
930 <em>
931 <!-- TYPE -->
932 <div style="display:inline">
933 (
934 <span class="optional">optional</span>
935 <span id="typeTemplate">
936 <span>
937 <span>integer</span>
938 </span>
939 </span>
940 )
941 </div>
942 </em>
943 </dt>
944 <dd>The receive buffer size.</dd>
945 <!-- OBJECT PROPERTIES -->
946 <!-- OBJECT METHODS -->
947 <!-- OBJECT EVENT FIELDS -->
948 <!-- FUNCTION PARAMETERS -->
949 </div>
950 </div><div>
951 <div>
952 <dt>
953 <var>RecvFromCallback</var>
954 <em>
955 <!-- TYPE -->
956 <div style="display:inline">
957 (
958 <span id="typeTemplate">
959 <span>
960 <span>function</span>
961 </span>
962 </span>
963 )
964 </div>
965 </em>
966 </dt>
967 <dd class="todo">
968 Undocumented.
969 </dd>
970 <!-- OBJECT PROPERTIES -->
971 <!-- OBJECT METHODS -->
972 <!-- OBJECT EVENT FIELDS -->
973 <!-- FUNCTION PARAMETERS -->
974 <dd>
975 <div>
976 <h5>Parameters</h5>
977 <dl>
978 <div>
979 <div>
980 <dt>
981 <var>recvFromInfo</var>
982 <em>
983 <!-- TYPE -->
984 <div style="display:inline">
985 (
986 <span id="typeTemplate">
987 <span>
988 <a href="experimental.socket.html#type-experimental.sock et.RecvFromInfo">experimental.socket.RecvFromInfo</a>
989 </span>
990 </span>
991 )
992 </div>
993 </em>
994 </dt>
995 <dd class="todo">
996 Undocumented.
997 </dd>
998 <!-- OBJECT PROPERTIES -->
999 <!-- OBJECT METHODS -->
1000 <!-- OBJECT EVENT FIELDS -->
1001 <!-- FUNCTION PARAMETERS -->
1002 </div>
1003 </div>
1004 </dl>
1005 </div>
1006 </dd>
1007 </div>
1008 </div>
1009 </dl>
1010 <!-- RETURNS -->
1011 <dl>
1012 </dl>
1013 <!-- CALLBACK -->
1014 <!-- MIN_VERSION -->
1015 </div> <!-- /description -->
1016 </div><div class="apiItem">
1017 <a name="method-sendTo"></a> <!-- method-anchor -->
1018 <h4>sendTo</h4>
1019 <div class="summary">
1020 <!-- Note: intentionally longer 80 columns -->
1021 <span>chrome.experimental.socket.sendTo</span>(<span class="nu ll"><span>integer</span>
1022 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>ArrayBuffer</span>
1023 <var><span>data</span></var></span><span class="null"><spa n>, </span><span>string</span>
1024 <var><span>address</span></var></span><span class="null">< span>, </span><span>integer</span>
1025 <var><span>port</span></var></span><span class="null"><spa n>, </span><span>function</span>
1026 <var><span>SendToCallback</span></var></span>)</div>
1027 <div class="description">
1028 <p>Sends data on the given UDP socket to the given address and p ort.</p>
1029 <!-- PARAMETERS -->
1030 <h4>Parameters</h4>
1031 <dl>
1032 <div>
1033 <div>
1034 <dt>
1035 <var>socketId</var>
1036 <em>
1037 <!-- TYPE -->
1038 <div style="display:inline">
1039 (
1040 <span id="typeTemplate">
1041 <span>
1042 <span>integer</span>
1043 </span>
1044 </span>
1045 )
1046 </div>
1047 </em>
1048 </dt>
1049 <dd>The socketId.</dd>
1050 <!-- OBJECT PROPERTIES -->
1051 <!-- OBJECT METHODS -->
1052 <!-- OBJECT EVENT FIELDS -->
1053 <!-- FUNCTION PARAMETERS -->
1054 </div>
1055 </div><div>
1056 <div>
1057 <dt>
1058 <var>data</var>
1059 <em>
1060 <!-- TYPE -->
1061 <div style="display:inline">
1062 (
1063 <span id="typeTemplate">
1064 <span>
1065 <span>ArrayBuffer</span>
1066 </span>
1067 </span>
1068 )
1069 </div>
1070 </em>
1071 </dt>
1072 <dd>The data to write.</dd>
1073 <!-- OBJECT PROPERTIES -->
1074 <!-- OBJECT METHODS -->
1075 <!-- OBJECT EVENT FIELDS -->
1076 <!-- FUNCTION PARAMETERS -->
1077 </div>
1078 </div><div>
1079 <div>
1080 <dt>
1081 <var>address</var>
1082 <em>
1083 <!-- TYPE -->
1084 <div style="display:inline">
1085 (
1086 <span id="typeTemplate">
1087 <span>
1088 <span>string</span>
1089 </span>
1090 </span>
1091 )
1092 </div>
1093 </em>
1094 </dt>
1095 <dd>The address of the remote machine.</dd>
1096 <!-- OBJECT PROPERTIES -->
1097 <!-- OBJECT METHODS -->
1098 <!-- OBJECT EVENT FIELDS -->
1099 <!-- FUNCTION PARAMETERS -->
1100 </div>
1101 </div><div>
1102 <div>
1103 <dt>
1104 <var>port</var>
1105 <em>
1106 <!-- TYPE -->
1107 <div style="display:inline">
1108 (
1109 <span id="typeTemplate">
1110 <span>
1111 <span>integer</span>
1112 </span>
1113 </span>
1114 )
1115 </div>
1116 </em>
1117 </dt>
1118 <dd>The port of the remote machine.</dd>
1119 <!-- OBJECT PROPERTIES -->
1120 <!-- OBJECT METHODS -->
1121 <!-- OBJECT EVENT FIELDS -->
1122 <!-- FUNCTION PARAMETERS -->
1123 </div>
1124 </div><div>
1125 <div>
1126 <dt>
1127 <var>SendToCallback</var>
1128 <em>
1129 <!-- TYPE -->
1130 <div style="display:inline">
1131 (
1132 <span id="typeTemplate">
1133 <span>
1134 <span>function</span>
1135 </span>
1136 </span>
1137 )
1138 </div>
1139 </em>
1140 </dt>
1141 <dd class="todo">
1142 Undocumented.
1143 </dd>
1144 <!-- OBJECT PROPERTIES -->
1145 <!-- OBJECT METHODS -->
1146 <!-- OBJECT EVENT FIELDS -->
1147 <!-- FUNCTION PARAMETERS -->
1148 <dd>
1149 <div>
1150 <h5>Parameters</h5>
1151 <dl>
1152 <div>
1153 <div>
1154 <dt>
1155 <var>writeInfo</var>
1156 <em>
1157 <!-- TYPE -->
1158 <div style="display:inline">
1159 (
1160 <span id="typeTemplate">
1161 <span>
1162 <a href="experimental.socket.html#type-experimental.sock et.WriteInfo">experimental.socket.WriteInfo</a>
1163 </span>
1164 </span>
1165 )
1166 </div>
1167 </em>
1168 </dt>
1169 <dd class="todo">
1170 Undocumented.
1171 </dd>
1172 <!-- OBJECT PROPERTIES -->
1173 <!-- OBJECT METHODS -->
1174 <!-- OBJECT EVENT FIELDS -->
1175 <!-- FUNCTION PARAMETERS -->
1176 </div>
1177 </div>
1178 </dl>
1179 </div>
1180 </dd>
1181 </div>
1182 </div>
1183 </dl>
1184 <!-- RETURNS -->
1185 <dl>
1186 </dl>
1187 <!-- CALLBACK -->
1188 <!-- MIN_VERSION -->
1189 </div> <!-- /description -->
1190 </div><div class="apiItem">
1191 <a name="method-setKeepAlive"></a> <!-- method-anchor -->
1192 <h4>setKeepAlive</h4>
1193 <div class="summary">
1194 <!-- Note: intentionally longer 80 columns -->
1195 <span>chrome.experimental.socket.setKeepAlive</span>(<span cla ss="null"><span>integer</span>
1196 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>boolean</span>
1197 <var><span>enable</span></var></span><span class="optional "><span>, </span><span>integer</span>
1198 <var><span>delay</span></var></span><span class="null"><sp an>, </span><span>function</span>
1199 <var><span>SetKeepAliveCallback</span></var></span>)</div>
1200 <div class="description">
1201 <p>Enable/disable keep-alive functionality for a TCP connection. </p>
1202 <!-- PARAMETERS -->
1203 <h4>Parameters</h4>
1204 <dl>
1205 <div>
1206 <div>
1207 <dt>
1208 <var>socketId</var>
1209 <em>
1210 <!-- TYPE -->
1211 <div style="display:inline">
1212 (
1213 <span id="typeTemplate">
1214 <span>
1215 <span>integer</span>
1216 </span>
1217 </span>
1218 )
1219 </div>
1220 </em>
1221 </dt>
1222 <dd>The socketId.</dd>
1223 <!-- OBJECT PROPERTIES -->
1224 <!-- OBJECT METHODS -->
1225 <!-- OBJECT EVENT FIELDS -->
1226 <!-- FUNCTION PARAMETERS -->
1227 </div>
1228 </div><div>
1229 <div>
1230 <dt>
1231 <var>enable</var>
1232 <em>
1233 <!-- TYPE -->
1234 <div style="display:inline">
1235 (
1236 <span id="typeTemplate">
1237 <span>
1238 <span>boolean</span>
1239 </span>
1240 </span>
1241 )
1242 </div>
1243 </em>
1244 </dt>
1245 <dd>If true, enable keep-alive functionality.</dd>
1246 <!-- OBJECT PROPERTIES -->
1247 <!-- OBJECT METHODS -->
1248 <!-- OBJECT EVENT FIELDS -->
1249 <!-- FUNCTION PARAMETERS -->
1250 </div>
1251 </div><div>
1252 <div>
1253 <dt>
1254 <var>delay</var>
1255 <em>
1256 <!-- TYPE -->
1257 <div style="display:inline">
1258 (
1259 <span class="optional">optional</span>
1260 <span id="typeTemplate">
1261 <span>
1262 <span>integer</span>
1263 </span>
1264 </span>
1265 )
1266 </div>
1267 </em>
1268 </dt>
1269 <dd>Set the delay seconds between the last data packet received and th e first keepalive probe. Default is 0.</dd>
1270 <!-- OBJECT PROPERTIES -->
1271 <!-- OBJECT METHODS -->
1272 <!-- OBJECT EVENT FIELDS -->
1273 <!-- FUNCTION PARAMETERS -->
1274 </div>
1275 </div><div>
1276 <div>
1277 <dt>
1278 <var>SetKeepAliveCallback</var>
1279 <em>
1280 <!-- TYPE -->
1281 <div style="display:inline">
1282 (
1283 <span id="typeTemplate">
1284 <span>
1285 <span>function</span>
1286 </span>
1287 </span>
1288 )
1289 </div>
1290 </em>
1291 </dt>
1292 <dd class="todo">
1293 Undocumented.
1294 </dd>
1295 <!-- OBJECT PROPERTIES -->
1296 <!-- OBJECT METHODS -->
1297 <!-- OBJECT EVENT FIELDS -->
1298 <!-- FUNCTION PARAMETERS -->
1299 <dd>
1300 <div>
1301 <h5>Parameters</h5>
1302 <dl>
1303 <div>
1304 <div>
1305 <dt>
1306 <var>result</var>
1307 <em>
1308 <!-- TYPE -->
1309 <div style="display:inline">
1310 (
1311 <span id="typeTemplate">
1312 <span>
1313 <span>boolean</span>
1314 </span>
1315 </span>
1316 )
1317 </div>
1318 </em>
1319 </dt>
1320 <dd class="todo">
1321 Undocumented.
1322 </dd>
1323 <!-- OBJECT PROPERTIES -->
1324 <!-- OBJECT METHODS -->
1325 <!-- OBJECT EVENT FIELDS -->
1326 <!-- FUNCTION PARAMETERS -->
1327 </div>
1328 </div>
1329 </dl>
1330 </div>
1331 </dd>
1332 </div>
1333 </div>
1334 </dl>
1335 <!-- RETURNS -->
1336 <dl>
1337 </dl>
1338 <!-- CALLBACK -->
1339 <!-- MIN_VERSION -->
1340 </div> <!-- /description -->
1341 </div><div class="apiItem">
1342 <a name="method-setNoDelay"></a> <!-- method-anchor -->
1343 <h4>setNoDelay</h4>
1344 <div class="summary">
1345 <!-- Note: intentionally longer 80 columns -->
1346 <span>chrome.experimental.socket.setNoDelay</span>(<span class ="null"><span>integer</span>
1347 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>boolean</span>
1348 <var><span>noDelay</span></var></span><span class="null">< span>, </span><span>function</span>
1349 <var><span>SetNoDelayCallback</span></var></span>)</div>
1350 <div class="description">
1351 <p>Enable/disable Nagle algorithm.</p>
1352 <!-- PARAMETERS -->
1353 <h4>Parameters</h4>
1354 <dl>
1355 <div>
1356 <div>
1357 <dt>
1358 <var>socketId</var>
1359 <em>
1360 <!-- TYPE -->
1361 <div style="display:inline">
1362 (
1363 <span id="typeTemplate">
1364 <span>
1365 <span>integer</span>
1366 </span>
1367 </span>
1368 )
1369 </div>
1370 </em>
1371 </dt>
1372 <dd>The socketId.</dd>
1373 <!-- OBJECT PROPERTIES -->
1374 <!-- OBJECT METHODS -->
1375 <!-- OBJECT EVENT FIELDS -->
1376 <!-- FUNCTION PARAMETERS -->
1377 </div>
1378 </div><div>
1379 <div>
1380 <dt>
1381 <var>noDelay</var>
1382 <em>
1383 <!-- TYPE -->
1384 <div style="display:inline">
1385 (
1386 <span id="typeTemplate">
1387 <span>
1388 <span>boolean</span>
1389 </span>
1390 </span>
1391 )
1392 </div>
1393 </em>
1394 </dt>
1395 <dd>If true, disable Nagle algorithm.</dd>
1396 <!-- OBJECT PROPERTIES -->
1397 <!-- OBJECT METHODS -->
1398 <!-- OBJECT EVENT FIELDS -->
1399 <!-- FUNCTION PARAMETERS -->
1400 </div>
1401 </div><div>
1402 <div>
1403 <dt>
1404 <var>SetNoDelayCallback</var>
1405 <em>
1406 <!-- TYPE -->
1407 <div style="display:inline">
1408 (
1409 <span id="typeTemplate">
1410 <span>
1411 <span>function</span>
1412 </span>
1413 </span>
1414 )
1415 </div>
1416 </em>
1417 </dt>
1418 <dd class="todo">
1419 Undocumented.
1420 </dd>
1421 <!-- OBJECT PROPERTIES -->
1422 <!-- OBJECT METHODS -->
1423 <!-- OBJECT EVENT FIELDS -->
1424 <!-- FUNCTION PARAMETERS -->
1425 <dd>
1426 <div>
1427 <h5>Parameters</h5>
1428 <dl>
1429 <div>
1430 <div>
1431 <dt>
1432 <var>result</var>
1433 <em>
1434 <!-- TYPE -->
1435 <div style="display:inline">
1436 (
1437 <span id="typeTemplate">
1438 <span>
1439 <span>boolean</span>
1440 </span>
1441 </span>
1442 )
1443 </div>
1444 </em>
1445 </dt>
1446 <dd class="todo">
1447 Undocumented.
1448 </dd>
1449 <!-- OBJECT PROPERTIES -->
1450 <!-- OBJECT METHODS -->
1451 <!-- OBJECT EVENT FIELDS -->
1452 <!-- FUNCTION PARAMETERS -->
1453 </div>
1454 </div>
1455 </dl>
1456 </div>
1457 </dd>
1458 </div>
1459 </div>
1460 </dl>
1461 <!-- RETURNS -->
1462 <dl>
1463 </dl>
1464 <!-- CALLBACK -->
1465 <!-- MIN_VERSION -->
1466 </div> <!-- /description -->
1467 </div><div class="apiItem">
1468 <a name="method-write"></a> <!-- method-anchor -->
1469 <h4>write</h4>
1470 <div class="summary">
1471 <!-- Note: intentionally longer 80 columns -->
1472 <span>chrome.experimental.socket.write</span>(<span class="nul l"><span>integer</span>
1473 <var><span>socketId</span></var></span><span class="null"> <span>, </span><span>ArrayBuffer</span>
1474 <var><span>data</span></var></span><span class="null"><spa n>, </span><span>function</span>
1475 <var><span>WriteCallback</span></var></span>)</div>
1476 <div class="description">
1477 <p>Writes data on the given connected socket.</p>
1478 <!-- PARAMETERS -->
1479 <h4>Parameters</h4>
1480 <dl>
1481 <div>
1482 <div>
1483 <dt>
1484 <var>socketId</var>
1485 <em>
1486 <!-- TYPE -->
1487 <div style="display:inline">
1488 (
1489 <span id="typeTemplate">
1490 <span>
1491 <span>integer</span>
1492 </span>
1493 </span>
1494 )
1495 </div>
1496 </em>
1497 </dt>
1498 <dd>The socketId.</dd>
1499 <!-- OBJECT PROPERTIES -->
1500 <!-- OBJECT METHODS -->
1501 <!-- OBJECT EVENT FIELDS -->
1502 <!-- FUNCTION PARAMETERS -->
1503 </div>
1504 </div><div>
1505 <div>
1506 <dt>
1507 <var>data</var>
1508 <em>
1509 <!-- TYPE -->
1510 <div style="display:inline">
1511 (
1512 <span id="typeTemplate">
1513 <span>
1514 <span>ArrayBuffer</span>
1515 </span>
1516 </span>
1517 )
1518 </div>
1519 </em>
1520 </dt>
1521 <dd>The data to write.</dd>
1522 <!-- OBJECT PROPERTIES -->
1523 <!-- OBJECT METHODS -->
1524 <!-- OBJECT EVENT FIELDS -->
1525 <!-- FUNCTION PARAMETERS -->
1526 </div>
1527 </div><div>
1528 <div>
1529 <dt>
1530 <var>WriteCallback</var>
1531 <em>
1532 <!-- TYPE -->
1533 <div style="display:inline">
1534 (
1535 <span id="typeTemplate">
1536 <span>
1537 <span>function</span>
1538 </span>
1539 </span>
1540 )
1541 </div>
1542 </em>
1543 </dt>
1544 <dd class="todo">
1545 Undocumented.
1546 </dd>
1547 <!-- OBJECT PROPERTIES -->
1548 <!-- OBJECT METHODS -->
1549 <!-- OBJECT EVENT FIELDS -->
1550 <!-- FUNCTION PARAMETERS -->
1551 <dd>
1552 <div>
1553 <h5>Parameters</h5>
1554 <dl>
1555 <div>
1556 <div>
1557 <dt>
1558 <var>writeInfo</var>
1559 <em>
1560 <!-- TYPE -->
1561 <div style="display:inline">
1562 (
1563 <span id="typeTemplate">
1564 <span>
1565 <a href="experimental.socket.html#type-experimental.sock et.WriteInfo">experimental.socket.WriteInfo</a>
1566 </span>
1567 </span>
1568 )
1569 </div>
1570 </em>
1571 </dt>
1572 <dd class="todo">
1573 Undocumented.
1574 </dd>
1575 <!-- OBJECT PROPERTIES -->
1576 <!-- OBJECT METHODS -->
1577 <!-- OBJECT EVENT FIELDS -->
1578 <!-- FUNCTION PARAMETERS -->
1579 </div>
1580 </div>
1581 </dl>
1582 </div>
1583 </dd>
1584 </div>
1585 </div>
1586 </dl>
1587 <!-- RETURNS -->
1588 <dl>
1589 </dl>
1590 <!-- CALLBACK -->
1591 <!-- MIN_VERSION -->
1592 </div> <!-- /description -->
1593 </div> <!-- /apiItem -->
1594 </div> <!-- /apiGroup -->
1595 <!-- EVENTS -->
1596 <!-- /apiGroup -->
1597 <!-- TYPES -->
1598 <div class="apiGroup">
1599 <a name="types"></a>
1600 <h3 id="types">Types</h3>
1601 <!-- iterates over all types -->
1602 <div class="apiItem">
1603 <a name="type-experimental.socket.SocketType"></a>
1604 <h4>experimental.socket.SocketType</h4>
1605 <div>
1606 <dt>
1607 <em>
1608 <!-- TYPE -->
1609 <div style="display:inline">
1610 (
1611 <span class="enum">enumerated</span>
1612 <span id="typeTemplate">
1613 <span>
1614 <span>string</span>
1615 <span>["tcp", "udp"]</span>
1616 </span>
1617 </span>
1618 )
1619 </div>
1620 </em>
1621 </dt>
1622 <dd class="todo">
1623 Undocumented.
1624 </dd>
1625 <!-- OBJECT PROPERTIES -->
1626 <!-- OBJECT METHODS -->
1627 <!-- OBJECT EVENT FIELDS -->
1628 <!-- FUNCTION PARAMETERS -->
1629 </div>
1630 </div><div class="apiItem">
1631 <a name="type-experimental.socket.CreateOptions"></a>
1632 <h4>experimental.socket.CreateOptions</h4>
1633 <div>
1634 <dt>
1635 <em>
1636 <!-- TYPE -->
1637 <div style="display:inline">
1638 (
1639 <span id="typeTemplate">
1640 <span>
1641 <span>object</span>
1642 </span>
1643 </span>
1644 )
1645 </div>
1646 </em>
1647 </dt>
1648 <dd class="todo">
1649 Undocumented.
1650 </dd>
1651 <!-- OBJECT PROPERTIES -->
1652 <dd>
1653 <dl>
1654 </dl>
1655 </dd>
1656 <!-- OBJECT METHODS -->
1657 <!-- OBJECT EVENT FIELDS -->
1658 <!-- FUNCTION PARAMETERS -->
1659 </div>
1660 </div><div class="apiItem">
1661 <a name="type-experimental.socket.CreateInfo"></a>
1662 <h4>experimental.socket.CreateInfo</h4>
1663 <div>
1664 <dt>
1665 <em>
1666 <!-- TYPE -->
1667 <div style="display:inline">
1668 (
1669 <span id="typeTemplate">
1670 <span>
1671 <span>object</span>
1672 </span>
1673 </span>
1674 )
1675 </div>
1676 </em>
1677 </dt>
1678 <dd class="todo">
1679 Undocumented.
1680 </dd>
1681 <!-- OBJECT PROPERTIES -->
1682 <dd>
1683 <dl>
1684 <div>
1685 <div>
1686 <dt>
1687 <var>socketId</var>
1688 <em>
1689 <!-- TYPE -->
1690 <div style="display:inline">
1691 (
1692 <span id="typeTemplate">
1693 <span>
1694 <span>integer</span>
1695 </span>
1696 </span>
1697 )
1698 </div>
1699 </em>
1700 </dt>
1701 <dd>The id of the newly created socket.</dd>
1702 <!-- OBJECT PROPERTIES -->
1703 <!-- OBJECT METHODS -->
1704 <!-- OBJECT EVENT FIELDS -->
1705 <!-- FUNCTION PARAMETERS -->
1706 </div>
1707 </div>
1708 </dl>
1709 </dd>
1710 <!-- OBJECT METHODS -->
1711 <!-- OBJECT EVENT FIELDS -->
1712 <!-- FUNCTION PARAMETERS -->
1713 </div>
1714 </div><div class="apiItem">
1715 <a name="type-experimental.socket.ReadInfo"></a>
1716 <h4>experimental.socket.ReadInfo</h4>
1717 <div>
1718 <dt>
1719 <em>
1720 <!-- TYPE -->
1721 <div style="display:inline">
1722 (
1723 <span id="typeTemplate">
1724 <span>
1725 <span>object</span>
1726 </span>
1727 </span>
1728 )
1729 </div>
1730 </em>
1731 </dt>
1732 <dd class="todo">
1733 Undocumented.
1734 </dd>
1735 <!-- OBJECT PROPERTIES -->
1736 <dd>
1737 <dl>
1738 <div>
1739 <div>
1740 <dt>
1741 <var>data</var>
1742 <em>
1743 <!-- TYPE -->
1744 <div style="display:inline">
1745 (
1746 <span id="typeTemplate">
1747 <span>
1748 <span>ArrayBuffer</span>
1749 </span>
1750 </span>
1751 )
1752 </div>
1753 </em>
1754 </dt>
1755 <dd class="todo">
1756 Undocumented.
1757 </dd>
1758 <!-- OBJECT PROPERTIES -->
1759 <!-- OBJECT METHODS -->
1760 <!-- OBJECT EVENT FIELDS -->
1761 <!-- FUNCTION PARAMETERS -->
1762 </div>
1763 </div><div>
1764 <div>
1765 <dt>
1766 <var>resultCode</var>
1767 <em>
1768 <!-- TYPE -->
1769 <div style="display:inline">
1770 (
1771 <span id="typeTemplate">
1772 <span>
1773 <span>integer</span>
1774 </span>
1775 </span>
1776 )
1777 </div>
1778 </em>
1779 </dt>
1780 <dd>The resultCode returned from the underlying read() call.</dd>
1781 <!-- OBJECT PROPERTIES -->
1782 <!-- OBJECT METHODS -->
1783 <!-- OBJECT EVENT FIELDS -->
1784 <!-- FUNCTION PARAMETERS -->
1785 </div>
1786 </div>
1787 </dl>
1788 </dd>
1789 <!-- OBJECT METHODS -->
1790 <!-- OBJECT EVENT FIELDS -->
1791 <!-- FUNCTION PARAMETERS -->
1792 </div>
1793 </div><div class="apiItem">
1794 <a name="type-experimental.socket.WriteInfo"></a>
1795 <h4>experimental.socket.WriteInfo</h4>
1796 <div>
1797 <dt>
1798 <em>
1799 <!-- TYPE -->
1800 <div style="display:inline">
1801 (
1802 <span id="typeTemplate">
1803 <span>
1804 <span>object</span>
1805 </span>
1806 </span>
1807 )
1808 </div>
1809 </em>
1810 </dt>
1811 <dd class="todo">
1812 Undocumented.
1813 </dd>
1814 <!-- OBJECT PROPERTIES -->
1815 <dd>
1816 <dl>
1817 <div>
1818 <div>
1819 <dt>
1820 <var>bytesWritten</var>
1821 <em>
1822 <!-- TYPE -->
1823 <div style="display:inline">
1824 (
1825 <span id="typeTemplate">
1826 <span>
1827 <span>integer</span>
1828 </span>
1829 </span>
1830 )
1831 </div>
1832 </em>
1833 </dt>
1834 <dd>The number of bytes sent, or a negative error code.</dd>
1835 <!-- OBJECT PROPERTIES -->
1836 <!-- OBJECT METHODS -->
1837 <!-- OBJECT EVENT FIELDS -->
1838 <!-- FUNCTION PARAMETERS -->
1839 </div>
1840 </div>
1841 </dl>
1842 </dd>
1843 <!-- OBJECT METHODS -->
1844 <!-- OBJECT EVENT FIELDS -->
1845 <!-- FUNCTION PARAMETERS -->
1846 </div>
1847 </div><div class="apiItem">
1848 <a name="type-experimental.socket.RecvFromInfo"></a>
1849 <h4>experimental.socket.RecvFromInfo</h4>
1850 <div>
1851 <dt>
1852 <em>
1853 <!-- TYPE -->
1854 <div style="display:inline">
1855 (
1856 <span id="typeTemplate">
1857 <span>
1858 <span>object</span>
1859 </span>
1860 </span>
1861 )
1862 </div>
1863 </em>
1864 </dt>
1865 <dd class="todo">
1866 Undocumented.
1867 </dd>
1868 <!-- OBJECT PROPERTIES -->
1869 <dd>
1870 <dl>
1871 <div>
1872 <div>
1873 <dt>
1874 <var>address</var>
1875 <em>
1876 <!-- TYPE -->
1877 <div style="display:inline">
1878 (
1879 <span id="typeTemplate">
1880 <span>
1881 <span>string</span>
1882 </span>
1883 </span>
1884 )
1885 </div>
1886 </em>
1887 </dt>
1888 <dd>The address of the remote machine.</dd>
1889 <!-- OBJECT PROPERTIES -->
1890 <!-- OBJECT METHODS -->
1891 <!-- OBJECT EVENT FIELDS -->
1892 <!-- FUNCTION PARAMETERS -->
1893 </div>
1894 </div><div>
1895 <div>
1896 <dt>
1897 <var>data</var>
1898 <em>
1899 <!-- TYPE -->
1900 <div style="display:inline">
1901 (
1902 <span id="typeTemplate">
1903 <span>
1904 <span>ArrayBuffer</span>
1905 </span>
1906 </span>
1907 )
1908 </div>
1909 </em>
1910 </dt>
1911 <dd class="todo">
1912 Undocumented.
1913 </dd>
1914 <!-- OBJECT PROPERTIES -->
1915 <!-- OBJECT METHODS -->
1916 <!-- OBJECT EVENT FIELDS -->
1917 <!-- FUNCTION PARAMETERS -->
1918 </div>
1919 </div><div>
1920 <div>
1921 <dt>
1922 <var>port</var>
1923 <em>
1924 <!-- TYPE -->
1925 <div style="display:inline">
1926 (
1927 <span id="typeTemplate">
1928 <span>
1929 <span>integer</span>
1930 </span>
1931 </span>
1932 )
1933 </div>
1934 </em>
1935 </dt>
1936 <dd class="todo">
1937 Undocumented.
1938 </dd>
1939 <!-- OBJECT PROPERTIES -->
1940 <!-- OBJECT METHODS -->
1941 <!-- OBJECT EVENT FIELDS -->
1942 <!-- FUNCTION PARAMETERS -->
1943 </div>
1944 </div><div>
1945 <div>
1946 <dt>
1947 <var>resultCode</var>
1948 <em>
1949 <!-- TYPE -->
1950 <div style="display:inline">
1951 (
1952 <span id="typeTemplate">
1953 <span>
1954 <span>integer</span>
1955 </span>
1956 </span>
1957 )
1958 </div>
1959 </em>
1960 </dt>
1961 <dd>The resultCode returned from the underlying recvfrom() call.</dd>
1962 <!-- OBJECT PROPERTIES -->
1963 <!-- OBJECT METHODS -->
1964 <!-- OBJECT EVENT FIELDS -->
1965 <!-- FUNCTION PARAMETERS -->
1966 </div>
1967 </div>
1968 </dl>
1969 </dd>
1970 <!-- OBJECT METHODS -->
1971 <!-- OBJECT EVENT FIELDS -->
1972 <!-- FUNCTION PARAMETERS -->
1973 </div>
1974 </div> <!-- /apiItem -->
1975 </div> <!-- /apiGroup -->
1976 </div> <!-- /apiPage -->
1977 </div> <!-- /gc-pagecontent -->
1978 </div> <!-- /g-section -->
1979 </div> <!-- /codesiteContent -->
1980 <div id="gc-footer" --="">
1981 <div class="text">
1982 <p>
1983 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1984 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1985 Attribution 3.0 License</a>, and code samples are licensed under the
1986 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1987 </p>
1988 <p>
1989 ©2012 Google
1990 </p>
1991 <!-- begin analytics -->
1992 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
1993 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
1994 <script src="../js/prettify.js" type="text/javascript"></script>
1995 <script>
1996 // Auto syntax highlight all pre tags.
1997 var pres = document.querySelectorAll('pre');
1998 for (var i = 0, pre; pre = pres[i]; ++i) {
1999 pre.className += ' prettyprint';
2000 };
2001 prettyPrint();
2002 </script>
2003 <script type="text/javascript">
2004 // chrome doc tracking
2005 try {
2006 var engdocs = _gat._getTracker("YT-10763712-2");
2007 engdocs._trackPageview();
2008 } catch(err) {}
2009 // code.google.com site-wide tracking
2010 try {
2011 _uacct="UA-18071-1";
2012 _uanchor=1;
2013 _uff=0;
2014 urchinTracker();
2015 }
2016 catch(e) {/* urchinTracker not available. */}
2017 </script>
2018 <!-- end analytics -->
2019 </div>
2020 </div> <!-- /gc-footer -->
2021 </div> <!-- /gc-container -->
2022 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/apps/experimental.html ('k') | chrome/common/extensions/docs/apps/socket.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698