OLD | NEW |
| (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="extensions"> <link href="../css/ApiRefStyles.css" rel="styl
esheet" type="text/css"> | |
22 <link href="../css/shared.css" rel="stylesheet" type="text/css"> | |
23 <div id="devModeWarning" class="displayModeWarning"> | |
24 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. | |
25 </div> | |
26 <div id="branchWarning" class="displayModeWarning"> | |
27 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. | |
28 It may not work with the stable release of Chrome.</span> | |
29 <select id="branchChooser"> | |
30 <option>Choose a different version... | |
31 </option><option value="">Stable | |
32 </option><option value="beta">Beta | |
33 </option><option value="dev">Dev | |
34 </option><option value="trunk">Trunk | |
35 </option></select> | |
36 </div> | |
37 <div id="unofficialWarning" class="displayModeWarning"> | |
38 <span>WARNING: This is unofficial documentation. It may not work with the | |
39 current release of Chrome.</span> | |
40 <button id="goToOfficialDocs">Go to the official docs</button> | |
41 </div> | |
42 <div id="gc-container" class="labs"> | |
43 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> | |
44 <!-- In particular, sub-templates that recurse, must be used by allowing | |
45 jstemplate to make a copy of the template in this section which | |
46 are not operated on by way of the jsskip="true" --> | |
47 <!-- /SUBTEMPLATES --> | |
48 <a id="top"></a> | |
49 <div id="skipto"> | |
50 <a href="#gc-pagecontent">Skip to page content</a> | |
51 <a href="#gc-toc">Skip to main navigation</a> | |
52 </div> | |
53 <!-- API HEADER --> | |
54 <table id="header" width="100%" cellspacing="0" border="0"> | |
55 <tbody><tr> | |
56 <td valign="middle"><a href="http://code.google.com/"><img src="../image
s/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="bord
er:0; margin:0;"></a></td> | |
57 <td valign="middle" width="100%" style="padding-left:0.6em;"> | |
58 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.
5em"> | |
59 <div id="gsc-search-box"> | |
60 <input type="hidden" name="cx" value="002967670403910741006:61_cvz
fqtno"> | |
61 <input type="hidden" name="ie" value="UTF-8"> | |
62 <input type="text" name="q" value="" size="55"> | |
63 <input class="gsc-search-button" type="submit" name="sa" value="Se
arch"> | |
64 <br> | |
65 <span class="greytext">e.g. "page action" or "tabs"</span> | |
66 </div> | |
67 </form> | |
68 <script type="text/javascript" src="https://www.google.com/jsapi"></sc
ript> | |
69 <script type="text/javascript">google.load("elements", "1", {packages:
"transliteration"});</script> | |
70 <script type="text/javascript" src="https://www.google.com/coop/cse/t1
3n?form=cse&t13n_langs=en"></script> | |
71 <script type="text/javascript" src="https://www.google.com/coop/cse/br
and?form=cse&lang=en"></script> | |
72 </td> | |
73 </tr> | |
74 </tbody></table> | |
75 <div id="codesiteContent" class=""> | |
76 <a id="gc-topnav-anchor"></a> | |
77 <div id="gc-topnav"> | |
78 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab
s</a>)</h1> | |
79 <ul id="home" class="gc-topnav-tabs"> | |
80 <li id="home_link"> | |
81 <a href="index.html" title="Google Chrome Extensions home page">Home
</a> | |
82 </li> | |
83 <li id="docs_link"> | |
84 <a href="docs.html" title="Official Google Chrome Extensions documen
tation">Docs</a> | |
85 </li> | |
86 <li id="faq_link"> | |
87 <a href="faq.html" title="Answers to frequently asked questions abou
t Google Chrome Extensions">FAQ</a> | |
88 </li> | |
89 <li id="samples_link"> | |
90 <a href="samples.html" title="Sample extensions (with source code)">
Samples</a> | |
91 </li> | |
92 <li id="group_link"> | |
93 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte
nsions" title="Google Chrome Extensions developer forum">Group</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">Questions?</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><a href="getstarted.html">Getting Started</a></li> | |
105 <li><a href="overview.html">Overview</a></li> | |
106 <li><a href="whats_new.html">What's New?</a></li> | |
107 <li><h2><a href="devguide.html">Developer's Guide</a></h2> | |
108 <ul> | |
109 <li>Browser UI | |
110 <ul> | |
111 <li><a href="browserAction.html">Browser Actions</a></li> | |
112 <li><a href="contextMenus.html">Context Menus</a></li> | |
113 <li><a href="notifications.html">Desktop Notifications</a></li
> | |
114 <li><a href="omnibox.html">Omnibox</a></li> | |
115 <li><a href="options.html">Options Pages</a></li> | |
116 <li><a href="override.html">Override Pages</a></li> | |
117 <li><a href="pageAction.html">Page Actions</a></li> | |
118 </ul> | |
119 </li> | |
120 <li>Browser Interaction | |
121 <ul> | |
122 <li><a href="bookmarks.html">Bookmarks</a></li> | |
123 <li><a href="cookies.html">Cookies</a></li> | |
124 <li><a href="devtools.html">Developer Tools</a></li> | |
125 <li><a href="events.html">Events</a></li> | |
126 <li><a href="history.html">History</a></li> | |
127 <li><a href="management.html">Management</a></li> | |
128 <li><a href="tabs.html">Tabs</a></li> | |
129 <li><a href="windows.html">Windows</a></li> | |
130 </ul> | |
131 </li> | |
132 <li>Implementation | |
133 <ul> | |
134 <li><a href="a11y.html">Accessibility</a></li> | |
135 <li><a href="background_pages.html">Background Pages</a></li> | |
136 <li><a href="content_scripts.html">Content Scripts</a></li> | |
137 <li><a href="xhr.html">Cross-Origin XHR</a></li> | |
138 <li><a href="i18n.html">Internationalization</a></li> | |
139 <li><a href="messaging.html">Message Passing</a></li> | |
140 <li><a href="permissions.html">Optional Permissions</a></li> | |
141 <li><a href="npapi.html">NPAPI Plugins</a></li> | |
142 </ul> | |
143 </li> | |
144 <li>Finishing | |
145 <ul> | |
146 <li><a href="hosting.html">Hosting</a></li> | |
147 <li><a href="external_extensions.html">Other Deployment Option
s</a></li> | |
148 </ul> | |
149 </li> | |
150 </ul> | |
151 </li> | |
152 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> | |
153 <li><h2><a href="tutorials.html">Tutorials</a></h2> | |
154 <ul> | |
155 <li><a href="tut_debugging.html">Debugging</a></li> | |
156 <li><a href="tut_analytics.html">Google Analytics</a></li> | |
157 <li><a href="tut_oauth.html">OAuth</a></li> | |
158 </ul> | |
159 </li> | |
160 <li><h2>Reference</h2> | |
161 <ul> | |
162 <li>Formats | |
163 <ul> | |
164 <li><a href="manifest.html">Manifest Files</a></li> | |
165 <li><a href="match_patterns.html">Match Patterns</a></li> | |
166 </ul> | |
167 </li> | |
168 <li><a href="permission_warnings.html">Permission Warnings</a></li
> | |
169 <li><a href="api_index.html">chrome.* APIs</a></li> | |
170 <li><a href="api_other.html">Other APIs</a></li> | |
171 </ul> | |
172 </li> | |
173 <li><h2><a href="samples.html">Samples</a></h2></li> | |
174 <div class="line"> </div> | |
175 <li><h2>More</h2> | |
176 <ul> | |
177 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm
l">Chrome Web Store</a></li> | |
178 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu
ide.html">Hosted Apps</a></li> | |
179 <li><a href="themes.html">Themes</a></li> | |
180 </ul> | |
181 </li> | |
182 </ul> | |
183 </div> | |
184 <script> | |
185 initToggles(); | |
186 </script> | |
187 <div class="g-unit" id="gc-pagecontent"> | |
188 <div id="pageTitle"> | |
189 <h1 class="page_title">chrome.experimental.socket</h1> | |
190 </div> | |
191 <!-- TABLE OF CONTENTS --> | |
192 <div id="toc"> | |
193 <h2>Contents</h2> | |
194 <ol> | |
195 <li> | |
196 <a href="#apiReference">API reference: chrome.experimental.socke
t</a> | |
197 <ol> | |
198 <li> | |
199 <a href="#global-methods">Methods</a> | |
200 <ol> | |
201 <li> | |
202 <a href="#method-bind">bind</a> | |
203 </li><li> | |
204 <a href="#method-connect">connect</a> | |
205 </li><li> | |
206 <a href="#method-create">create</a> | |
207 </li><li> | |
208 <a href="#method-destroy">destroy</a> | |
209 </li><li> | |
210 <a href="#method-disconnect">disconnect</a> | |
211 </li><li> | |
212 <a href="#method-read">read</a> | |
213 </li><li> | |
214 <a href="#method-recvFrom">recvFrom</a> | |
215 </li><li> | |
216 <a href="#method-sendTo">sendTo</a> | |
217 </li><li> | |
218 <a href="#method-setKeepAlive">setKeepAlive</a> | |
219 </li><li> | |
220 <a href="#method-setNoDelay">setNoDelay</a> | |
221 </li><li> | |
222 <a href="#method-write">write</a> | |
223 </li> | |
224 </ol> | |
225 </li> | |
226 <li> | |
227 <a href="#types">Types</a> | |
228 <ol> | |
229 <li> | |
230 <a href="#type-experimental.socket.SocketType">SocketType</a> | |
231 <ol> | |
232 </ol> | |
233 </li><li> | |
234 <a href="#type-experimental.socket.CreateOptions">CreateOptions<
/a> | |
235 <ol> | |
236 </ol> | |
237 </li><li> | |
238 <a href="#type-experimental.socket.CreateInfo">CreateInfo</a> | |
239 <ol> | |
240 </ol> | |
241 </li><li> | |
242 <a href="#type-experimental.socket.ReadInfo">ReadInfo</a> | |
243 <ol> | |
244 </ol> | |
245 </li><li> | |
246 <a href="#type-experimental.socket.WriteInfo">WriteInfo</a> | |
247 <ol> | |
248 </ol> | |
249 </li><li> | |
250 <a href="#type-experimental.socket.RecvFromInfo">RecvFromInfo</a
> | |
251 <ol> | |
252 </ol> | |
253 </li> | |
254 </ol> | |
255 </li> | |
256 </ol> | |
257 </li> | |
258 </ol> | |
259 </div> | |
260 <!-- /TABLE OF CONTENTS --> | |
261 <!-- Standard content lead-in for experimental API pages --> | |
262 <p id="classSummary"> | |
263 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. | |
264 </p> | |
265 <!-- STATIC CONTENT PLACEHOLDER --> | |
266 <div id="static"></div> | |
267 <!-- API PAGE --> | |
268 <div class="apiPage"> | |
269 <a name="apiReference"></a> | |
270 <h2>API reference: chrome.experimental.socket</h2> | |
271 <!-- PROPERTIES --> | |
272 <!-- /apiGroup --> | |
273 <!-- METHODS --> | |
274 <div id="methodsTemplate" class="apiGroup"> | |
275 <a name="global-methods"></a> | |
276 <h3>Methods</h3> | |
277 <!-- iterates over all functions --> | |
278 <div class="apiItem"> | |
279 <a name="method-bind"></a> <!-- method-anchor --> | |
280 <h4>bind</h4> | |
281 <div class="summary"> | |
282 <!-- Note: intentionally longer 80 columns --> | |
283 <span>chrome.experimental.socket.bind</span>(<span class="null
"><span>integer</span> | |
284 <var><span>socketId</span></var></span><span class="null">
<span>, </span><span>string</span> | |
285 <var><span>address</span></var></span><span class="null"><
span>, </span><span>integer</span> | |
286 <var><span>port</span></var></span><span class="null"><spa
n>, </span><span>function</span> | |
287 <var><span>BindCallback</span></var></span>)</div> | |
288 <div class="description"> | |
289 <p>Binds the local address for socket. Currently, it does not su
pport TCP socket.</p> | |
290 <!-- PARAMETERS --> | |
291 <h4>Parameters</h4> | |
292 <dl> | |
293 <div> | |
294 <div> | |
295 <dt> | |
296 <var>socketId</var> | |
297 <em> | |
298 <!-- TYPE --> | |
299 <div style="display:inline"> | |
300 ( | |
301 <span id="typeTemplate"> | |
302 <span> | |
303 <span>integer</span> | |
304 </span> | |
305 </span> | |
306 ) | |
307 </div> | |
308 </em> | |
309 </dt> | |
310 <dd>The socketId.</dd> | |
311 <!-- OBJECT PROPERTIES --> | |
312 <!-- OBJECT METHODS --> | |
313 <!-- OBJECT EVENT FIELDS --> | |
314 <!-- FUNCTION PARAMETERS --> | |
315 </div> | |
316 </div><div> | |
317 <div> | |
318 <dt> | |
319 <var>address</var> | |
320 <em> | |
321 <!-- TYPE --> | |
322 <div style="display:inline"> | |
323 ( | |
324 <span id="typeTemplate"> | |
325 <span> | |
326 <span>string</span> | |
327 </span> | |
328 </span> | |
329 ) | |
330 </div> | |
331 </em> | |
332 </dt> | |
333 <dd>The address of the local machine.</dd> | |
334 <!-- OBJECT PROPERTIES --> | |
335 <!-- OBJECT METHODS --> | |
336 <!-- OBJECT EVENT FIELDS --> | |
337 <!-- FUNCTION PARAMETERS --> | |
338 </div> | |
339 </div><div> | |
340 <div> | |
341 <dt> | |
342 <var>port</var> | |
343 <em> | |
344 <!-- TYPE --> | |
345 <div style="display:inline"> | |
346 ( | |
347 <span id="typeTemplate"> | |
348 <span> | |
349 <span>integer</span> | |
350 </span> | |
351 </span> | |
352 ) | |
353 </div> | |
354 </em> | |
355 </dt> | |
356 <dd>The port of the local machine.</dd> | |
357 <!-- OBJECT PROPERTIES --> | |
358 <!-- OBJECT METHODS --> | |
359 <!-- OBJECT EVENT FIELDS --> | |
360 <!-- FUNCTION PARAMETERS --> | |
361 </div> | |
362 </div><div> | |
363 <div> | |
364 <dt> | |
365 <var>BindCallback</var> | |
366 <em> | |
367 <!-- TYPE --> | |
368 <div style="display:inline"> | |
369 ( | |
370 <span id="typeTemplate"> | |
371 <span> | |
372 <span>function</span> | |
373 </span> | |
374 </span> | |
375 ) | |
376 </div> | |
377 </em> | |
378 </dt> | |
379 <dd class="todo"> | |
380 Undocumented. | |
381 </dd> | |
382 <!-- OBJECT PROPERTIES --> | |
383 <!-- OBJECT METHODS --> | |
384 <!-- OBJECT EVENT FIELDS --> | |
385 <!-- FUNCTION PARAMETERS --> | |
386 <dd> | |
387 <div> | |
388 <h5>Parameters</h5> | |
389 <dl> | |
390 <div> | |
391 <div> | |
392 <dt> | |
393 <var>result</var> | |
394 <em> | |
395 <!-- TYPE --> | |
396 <div style="display:inline"> | |
397 ( | |
398 <span id="typeTemplate"> | |
399 <span> | |
400 <span>integer</span> | |
401 </span> | |
402 </span> | |
403 ) | |
404 </div> | |
405 </em> | |
406 </dt> | |
407 <dd class="todo"> | |
408 Undocumented. | |
409 </dd> | |
410 <!-- OBJECT PROPERTIES --> | |
411 <!-- OBJECT METHODS --> | |
412 <!-- OBJECT EVENT FIELDS --> | |
413 <!-- FUNCTION PARAMETERS --> | |
414 </div> | |
415 </div> | |
416 </dl> | |
417 </div> | |
418 </dd> | |
419 </div> | |
420 </div> | |
421 </dl> | |
422 <!-- RETURNS --> | |
423 <dl> | |
424 </dl> | |
425 <!-- CALLBACK --> | |
426 <div> | |
427 <div> | |
428 <h4>Callback function</h4> | |
429 <p> | |
430 The <em>callback</em> parameter should specify a function | |
431 that looks like this: | |
432 </p> | |
433 <!-- Note: intentionally longer 80 columns --> | |
434 <pre>function(<span>integer result</span>) <span class="subdue
d">{...}</span>;</pre> | |
435 <dl> | |
436 <div> | |
437 <div> | |
438 <dt> | |
439 <var>result</var> | |
440 <em> | |
441 <!-- TYPE --> | |
442 <div style="display:inline"> | |
443 ( | |
444 <span id="typeTemplate"> | |
445 <span> | |
446 <span>integer</span> | |
447 </span> | |
448 </span> | |
449 ) | |
450 </div> | |
451 </em> | |
452 </dt> | |
453 <dd class="todo"> | |
454 Undocumented. | |
455 </dd> | |
456 <!-- OBJECT PROPERTIES --> | |
457 <!-- OBJECT METHODS --> | |
458 <!-- OBJECT EVENT FIELDS --> | |
459 <!-- FUNCTION PARAMETERS --> | |
460 </div> | |
461 </div> | |
462 </dl> | |
463 </div> | |
464 </div> | |
465 <!-- MIN_VERSION --> | |
466 </div> <!-- /description --> | |
467 </div><div class="apiItem"> | |
468 <a name="method-connect"></a> <!-- method-anchor --> | |
469 <h4>connect</h4> | |
470 <div class="summary"> | |
471 <!-- Note: intentionally longer 80 columns --> | |
472 <span>chrome.experimental.socket.connect</span>(<span class="n
ull"><span>integer</span> | |
473 <var><span>socketId</span></var></span><span class="null">
<span>, </span><span>string</span> | |
474 <var><span>hostname</span></var></span><span class="null">
<span>, </span><span>integer</span> | |
475 <var><span>port</span></var></span><span class="null"><spa
n>, </span><span>function</span> | |
476 <var><span>ConnectCallback</span></var></span>)</div> | |
477 <div class="description"> | |
478 <p>Connects the socket to the remote machine.</p> | |
479 <!-- PARAMETERS --> | |
480 <h4>Parameters</h4> | |
481 <dl> | |
482 <div> | |
483 <div> | |
484 <dt> | |
485 <var>socketId</var> | |
486 <em> | |
487 <!-- TYPE --> | |
488 <div style="display:inline"> | |
489 ( | |
490 <span id="typeTemplate"> | |
491 <span> | |
492 <span>integer</span> | |
493 </span> | |
494 </span> | |
495 ) | |
496 </div> | |
497 </em> | |
498 </dt> | |
499 <dd>The socketId.</dd> | |
500 <!-- OBJECT PROPERTIES --> | |
501 <!-- OBJECT METHODS --> | |
502 <!-- OBJECT EVENT FIELDS --> | |
503 <!-- FUNCTION PARAMETERS --> | |
504 </div> | |
505 </div><div> | |
506 <div> | |
507 <dt> | |
508 <var>hostname</var> | |
509 <em> | |
510 <!-- TYPE --> | |
511 <div style="display:inline"> | |
512 ( | |
513 <span id="typeTemplate"> | |
514 <span> | |
515 <span>string</span> | |
516 </span> | |
517 </span> | |
518 ) | |
519 </div> | |
520 </em> | |
521 </dt> | |
522 <dd>The hostname or IP address of the remote machine.</dd> | |
523 <!-- OBJECT PROPERTIES --> | |
524 <!-- OBJECT METHODS --> | |
525 <!-- OBJECT EVENT FIELDS --> | |
526 <!-- FUNCTION PARAMETERS --> | |
527 </div> | |
528 </div><div> | |
529 <div> | |
530 <dt> | |
531 <var>port</var> | |
532 <em> | |
533 <!-- TYPE --> | |
534 <div style="display:inline"> | |
535 ( | |
536 <span id="typeTemplate"> | |
537 <span> | |
538 <span>integer</span> | |
539 </span> | |
540 </span> | |
541 ) | |
542 </div> | |
543 </em> | |
544 </dt> | |
545 <dd>The port of the remote machine.</dd> | |
546 <!-- OBJECT PROPERTIES --> | |
547 <!-- OBJECT METHODS --> | |
548 <!-- OBJECT EVENT FIELDS --> | |
549 <!-- FUNCTION PARAMETERS --> | |
550 </div> | |
551 </div><div> | |
552 <div> | |
553 <dt> | |
554 <var>ConnectCallback</var> | |
555 <em> | |
556 <!-- TYPE --> | |
557 <div style="display:inline"> | |
558 ( | |
559 <span id="typeTemplate"> | |
560 <span> | |
561 <span>function</span> | |
562 </span> | |
563 </span> | |
564 ) | |
565 </div> | |
566 </em> | |
567 </dt> | |
568 <dd class="todo"> | |
569 Undocumented. | |
570 </dd> | |
571 <!-- OBJECT PROPERTIES --> | |
572 <!-- OBJECT METHODS --> | |
573 <!-- OBJECT EVENT FIELDS --> | |
574 <!-- FUNCTION PARAMETERS --> | |
575 <dd> | |
576 <div> | |
577 <h5>Parameters</h5> | |
578 <dl> | |
579 <div> | |
580 <div> | |
581 <dt> | |
582 <var>result</var> | |
583 <em> | |
584 <!-- TYPE --> | |
585 <div style="display:inline"> | |
586 ( | |
587 <span id="typeTemplate"> | |
588 <span> | |
589 <span>integer</span> | |
590 </span> | |
591 </span> | |
592 ) | |
593 </div> | |
594 </em> | |
595 </dt> | |
596 <dd class="todo"> | |
597 Undocumented. | |
598 </dd> | |
599 <!-- OBJECT PROPERTIES --> | |
600 <!-- OBJECT METHODS --> | |
601 <!-- OBJECT EVENT FIELDS --> | |
602 <!-- FUNCTION PARAMETERS --> | |
603 </div> | |
604 </div> | |
605 </dl> | |
606 </div> | |
607 </dd> | |
608 </div> | |
609 </div> | |
610 </dl> | |
611 <!-- RETURNS --> | |
612 <dl> | |
613 </dl> | |
614 <!-- CALLBACK --> | |
615 <div> | |
616 <div> | |
617 <h4>Callback function</h4> | |
618 <p> | |
619 The <em>callback</em> parameter should specify a function | |
620 that looks like this: | |
621 </p> | |
622 <!-- Note: intentionally longer 80 columns --> | |
623 <pre>function(<span>integer result</span>) <span class="subdue
d">{...}</span>;</pre> | |
624 <dl> | |
625 <div> | |
626 <div> | |
627 <dt> | |
628 <var>result</var> | |
629 <em> | |
630 <!-- TYPE --> | |
631 <div style="display:inline"> | |
632 ( | |
633 <span id="typeTemplate"> | |
634 <span> | |
635 <span>integer</span> | |
636 </span> | |
637 </span> | |
638 ) | |
639 </div> | |
640 </em> | |
641 </dt> | |
642 <dd class="todo"> | |
643 Undocumented. | |
644 </dd> | |
645 <!-- OBJECT PROPERTIES --> | |
646 <!-- OBJECT METHODS --> | |
647 <!-- OBJECT EVENT FIELDS --> | |
648 <!-- FUNCTION PARAMETERS --> | |
649 </div> | |
650 </div> | |
651 </dl> | |
652 </div> | |
653 </div> | |
654 <!-- MIN_VERSION --> | |
655 </div> <!-- /description --> | |
656 </div><div class="apiItem"> | |
657 <a name="method-create"></a> <!-- method-anchor --> | |
658 <h4>create</h4> | |
659 <div class="summary"> | |
660 <!-- Note: intentionally longer 80 columns --> | |
661 <span>chrome.experimental.socket.create</span>(<span class="nu
ll"><span>experimental.socket.SocketType</span> | |
662 <var><span>type</span></var></span><span class="optional">
<span>, </span><span>experimental.socket.CreateOptions</span> | |
663 <var><span>options</span></var></span><span class="null"><
span>, </span><span>function</span> | |
664 <var><span>CreateCallback</span></var></span>)</div> | |
665 <div class="description"> | |
666 <p>Creates a socket of the specified type that will connect to t
he specified remote machine.</p> | |
667 <!-- PARAMETERS --> | |
668 <h4>Parameters</h4> | |
669 <dl> | |
670 <div> | |
671 <div> | |
672 <dt> | |
673 <var>type</var> | |
674 <em> | |
675 <!-- TYPE --> | |
676 <div style="display:inline"> | |
677 ( | |
678 <span id="typeTemplate"> | |
679 <span> | |
680 <a href="experimental.socket.html#type-experimental.sock
et.SocketType">experimental.socket.SocketType</a> | |
681 </span> | |
682 </span> | |
683 ) | |
684 </div> | |
685 </em> | |
686 </dt> | |
687 <dd>The type of socket to create. Must be <code>tcp</code> or <code>ud
p</code>.</dd> | |
688 <!-- OBJECT PROPERTIES --> | |
689 <!-- OBJECT METHODS --> | |
690 <!-- OBJECT EVENT FIELDS --> | |
691 <!-- FUNCTION PARAMETERS --> | |
692 </div> | |
693 </div><div> | |
694 <div> | |
695 <dt> | |
696 <var>options</var> | |
697 <em> | |
698 <!-- TYPE --> | |
699 <div style="display:inline"> | |
700 ( | |
701 <span class="optional">optional</span> | |
702 <span id="typeTemplate"> | |
703 <span> | |
704 <a href="experimental.socket.html#type-experimental.sock
et.CreateOptions">experimental.socket.CreateOptions</a> | |
705 </span> | |
706 </span> | |
707 ) | |
708 </div> | |
709 </em> | |
710 </dt> | |
711 <dd>The socket options.</dd> | |
712 <!-- OBJECT PROPERTIES --> | |
713 <!-- OBJECT METHODS --> | |
714 <!-- OBJECT EVENT FIELDS --> | |
715 <!-- FUNCTION PARAMETERS --> | |
716 </div> | |
717 </div><div> | |
718 <div> | |
719 <dt> | |
720 <var>CreateCallback</var> | |
721 <em> | |
722 <!-- TYPE --> | |
723 <div style="display:inline"> | |
724 ( | |
725 <span id="typeTemplate"> | |
726 <span> | |
727 <span>function</span> | |
728 </span> | |
729 </span> | |
730 ) | |
731 </div> | |
732 </em> | |
733 </dt> | |
734 <dd class="todo"> | |
735 Undocumented. | |
736 </dd> | |
737 <!-- OBJECT PROPERTIES --> | |
738 <!-- OBJECT METHODS --> | |
739 <!-- OBJECT EVENT FIELDS --> | |
740 <!-- FUNCTION PARAMETERS --> | |
741 <dd> | |
742 <div> | |
743 <h5>Parameters</h5> | |
744 <dl> | |
745 <div> | |
746 <div> | |
747 <dt> | |
748 <var>createInfo</var> | |
749 <em> | |
750 <!-- TYPE --> | |
751 <div style="display:inline"> | |
752 ( | |
753 <span id="typeTemplate"> | |
754 <span> | |
755 <a href="experimental.socket.html#type-experimental.sock
et.CreateInfo">experimental.socket.CreateInfo</a> | |
756 </span> | |
757 </span> | |
758 ) | |
759 </div> | |
760 </em> | |
761 </dt> | |
762 <dd class="todo"> | |
763 Undocumented. | |
764 </dd> | |
765 <!-- OBJECT PROPERTIES --> | |
766 <!-- OBJECT METHODS --> | |
767 <!-- OBJECT EVENT FIELDS --> | |
768 <!-- FUNCTION PARAMETERS --> | |
769 </div> | |
770 </div> | |
771 </dl> | |
772 </div> | |
773 </dd> | |
774 </div> | |
775 </div> | |
776 </dl> | |
777 <!-- RETURNS --> | |
778 <dl> | |
779 </dl> | |
780 <!-- CALLBACK --> | |
781 <div> | |
782 <div> | |
783 <h4>Callback function</h4> | |
784 <p> | |
785 The <em>callback</em> parameter should specify a function | |
786 that looks like this: | |
787 </p> | |
788 <!-- Note: intentionally longer 80 columns --> | |
789 <pre>function(<span>experimental.socket.CreateInfo createInfo<
/span>) <span class="subdued">{...}</span>;</pre> | |
790 <dl> | |
791 <div> | |
792 <div> | |
793 <dt> | |
794 <var>createInfo</var> | |
795 <em> | |
796 <!-- TYPE --> | |
797 <div style="display:inline"> | |
798 ( | |
799 <span id="typeTemplate"> | |
800 <span> | |
801 <a href="experimental.socket.html#type-experimental.sock
et.CreateInfo">experimental.socket.CreateInfo</a> | |
802 </span> | |
803 </span> | |
804 ) | |
805 </div> | |
806 </em> | |
807 </dt> | |
808 <dd class="todo"> | |
809 Undocumented. | |
810 </dd> | |
811 <!-- OBJECT PROPERTIES --> | |
812 <!-- OBJECT METHODS --> | |
813 <!-- OBJECT EVENT FIELDS --> | |
814 <!-- FUNCTION PARAMETERS --> | |
815 </div> | |
816 </div> | |
817 </dl> | |
818 </div> | |
819 </div> | |
820 <!-- MIN_VERSION --> | |
821 </div> <!-- /description --> | |
822 </div><div class="apiItem"> | |
823 <a name="method-destroy"></a> <!-- method-anchor --> | |
824 <h4>destroy</h4> | |
825 <div class="summary"> | |
826 <!-- Note: intentionally longer 80 columns --> | |
827 <span>chrome.experimental.socket.destroy</span>(<span class="n
ull"><span>integer</span> | |
828 <var><span>socketId</span></var></span>)</div> | |
829 <div class="description"> | |
830 <p>Destroys the socket. Each socket created should be destroyed
after use.</p> | |
831 <!-- PARAMETERS --> | |
832 <h4>Parameters</h4> | |
833 <dl> | |
834 <div> | |
835 <div> | |
836 <dt> | |
837 <var>socketId</var> | |
838 <em> | |
839 <!-- TYPE --> | |
840 <div style="display:inline"> | |
841 ( | |
842 <span id="typeTemplate"> | |
843 <span> | |
844 <span>integer</span> | |
845 </span> | |
846 </span> | |
847 ) | |
848 </div> | |
849 </em> | |
850 </dt> | |
851 <dd>The socketId.</dd> | |
852 <!-- OBJECT PROPERTIES --> | |
853 <!-- OBJECT METHODS --> | |
854 <!-- OBJECT EVENT FIELDS --> | |
855 <!-- FUNCTION PARAMETERS --> | |
856 </div> | |
857 </div> | |
858 </dl> | |
859 <!-- RETURNS --> | |
860 <dl> | |
861 </dl> | |
862 <!-- CALLBACK --> | |
863 <!-- MIN_VERSION --> | |
864 </div> <!-- /description --> | |
865 </div><div class="apiItem"> | |
866 <a name="method-disconnect"></a> <!-- method-anchor --> | |
867 <h4>disconnect</h4> | |
868 <div class="summary"> | |
869 <!-- Note: intentionally longer 80 columns --> | |
870 <span>chrome.experimental.socket.disconnect</span>(<span class
="null"><span>integer</span> | |
871 <var><span>socketId</span></var></span>)</div> | |
872 <div class="description"> | |
873 <p>Disconnects the socket. For UDP sockets, <code>disconnect</co
de> is a non-operation but is safe to call.</p> | |
874 <!-- PARAMETERS --> | |
875 <h4>Parameters</h4> | |
876 <dl> | |
877 <div> | |
878 <div> | |
879 <dt> | |
880 <var>socketId</var> | |
881 <em> | |
882 <!-- TYPE --> | |
883 <div style="display:inline"> | |
884 ( | |
885 <span id="typeTemplate"> | |
886 <span> | |
887 <span>integer</span> | |
888 </span> | |
889 </span> | |
890 ) | |
891 </div> | |
892 </em> | |
893 </dt> | |
894 <dd>The socketId.</dd> | |
895 <!-- OBJECT PROPERTIES --> | |
896 <!-- OBJECT METHODS --> | |
897 <!-- OBJECT EVENT FIELDS --> | |
898 <!-- FUNCTION PARAMETERS --> | |
899 </div> | |
900 </div> | |
901 </dl> | |
902 <!-- RETURNS --> | |
903 <dl> | |
904 </dl> | |
905 <!-- CALLBACK --> | |
906 <!-- MIN_VERSION --> | |
907 </div> <!-- /description --> | |
908 </div><div class="apiItem"> | |
909 <a name="method-read"></a> <!-- method-anchor --> | |
910 <h4>read</h4> | |
911 <div class="summary"> | |
912 <!-- Note: intentionally longer 80 columns --> | |
913 <span>chrome.experimental.socket.read</span>(<span class="null
"><span>integer</span> | |
914 <var><span>socketId</span></var></span><span class="option
al"><span>, </span><span>integer</span> | |
915 <var><span>bufferSize</span></var></span><span class="null
"><span>, </span><span>function</span> | |
916 <var><span>ReadCallback</span></var></span>)</div> | |
917 <div class="description"> | |
918 <p>Reads data from the given connected socket.</p> | |
919 <!-- PARAMETERS --> | |
920 <h4>Parameters</h4> | |
921 <dl> | |
922 <div> | |
923 <div> | |
924 <dt> | |
925 <var>socketId</var> | |
926 <em> | |
927 <!-- TYPE --> | |
928 <div style="display:inline"> | |
929 ( | |
930 <span id="typeTemplate"> | |
931 <span> | |
932 <span>integer</span> | |
933 </span> | |
934 </span> | |
935 ) | |
936 </div> | |
937 </em> | |
938 </dt> | |
939 <dd>The socketId.</dd> | |
940 <!-- OBJECT PROPERTIES --> | |
941 <!-- OBJECT METHODS --> | |
942 <!-- OBJECT EVENT FIELDS --> | |
943 <!-- FUNCTION PARAMETERS --> | |
944 </div> | |
945 </div><div> | |
946 <div> | |
947 <dt> | |
948 <var>bufferSize</var> | |
949 <em> | |
950 <!-- TYPE --> | |
951 <div style="display:inline"> | |
952 ( | |
953 <span class="optional">optional</span> | |
954 <span id="typeTemplate"> | |
955 <span> | |
956 <span>integer</span> | |
957 </span> | |
958 </span> | |
959 ) | |
960 </div> | |
961 </em> | |
962 </dt> | |
963 <dd>The read buffer size.</dd> | |
964 <!-- OBJECT PROPERTIES --> | |
965 <!-- OBJECT METHODS --> | |
966 <!-- OBJECT EVENT FIELDS --> | |
967 <!-- FUNCTION PARAMETERS --> | |
968 </div> | |
969 </div><div> | |
970 <div> | |
971 <dt> | |
972 <var>ReadCallback</var> | |
973 <em> | |
974 <!-- TYPE --> | |
975 <div style="display:inline"> | |
976 ( | |
977 <span id="typeTemplate"> | |
978 <span> | |
979 <span>function</span> | |
980 </span> | |
981 </span> | |
982 ) | |
983 </div> | |
984 </em> | |
985 </dt> | |
986 <dd class="todo"> | |
987 Undocumented. | |
988 </dd> | |
989 <!-- OBJECT PROPERTIES --> | |
990 <!-- OBJECT METHODS --> | |
991 <!-- OBJECT EVENT FIELDS --> | |
992 <!-- FUNCTION PARAMETERS --> | |
993 <dd> | |
994 <div> | |
995 <h5>Parameters</h5> | |
996 <dl> | |
997 <div> | |
998 <div> | |
999 <dt> | |
1000 <var>readInfo</var> | |
1001 <em> | |
1002 <!-- TYPE --> | |
1003 <div style="display:inline"> | |
1004 ( | |
1005 <span id="typeTemplate"> | |
1006 <span> | |
1007 <a href="experimental.socket.html#type-experimental.sock
et.ReadInfo">experimental.socket.ReadInfo</a> | |
1008 </span> | |
1009 </span> | |
1010 ) | |
1011 </div> | |
1012 </em> | |
1013 </dt> | |
1014 <dd class="todo"> | |
1015 Undocumented. | |
1016 </dd> | |
1017 <!-- OBJECT PROPERTIES --> | |
1018 <!-- OBJECT METHODS --> | |
1019 <!-- OBJECT EVENT FIELDS --> | |
1020 <!-- FUNCTION PARAMETERS --> | |
1021 </div> | |
1022 </div> | |
1023 </dl> | |
1024 </div> | |
1025 </dd> | |
1026 </div> | |
1027 </div> | |
1028 </dl> | |
1029 <!-- RETURNS --> | |
1030 <dl> | |
1031 </dl> | |
1032 <!-- CALLBACK --> | |
1033 <div> | |
1034 <div> | |
1035 <h4>Callback function</h4> | |
1036 <p> | |
1037 The <em>callback</em> parameter should specify a function | |
1038 that looks like this: | |
1039 </p> | |
1040 <!-- Note: intentionally longer 80 columns --> | |
1041 <pre>function(<span>experimental.socket.ReadInfo readInfo</spa
n>) <span class="subdued">{...}</span>;</pre> | |
1042 <dl> | |
1043 <div> | |
1044 <div> | |
1045 <dt> | |
1046 <var>readInfo</var> | |
1047 <em> | |
1048 <!-- TYPE --> | |
1049 <div style="display:inline"> | |
1050 ( | |
1051 <span id="typeTemplate"> | |
1052 <span> | |
1053 <a href="experimental.socket.html#type-experimental.sock
et.ReadInfo">experimental.socket.ReadInfo</a> | |
1054 </span> | |
1055 </span> | |
1056 ) | |
1057 </div> | |
1058 </em> | |
1059 </dt> | |
1060 <dd class="todo"> | |
1061 Undocumented. | |
1062 </dd> | |
1063 <!-- OBJECT PROPERTIES --> | |
1064 <!-- OBJECT METHODS --> | |
1065 <!-- OBJECT EVENT FIELDS --> | |
1066 <!-- FUNCTION PARAMETERS --> | |
1067 </div> | |
1068 </div> | |
1069 </dl> | |
1070 </div> | |
1071 </div> | |
1072 <!-- MIN_VERSION --> | |
1073 </div> <!-- /description --> | |
1074 </div><div class="apiItem"> | |
1075 <a name="method-recvFrom"></a> <!-- method-anchor --> | |
1076 <h4>recvFrom</h4> | |
1077 <div class="summary"> | |
1078 <!-- Note: intentionally longer 80 columns --> | |
1079 <span>chrome.experimental.socket.recvFrom</span>(<span class="
null"><span>integer</span> | |
1080 <var><span>socketId</span></var></span><span class="option
al"><span>, </span><span>integer</span> | |
1081 <var><span>bufferSize</span></var></span><span class="null
"><span>, </span><span>function</span> | |
1082 <var><span>RecvFromCallback</span></var></span>)</div> | |
1083 <div class="description"> | |
1084 <p>Receives data from the given UDP socket.</p> | |
1085 <!-- PARAMETERS --> | |
1086 <h4>Parameters</h4> | |
1087 <dl> | |
1088 <div> | |
1089 <div> | |
1090 <dt> | |
1091 <var>socketId</var> | |
1092 <em> | |
1093 <!-- TYPE --> | |
1094 <div style="display:inline"> | |
1095 ( | |
1096 <span id="typeTemplate"> | |
1097 <span> | |
1098 <span>integer</span> | |
1099 </span> | |
1100 </span> | |
1101 ) | |
1102 </div> | |
1103 </em> | |
1104 </dt> | |
1105 <dd>The socketId.</dd> | |
1106 <!-- OBJECT PROPERTIES --> | |
1107 <!-- OBJECT METHODS --> | |
1108 <!-- OBJECT EVENT FIELDS --> | |
1109 <!-- FUNCTION PARAMETERS --> | |
1110 </div> | |
1111 </div><div> | |
1112 <div> | |
1113 <dt> | |
1114 <var>bufferSize</var> | |
1115 <em> | |
1116 <!-- TYPE --> | |
1117 <div style="display:inline"> | |
1118 ( | |
1119 <span class="optional">optional</span> | |
1120 <span id="typeTemplate"> | |
1121 <span> | |
1122 <span>integer</span> | |
1123 </span> | |
1124 </span> | |
1125 ) | |
1126 </div> | |
1127 </em> | |
1128 </dt> | |
1129 <dd>The receive buffer size.</dd> | |
1130 <!-- OBJECT PROPERTIES --> | |
1131 <!-- OBJECT METHODS --> | |
1132 <!-- OBJECT EVENT FIELDS --> | |
1133 <!-- FUNCTION PARAMETERS --> | |
1134 </div> | |
1135 </div><div> | |
1136 <div> | |
1137 <dt> | |
1138 <var>RecvFromCallback</var> | |
1139 <em> | |
1140 <!-- TYPE --> | |
1141 <div style="display:inline"> | |
1142 ( | |
1143 <span id="typeTemplate"> | |
1144 <span> | |
1145 <span>function</span> | |
1146 </span> | |
1147 </span> | |
1148 ) | |
1149 </div> | |
1150 </em> | |
1151 </dt> | |
1152 <dd class="todo"> | |
1153 Undocumented. | |
1154 </dd> | |
1155 <!-- OBJECT PROPERTIES --> | |
1156 <!-- OBJECT METHODS --> | |
1157 <!-- OBJECT EVENT FIELDS --> | |
1158 <!-- FUNCTION PARAMETERS --> | |
1159 <dd> | |
1160 <div> | |
1161 <h5>Parameters</h5> | |
1162 <dl> | |
1163 <div> | |
1164 <div> | |
1165 <dt> | |
1166 <var>recvFromInfo</var> | |
1167 <em> | |
1168 <!-- TYPE --> | |
1169 <div style="display:inline"> | |
1170 ( | |
1171 <span id="typeTemplate"> | |
1172 <span> | |
1173 <a href="experimental.socket.html#type-experimental.sock
et.RecvFromInfo">experimental.socket.RecvFromInfo</a> | |
1174 </span> | |
1175 </span> | |
1176 ) | |
1177 </div> | |
1178 </em> | |
1179 </dt> | |
1180 <dd class="todo"> | |
1181 Undocumented. | |
1182 </dd> | |
1183 <!-- OBJECT PROPERTIES --> | |
1184 <!-- OBJECT METHODS --> | |
1185 <!-- OBJECT EVENT FIELDS --> | |
1186 <!-- FUNCTION PARAMETERS --> | |
1187 </div> | |
1188 </div> | |
1189 </dl> | |
1190 </div> | |
1191 </dd> | |
1192 </div> | |
1193 </div> | |
1194 </dl> | |
1195 <!-- RETURNS --> | |
1196 <dl> | |
1197 </dl> | |
1198 <!-- CALLBACK --> | |
1199 <div> | |
1200 <div> | |
1201 <h4>Callback function</h4> | |
1202 <p> | |
1203 The <em>callback</em> parameter should specify a function | |
1204 that looks like this: | |
1205 </p> | |
1206 <!-- Note: intentionally longer 80 columns --> | |
1207 <pre>function(<span>experimental.socket.RecvFromInfo recvFromI
nfo</span>) <span class="subdued">{...}</span>;</pre> | |
1208 <dl> | |
1209 <div> | |
1210 <div> | |
1211 <dt> | |
1212 <var>recvFromInfo</var> | |
1213 <em> | |
1214 <!-- TYPE --> | |
1215 <div style="display:inline"> | |
1216 ( | |
1217 <span id="typeTemplate"> | |
1218 <span> | |
1219 <a href="experimental.socket.html#type-experimental.sock
et.RecvFromInfo">experimental.socket.RecvFromInfo</a> | |
1220 </span> | |
1221 </span> | |
1222 ) | |
1223 </div> | |
1224 </em> | |
1225 </dt> | |
1226 <dd class="todo"> | |
1227 Undocumented. | |
1228 </dd> | |
1229 <!-- OBJECT PROPERTIES --> | |
1230 <!-- OBJECT METHODS --> | |
1231 <!-- OBJECT EVENT FIELDS --> | |
1232 <!-- FUNCTION PARAMETERS --> | |
1233 </div> | |
1234 </div> | |
1235 </dl> | |
1236 </div> | |
1237 </div> | |
1238 <!-- MIN_VERSION --> | |
1239 </div> <!-- /description --> | |
1240 </div><div class="apiItem"> | |
1241 <a name="method-sendTo"></a> <!-- method-anchor --> | |
1242 <h4>sendTo</h4> | |
1243 <div class="summary"> | |
1244 <!-- Note: intentionally longer 80 columns --> | |
1245 <span>chrome.experimental.socket.sendTo</span>(<span class="nu
ll"><span>integer</span> | |
1246 <var><span>socketId</span></var></span><span class="null">
<span>, </span><span>ArrayBuffer</span> | |
1247 <var><span>data</span></var></span><span class="null"><spa
n>, </span><span>string</span> | |
1248 <var><span>address</span></var></span><span class="null"><
span>, </span><span>integer</span> | |
1249 <var><span>port</span></var></span><span class="null"><spa
n>, </span><span>function</span> | |
1250 <var><span>SendToCallback</span></var></span>)</div> | |
1251 <div class="description"> | |
1252 <p>Sends data on the given UDP socket to the given address and p
ort.</p> | |
1253 <!-- PARAMETERS --> | |
1254 <h4>Parameters</h4> | |
1255 <dl> | |
1256 <div> | |
1257 <div> | |
1258 <dt> | |
1259 <var>socketId</var> | |
1260 <em> | |
1261 <!-- TYPE --> | |
1262 <div style="display:inline"> | |
1263 ( | |
1264 <span id="typeTemplate"> | |
1265 <span> | |
1266 <span>integer</span> | |
1267 </span> | |
1268 </span> | |
1269 ) | |
1270 </div> | |
1271 </em> | |
1272 </dt> | |
1273 <dd>The socketId.</dd> | |
1274 <!-- OBJECT PROPERTIES --> | |
1275 <!-- OBJECT METHODS --> | |
1276 <!-- OBJECT EVENT FIELDS --> | |
1277 <!-- FUNCTION PARAMETERS --> | |
1278 </div> | |
1279 </div><div> | |
1280 <div> | |
1281 <dt> | |
1282 <var>data</var> | |
1283 <em> | |
1284 <!-- TYPE --> | |
1285 <div style="display:inline"> | |
1286 ( | |
1287 <span id="typeTemplate"> | |
1288 <span> | |
1289 <span>ArrayBuffer</span> | |
1290 </span> | |
1291 </span> | |
1292 ) | |
1293 </div> | |
1294 </em> | |
1295 </dt> | |
1296 <dd>The data to write.</dd> | |
1297 <!-- OBJECT PROPERTIES --> | |
1298 <!-- OBJECT METHODS --> | |
1299 <!-- OBJECT EVENT FIELDS --> | |
1300 <!-- FUNCTION PARAMETERS --> | |
1301 </div> | |
1302 </div><div> | |
1303 <div> | |
1304 <dt> | |
1305 <var>address</var> | |
1306 <em> | |
1307 <!-- TYPE --> | |
1308 <div style="display:inline"> | |
1309 ( | |
1310 <span id="typeTemplate"> | |
1311 <span> | |
1312 <span>string</span> | |
1313 </span> | |
1314 </span> | |
1315 ) | |
1316 </div> | |
1317 </em> | |
1318 </dt> | |
1319 <dd>The address of the remote machine.</dd> | |
1320 <!-- OBJECT PROPERTIES --> | |
1321 <!-- OBJECT METHODS --> | |
1322 <!-- OBJECT EVENT FIELDS --> | |
1323 <!-- FUNCTION PARAMETERS --> | |
1324 </div> | |
1325 </div><div> | |
1326 <div> | |
1327 <dt> | |
1328 <var>port</var> | |
1329 <em> | |
1330 <!-- TYPE --> | |
1331 <div style="display:inline"> | |
1332 ( | |
1333 <span id="typeTemplate"> | |
1334 <span> | |
1335 <span>integer</span> | |
1336 </span> | |
1337 </span> | |
1338 ) | |
1339 </div> | |
1340 </em> | |
1341 </dt> | |
1342 <dd>The port of the remote machine.</dd> | |
1343 <!-- OBJECT PROPERTIES --> | |
1344 <!-- OBJECT METHODS --> | |
1345 <!-- OBJECT EVENT FIELDS --> | |
1346 <!-- FUNCTION PARAMETERS --> | |
1347 </div> | |
1348 </div><div> | |
1349 <div> | |
1350 <dt> | |
1351 <var>SendToCallback</var> | |
1352 <em> | |
1353 <!-- TYPE --> | |
1354 <div style="display:inline"> | |
1355 ( | |
1356 <span id="typeTemplate"> | |
1357 <span> | |
1358 <span>function</span> | |
1359 </span> | |
1360 </span> | |
1361 ) | |
1362 </div> | |
1363 </em> | |
1364 </dt> | |
1365 <dd class="todo"> | |
1366 Undocumented. | |
1367 </dd> | |
1368 <!-- OBJECT PROPERTIES --> | |
1369 <!-- OBJECT METHODS --> | |
1370 <!-- OBJECT EVENT FIELDS --> | |
1371 <!-- FUNCTION PARAMETERS --> | |
1372 <dd> | |
1373 <div> | |
1374 <h5>Parameters</h5> | |
1375 <dl> | |
1376 <div> | |
1377 <div> | |
1378 <dt> | |
1379 <var>writeInfo</var> | |
1380 <em> | |
1381 <!-- TYPE --> | |
1382 <div style="display:inline"> | |
1383 ( | |
1384 <span id="typeTemplate"> | |
1385 <span> | |
1386 <a href="experimental.socket.html#type-experimental.sock
et.WriteInfo">experimental.socket.WriteInfo</a> | |
1387 </span> | |
1388 </span> | |
1389 ) | |
1390 </div> | |
1391 </em> | |
1392 </dt> | |
1393 <dd class="todo"> | |
1394 Undocumented. | |
1395 </dd> | |
1396 <!-- OBJECT PROPERTIES --> | |
1397 <!-- OBJECT METHODS --> | |
1398 <!-- OBJECT EVENT FIELDS --> | |
1399 <!-- FUNCTION PARAMETERS --> | |
1400 </div> | |
1401 </div> | |
1402 </dl> | |
1403 </div> | |
1404 </dd> | |
1405 </div> | |
1406 </div> | |
1407 </dl> | |
1408 <!-- RETURNS --> | |
1409 <dl> | |
1410 </dl> | |
1411 <!-- CALLBACK --> | |
1412 <div> | |
1413 <div> | |
1414 <h4>Callback function</h4> | |
1415 <p> | |
1416 The <em>callback</em> parameter should specify a function | |
1417 that looks like this: | |
1418 </p> | |
1419 <!-- Note: intentionally longer 80 columns --> | |
1420 <pre>function(<span>experimental.socket.WriteInfo writeInfo</s
pan>) <span class="subdued">{...}</span>;</pre> | |
1421 <dl> | |
1422 <div> | |
1423 <div> | |
1424 <dt> | |
1425 <var>writeInfo</var> | |
1426 <em> | |
1427 <!-- TYPE --> | |
1428 <div style="display:inline"> | |
1429 ( | |
1430 <span id="typeTemplate"> | |
1431 <span> | |
1432 <a href="experimental.socket.html#type-experimental.sock
et.WriteInfo">experimental.socket.WriteInfo</a> | |
1433 </span> | |
1434 </span> | |
1435 ) | |
1436 </div> | |
1437 </em> | |
1438 </dt> | |
1439 <dd class="todo"> | |
1440 Undocumented. | |
1441 </dd> | |
1442 <!-- OBJECT PROPERTIES --> | |
1443 <!-- OBJECT METHODS --> | |
1444 <!-- OBJECT EVENT FIELDS --> | |
1445 <!-- FUNCTION PARAMETERS --> | |
1446 </div> | |
1447 </div> | |
1448 </dl> | |
1449 </div> | |
1450 </div> | |
1451 <!-- MIN_VERSION --> | |
1452 </div> <!-- /description --> | |
1453 </div><div class="apiItem"> | |
1454 <a name="method-setKeepAlive"></a> <!-- method-anchor --> | |
1455 <h4>setKeepAlive</h4> | |
1456 <div class="summary"> | |
1457 <!-- Note: intentionally longer 80 columns --> | |
1458 <span>chrome.experimental.socket.setKeepAlive</span>(<span cla
ss="null"><span>integer</span> | |
1459 <var><span>socketId</span></var></span><span class="null">
<span>, </span><span>boolean</span> | |
1460 <var><span>enable</span></var></span><span class="optional
"><span>, </span><span>integer</span> | |
1461 <var><span>delay</span></var></span><span class="null"><sp
an>, </span><span>function</span> | |
1462 <var><span>SetKeepAliveCallback</span></var></span>)</div> | |
1463 <div class="description"> | |
1464 <p>Enable/disable keep-alive functionality for a TCP connection.
</p> | |
1465 <!-- PARAMETERS --> | |
1466 <h4>Parameters</h4> | |
1467 <dl> | |
1468 <div> | |
1469 <div> | |
1470 <dt> | |
1471 <var>socketId</var> | |
1472 <em> | |
1473 <!-- TYPE --> | |
1474 <div style="display:inline"> | |
1475 ( | |
1476 <span id="typeTemplate"> | |
1477 <span> | |
1478 <span>integer</span> | |
1479 </span> | |
1480 </span> | |
1481 ) | |
1482 </div> | |
1483 </em> | |
1484 </dt> | |
1485 <dd>The socketId.</dd> | |
1486 <!-- OBJECT PROPERTIES --> | |
1487 <!-- OBJECT METHODS --> | |
1488 <!-- OBJECT EVENT FIELDS --> | |
1489 <!-- FUNCTION PARAMETERS --> | |
1490 </div> | |
1491 </div><div> | |
1492 <div> | |
1493 <dt> | |
1494 <var>enable</var> | |
1495 <em> | |
1496 <!-- TYPE --> | |
1497 <div style="display:inline"> | |
1498 ( | |
1499 <span id="typeTemplate"> | |
1500 <span> | |
1501 <span>boolean</span> | |
1502 </span> | |
1503 </span> | |
1504 ) | |
1505 </div> | |
1506 </em> | |
1507 </dt> | |
1508 <dd>If true, enable keep-alive functionality.</dd> | |
1509 <!-- OBJECT PROPERTIES --> | |
1510 <!-- OBJECT METHODS --> | |
1511 <!-- OBJECT EVENT FIELDS --> | |
1512 <!-- FUNCTION PARAMETERS --> | |
1513 </div> | |
1514 </div><div> | |
1515 <div> | |
1516 <dt> | |
1517 <var>delay</var> | |
1518 <em> | |
1519 <!-- TYPE --> | |
1520 <div style="display:inline"> | |
1521 ( | |
1522 <span class="optional">optional</span> | |
1523 <span id="typeTemplate"> | |
1524 <span> | |
1525 <span>integer</span> | |
1526 </span> | |
1527 </span> | |
1528 ) | |
1529 </div> | |
1530 </em> | |
1531 </dt> | |
1532 <dd>Set the delay seconds between the last data packet received and th
e first keepalive probe. Default is 0.</dd> | |
1533 <!-- OBJECT PROPERTIES --> | |
1534 <!-- OBJECT METHODS --> | |
1535 <!-- OBJECT EVENT FIELDS --> | |
1536 <!-- FUNCTION PARAMETERS --> | |
1537 </div> | |
1538 </div><div> | |
1539 <div> | |
1540 <dt> | |
1541 <var>SetKeepAliveCallback</var> | |
1542 <em> | |
1543 <!-- TYPE --> | |
1544 <div style="display:inline"> | |
1545 ( | |
1546 <span id="typeTemplate"> | |
1547 <span> | |
1548 <span>function</span> | |
1549 </span> | |
1550 </span> | |
1551 ) | |
1552 </div> | |
1553 </em> | |
1554 </dt> | |
1555 <dd class="todo"> | |
1556 Undocumented. | |
1557 </dd> | |
1558 <!-- OBJECT PROPERTIES --> | |
1559 <!-- OBJECT METHODS --> | |
1560 <!-- OBJECT EVENT FIELDS --> | |
1561 <!-- FUNCTION PARAMETERS --> | |
1562 <dd> | |
1563 <div> | |
1564 <h5>Parameters</h5> | |
1565 <dl> | |
1566 <div> | |
1567 <div> | |
1568 <dt> | |
1569 <var>result</var> | |
1570 <em> | |
1571 <!-- TYPE --> | |
1572 <div style="display:inline"> | |
1573 ( | |
1574 <span id="typeTemplate"> | |
1575 <span> | |
1576 <span>boolean</span> | |
1577 </span> | |
1578 </span> | |
1579 ) | |
1580 </div> | |
1581 </em> | |
1582 </dt> | |
1583 <dd class="todo"> | |
1584 Undocumented. | |
1585 </dd> | |
1586 <!-- OBJECT PROPERTIES --> | |
1587 <!-- OBJECT METHODS --> | |
1588 <!-- OBJECT EVENT FIELDS --> | |
1589 <!-- FUNCTION PARAMETERS --> | |
1590 </div> | |
1591 </div> | |
1592 </dl> | |
1593 </div> | |
1594 </dd> | |
1595 </div> | |
1596 </div> | |
1597 </dl> | |
1598 <!-- RETURNS --> | |
1599 <dl> | |
1600 </dl> | |
1601 <!-- CALLBACK --> | |
1602 <div> | |
1603 <div> | |
1604 <h4>Callback function</h4> | |
1605 <p> | |
1606 The <em>callback</em> parameter should specify a function | |
1607 that looks like this: | |
1608 </p> | |
1609 <!-- Note: intentionally longer 80 columns --> | |
1610 <pre>function(<span>boolean result</span>) <span class="subdue
d">{...}</span>;</pre> | |
1611 <dl> | |
1612 <div> | |
1613 <div> | |
1614 <dt> | |
1615 <var>result</var> | |
1616 <em> | |
1617 <!-- TYPE --> | |
1618 <div style="display:inline"> | |
1619 ( | |
1620 <span id="typeTemplate"> | |
1621 <span> | |
1622 <span>boolean</span> | |
1623 </span> | |
1624 </span> | |
1625 ) | |
1626 </div> | |
1627 </em> | |
1628 </dt> | |
1629 <dd class="todo"> | |
1630 Undocumented. | |
1631 </dd> | |
1632 <!-- OBJECT PROPERTIES --> | |
1633 <!-- OBJECT METHODS --> | |
1634 <!-- OBJECT EVENT FIELDS --> | |
1635 <!-- FUNCTION PARAMETERS --> | |
1636 </div> | |
1637 </div> | |
1638 </dl> | |
1639 </div> | |
1640 </div> | |
1641 <!-- MIN_VERSION --> | |
1642 </div> <!-- /description --> | |
1643 </div><div class="apiItem"> | |
1644 <a name="method-setNoDelay"></a> <!-- method-anchor --> | |
1645 <h4>setNoDelay</h4> | |
1646 <div class="summary"> | |
1647 <!-- Note: intentionally longer 80 columns --> | |
1648 <span>chrome.experimental.socket.setNoDelay</span>(<span class
="null"><span>integer</span> | |
1649 <var><span>socketId</span></var></span><span class="null">
<span>, </span><span>boolean</span> | |
1650 <var><span>noDelay</span></var></span><span class="null"><
span>, </span><span>function</span> | |
1651 <var><span>SetNoDelayCallback</span></var></span>)</div> | |
1652 <div class="description"> | |
1653 <p>Enable/disable Nagle algorithm.</p> | |
1654 <!-- PARAMETERS --> | |
1655 <h4>Parameters</h4> | |
1656 <dl> | |
1657 <div> | |
1658 <div> | |
1659 <dt> | |
1660 <var>socketId</var> | |
1661 <em> | |
1662 <!-- TYPE --> | |
1663 <div style="display:inline"> | |
1664 ( | |
1665 <span id="typeTemplate"> | |
1666 <span> | |
1667 <span>integer</span> | |
1668 </span> | |
1669 </span> | |
1670 ) | |
1671 </div> | |
1672 </em> | |
1673 </dt> | |
1674 <dd>The socketId.</dd> | |
1675 <!-- OBJECT PROPERTIES --> | |
1676 <!-- OBJECT METHODS --> | |
1677 <!-- OBJECT EVENT FIELDS --> | |
1678 <!-- FUNCTION PARAMETERS --> | |
1679 </div> | |
1680 </div><div> | |
1681 <div> | |
1682 <dt> | |
1683 <var>noDelay</var> | |
1684 <em> | |
1685 <!-- TYPE --> | |
1686 <div style="display:inline"> | |
1687 ( | |
1688 <span id="typeTemplate"> | |
1689 <span> | |
1690 <span>boolean</span> | |
1691 </span> | |
1692 </span> | |
1693 ) | |
1694 </div> | |
1695 </em> | |
1696 </dt> | |
1697 <dd>If true, disable Nagle algorithm.</dd> | |
1698 <!-- OBJECT PROPERTIES --> | |
1699 <!-- OBJECT METHODS --> | |
1700 <!-- OBJECT EVENT FIELDS --> | |
1701 <!-- FUNCTION PARAMETERS --> | |
1702 </div> | |
1703 </div><div> | |
1704 <div> | |
1705 <dt> | |
1706 <var>SetNoDelayCallback</var> | |
1707 <em> | |
1708 <!-- TYPE --> | |
1709 <div style="display:inline"> | |
1710 ( | |
1711 <span id="typeTemplate"> | |
1712 <span> | |
1713 <span>function</span> | |
1714 </span> | |
1715 </span> | |
1716 ) | |
1717 </div> | |
1718 </em> | |
1719 </dt> | |
1720 <dd class="todo"> | |
1721 Undocumented. | |
1722 </dd> | |
1723 <!-- OBJECT PROPERTIES --> | |
1724 <!-- OBJECT METHODS --> | |
1725 <!-- OBJECT EVENT FIELDS --> | |
1726 <!-- FUNCTION PARAMETERS --> | |
1727 <dd> | |
1728 <div> | |
1729 <h5>Parameters</h5> | |
1730 <dl> | |
1731 <div> | |
1732 <div> | |
1733 <dt> | |
1734 <var>result</var> | |
1735 <em> | |
1736 <!-- TYPE --> | |
1737 <div style="display:inline"> | |
1738 ( | |
1739 <span id="typeTemplate"> | |
1740 <span> | |
1741 <span>boolean</span> | |
1742 </span> | |
1743 </span> | |
1744 ) | |
1745 </div> | |
1746 </em> | |
1747 </dt> | |
1748 <dd class="todo"> | |
1749 Undocumented. | |
1750 </dd> | |
1751 <!-- OBJECT PROPERTIES --> | |
1752 <!-- OBJECT METHODS --> | |
1753 <!-- OBJECT EVENT FIELDS --> | |
1754 <!-- FUNCTION PARAMETERS --> | |
1755 </div> | |
1756 </div> | |
1757 </dl> | |
1758 </div> | |
1759 </dd> | |
1760 </div> | |
1761 </div> | |
1762 </dl> | |
1763 <!-- RETURNS --> | |
1764 <dl> | |
1765 </dl> | |
1766 <!-- CALLBACK --> | |
1767 <div> | |
1768 <div> | |
1769 <h4>Callback function</h4> | |
1770 <p> | |
1771 The <em>callback</em> parameter should specify a function | |
1772 that looks like this: | |
1773 </p> | |
1774 <!-- Note: intentionally longer 80 columns --> | |
1775 <pre>function(<span>boolean result</span>) <span class="subdue
d">{...}</span>;</pre> | |
1776 <dl> | |
1777 <div> | |
1778 <div> | |
1779 <dt> | |
1780 <var>result</var> | |
1781 <em> | |
1782 <!-- TYPE --> | |
1783 <div style="display:inline"> | |
1784 ( | |
1785 <span id="typeTemplate"> | |
1786 <span> | |
1787 <span>boolean</span> | |
1788 </span> | |
1789 </span> | |
1790 ) | |
1791 </div> | |
1792 </em> | |
1793 </dt> | |
1794 <dd class="todo"> | |
1795 Undocumented. | |
1796 </dd> | |
1797 <!-- OBJECT PROPERTIES --> | |
1798 <!-- OBJECT METHODS --> | |
1799 <!-- OBJECT EVENT FIELDS --> | |
1800 <!-- FUNCTION PARAMETERS --> | |
1801 </div> | |
1802 </div> | |
1803 </dl> | |
1804 </div> | |
1805 </div> | |
1806 <!-- MIN_VERSION --> | |
1807 </div> <!-- /description --> | |
1808 </div><div class="apiItem"> | |
1809 <a name="method-write"></a> <!-- method-anchor --> | |
1810 <h4>write</h4> | |
1811 <div class="summary"> | |
1812 <!-- Note: intentionally longer 80 columns --> | |
1813 <span>chrome.experimental.socket.write</span>(<span class="nul
l"><span>integer</span> | |
1814 <var><span>socketId</span></var></span><span class="null">
<span>, </span><span>ArrayBuffer</span> | |
1815 <var><span>data</span></var></span><span class="null"><spa
n>, </span><span>function</span> | |
1816 <var><span>WriteCallback</span></var></span>)</div> | |
1817 <div class="description"> | |
1818 <p>Writes data on the given connected socket.</p> | |
1819 <!-- PARAMETERS --> | |
1820 <h4>Parameters</h4> | |
1821 <dl> | |
1822 <div> | |
1823 <div> | |
1824 <dt> | |
1825 <var>socketId</var> | |
1826 <em> | |
1827 <!-- TYPE --> | |
1828 <div style="display:inline"> | |
1829 ( | |
1830 <span id="typeTemplate"> | |
1831 <span> | |
1832 <span>integer</span> | |
1833 </span> | |
1834 </span> | |
1835 ) | |
1836 </div> | |
1837 </em> | |
1838 </dt> | |
1839 <dd>The socketId.</dd> | |
1840 <!-- OBJECT PROPERTIES --> | |
1841 <!-- OBJECT METHODS --> | |
1842 <!-- OBJECT EVENT FIELDS --> | |
1843 <!-- FUNCTION PARAMETERS --> | |
1844 </div> | |
1845 </div><div> | |
1846 <div> | |
1847 <dt> | |
1848 <var>data</var> | |
1849 <em> | |
1850 <!-- TYPE --> | |
1851 <div style="display:inline"> | |
1852 ( | |
1853 <span id="typeTemplate"> | |
1854 <span> | |
1855 <span>ArrayBuffer</span> | |
1856 </span> | |
1857 </span> | |
1858 ) | |
1859 </div> | |
1860 </em> | |
1861 </dt> | |
1862 <dd>The data to write.</dd> | |
1863 <!-- OBJECT PROPERTIES --> | |
1864 <!-- OBJECT METHODS --> | |
1865 <!-- OBJECT EVENT FIELDS --> | |
1866 <!-- FUNCTION PARAMETERS --> | |
1867 </div> | |
1868 </div><div> | |
1869 <div> | |
1870 <dt> | |
1871 <var>WriteCallback</var> | |
1872 <em> | |
1873 <!-- TYPE --> | |
1874 <div style="display:inline"> | |
1875 ( | |
1876 <span id="typeTemplate"> | |
1877 <span> | |
1878 <span>function</span> | |
1879 </span> | |
1880 </span> | |
1881 ) | |
1882 </div> | |
1883 </em> | |
1884 </dt> | |
1885 <dd class="todo"> | |
1886 Undocumented. | |
1887 </dd> | |
1888 <!-- OBJECT PROPERTIES --> | |
1889 <!-- OBJECT METHODS --> | |
1890 <!-- OBJECT EVENT FIELDS --> | |
1891 <!-- FUNCTION PARAMETERS --> | |
1892 <dd> | |
1893 <div> | |
1894 <h5>Parameters</h5> | |
1895 <dl> | |
1896 <div> | |
1897 <div> | |
1898 <dt> | |
1899 <var>writeInfo</var> | |
1900 <em> | |
1901 <!-- TYPE --> | |
1902 <div style="display:inline"> | |
1903 ( | |
1904 <span id="typeTemplate"> | |
1905 <span> | |
1906 <a href="experimental.socket.html#type-experimental.sock
et.WriteInfo">experimental.socket.WriteInfo</a> | |
1907 </span> | |
1908 </span> | |
1909 ) | |
1910 </div> | |
1911 </em> | |
1912 </dt> | |
1913 <dd class="todo"> | |
1914 Undocumented. | |
1915 </dd> | |
1916 <!-- OBJECT PROPERTIES --> | |
1917 <!-- OBJECT METHODS --> | |
1918 <!-- OBJECT EVENT FIELDS --> | |
1919 <!-- FUNCTION PARAMETERS --> | |
1920 </div> | |
1921 </div> | |
1922 </dl> | |
1923 </div> | |
1924 </dd> | |
1925 </div> | |
1926 </div> | |
1927 </dl> | |
1928 <!-- RETURNS --> | |
1929 <dl> | |
1930 </dl> | |
1931 <!-- CALLBACK --> | |
1932 <div> | |
1933 <div> | |
1934 <h4>Callback function</h4> | |
1935 <p> | |
1936 The <em>callback</em> parameter should specify a function | |
1937 that looks like this: | |
1938 </p> | |
1939 <!-- Note: intentionally longer 80 columns --> | |
1940 <pre>function(<span>experimental.socket.WriteInfo writeInfo</s
pan>) <span class="subdued">{...}</span>;</pre> | |
1941 <dl> | |
1942 <div> | |
1943 <div> | |
1944 <dt> | |
1945 <var>writeInfo</var> | |
1946 <em> | |
1947 <!-- TYPE --> | |
1948 <div style="display:inline"> | |
1949 ( | |
1950 <span id="typeTemplate"> | |
1951 <span> | |
1952 <a href="experimental.socket.html#type-experimental.sock
et.WriteInfo">experimental.socket.WriteInfo</a> | |
1953 </span> | |
1954 </span> | |
1955 ) | |
1956 </div> | |
1957 </em> | |
1958 </dt> | |
1959 <dd class="todo"> | |
1960 Undocumented. | |
1961 </dd> | |
1962 <!-- OBJECT PROPERTIES --> | |
1963 <!-- OBJECT METHODS --> | |
1964 <!-- OBJECT EVENT FIELDS --> | |
1965 <!-- FUNCTION PARAMETERS --> | |
1966 </div> | |
1967 </div> | |
1968 </dl> | |
1969 </div> | |
1970 </div> | |
1971 <!-- MIN_VERSION --> | |
1972 </div> <!-- /description --> | |
1973 </div> <!-- /apiItem --> | |
1974 </div> <!-- /apiGroup --> | |
1975 <!-- EVENTS --> | |
1976 <!-- /apiGroup --> | |
1977 <!-- TYPES --> | |
1978 <div class="apiGroup"> | |
1979 <a name="types"></a> | |
1980 <h3 id="types">Types</h3> | |
1981 <!-- iterates over all types --> | |
1982 <div class="apiItem"> | |
1983 <a name="type-experimental.socket.SocketType"></a> | |
1984 <h4>experimental.socket.SocketType</h4> | |
1985 <div> | |
1986 <dt> | |
1987 <em> | |
1988 <!-- TYPE --> | |
1989 <div style="display:inline"> | |
1990 ( | |
1991 <span class="enum">enumerated</span> | |
1992 <span id="typeTemplate"> | |
1993 <span> | |
1994 <span>string</span> | |
1995 <span>["tcp", "udp"]</span> | |
1996 </span> | |
1997 </span> | |
1998 ) | |
1999 </div> | |
2000 </em> | |
2001 </dt> | |
2002 <dd class="todo"> | |
2003 Undocumented. | |
2004 </dd> | |
2005 <!-- OBJECT PROPERTIES --> | |
2006 <!-- OBJECT METHODS --> | |
2007 <!-- OBJECT EVENT FIELDS --> | |
2008 <!-- FUNCTION PARAMETERS --> | |
2009 </div> | |
2010 </div><div class="apiItem"> | |
2011 <a name="type-experimental.socket.CreateOptions"></a> | |
2012 <h4>experimental.socket.CreateOptions</h4> | |
2013 <div> | |
2014 <dt> | |
2015 <em> | |
2016 <!-- TYPE --> | |
2017 <div style="display:inline"> | |
2018 ( | |
2019 <span id="typeTemplate"> | |
2020 <span> | |
2021 <span>object</span> | |
2022 </span> | |
2023 </span> | |
2024 ) | |
2025 </div> | |
2026 </em> | |
2027 </dt> | |
2028 <dd class="todo"> | |
2029 Undocumented. | |
2030 </dd> | |
2031 <!-- OBJECT PROPERTIES --> | |
2032 <dd> | |
2033 <dl> | |
2034 </dl> | |
2035 </dd> | |
2036 <!-- OBJECT METHODS --> | |
2037 <!-- OBJECT EVENT FIELDS --> | |
2038 <!-- FUNCTION PARAMETERS --> | |
2039 </div> | |
2040 </div><div class="apiItem"> | |
2041 <a name="type-experimental.socket.CreateInfo"></a> | |
2042 <h4>experimental.socket.CreateInfo</h4> | |
2043 <div> | |
2044 <dt> | |
2045 <em> | |
2046 <!-- TYPE --> | |
2047 <div style="display:inline"> | |
2048 ( | |
2049 <span id="typeTemplate"> | |
2050 <span> | |
2051 <span>object</span> | |
2052 </span> | |
2053 </span> | |
2054 ) | |
2055 </div> | |
2056 </em> | |
2057 </dt> | |
2058 <dd class="todo"> | |
2059 Undocumented. | |
2060 </dd> | |
2061 <!-- OBJECT PROPERTIES --> | |
2062 <dd> | |
2063 <dl> | |
2064 <div> | |
2065 <div> | |
2066 <dt> | |
2067 <var>socketId</var> | |
2068 <em> | |
2069 <!-- TYPE --> | |
2070 <div style="display:inline"> | |
2071 ( | |
2072 <span id="typeTemplate"> | |
2073 <span> | |
2074 <span>integer</span> | |
2075 </span> | |
2076 </span> | |
2077 ) | |
2078 </div> | |
2079 </em> | |
2080 </dt> | |
2081 <dd>The id of the newly created socket.</dd> | |
2082 <!-- OBJECT PROPERTIES --> | |
2083 <!-- OBJECT METHODS --> | |
2084 <!-- OBJECT EVENT FIELDS --> | |
2085 <!-- FUNCTION PARAMETERS --> | |
2086 </div> | |
2087 </div> | |
2088 </dl> | |
2089 </dd> | |
2090 <!-- OBJECT METHODS --> | |
2091 <!-- OBJECT EVENT FIELDS --> | |
2092 <!-- FUNCTION PARAMETERS --> | |
2093 </div> | |
2094 </div><div class="apiItem"> | |
2095 <a name="type-experimental.socket.ReadInfo"></a> | |
2096 <h4>experimental.socket.ReadInfo</h4> | |
2097 <div> | |
2098 <dt> | |
2099 <em> | |
2100 <!-- TYPE --> | |
2101 <div style="display:inline"> | |
2102 ( | |
2103 <span id="typeTemplate"> | |
2104 <span> | |
2105 <span>object</span> | |
2106 </span> | |
2107 </span> | |
2108 ) | |
2109 </div> | |
2110 </em> | |
2111 </dt> | |
2112 <dd class="todo"> | |
2113 Undocumented. | |
2114 </dd> | |
2115 <!-- OBJECT PROPERTIES --> | |
2116 <dd> | |
2117 <dl> | |
2118 <div> | |
2119 <div> | |
2120 <dt> | |
2121 <var>data</var> | |
2122 <em> | |
2123 <!-- TYPE --> | |
2124 <div style="display:inline"> | |
2125 ( | |
2126 <span id="typeTemplate"> | |
2127 <span> | |
2128 <span>ArrayBuffer</span> | |
2129 </span> | |
2130 </span> | |
2131 ) | |
2132 </div> | |
2133 </em> | |
2134 </dt> | |
2135 <dd class="todo"> | |
2136 Undocumented. | |
2137 </dd> | |
2138 <!-- OBJECT PROPERTIES --> | |
2139 <!-- OBJECT METHODS --> | |
2140 <!-- OBJECT EVENT FIELDS --> | |
2141 <!-- FUNCTION PARAMETERS --> | |
2142 </div> | |
2143 </div><div> | |
2144 <div> | |
2145 <dt> | |
2146 <var>resultCode</var> | |
2147 <em> | |
2148 <!-- TYPE --> | |
2149 <div style="display:inline"> | |
2150 ( | |
2151 <span id="typeTemplate"> | |
2152 <span> | |
2153 <span>integer</span> | |
2154 </span> | |
2155 </span> | |
2156 ) | |
2157 </div> | |
2158 </em> | |
2159 </dt> | |
2160 <dd>The resultCode returned from the underlying read() call.</dd> | |
2161 <!-- OBJECT PROPERTIES --> | |
2162 <!-- OBJECT METHODS --> | |
2163 <!-- OBJECT EVENT FIELDS --> | |
2164 <!-- FUNCTION PARAMETERS --> | |
2165 </div> | |
2166 </div> | |
2167 </dl> | |
2168 </dd> | |
2169 <!-- OBJECT METHODS --> | |
2170 <!-- OBJECT EVENT FIELDS --> | |
2171 <!-- FUNCTION PARAMETERS --> | |
2172 </div> | |
2173 </div><div class="apiItem"> | |
2174 <a name="type-experimental.socket.WriteInfo"></a> | |
2175 <h4>experimental.socket.WriteInfo</h4> | |
2176 <div> | |
2177 <dt> | |
2178 <em> | |
2179 <!-- TYPE --> | |
2180 <div style="display:inline"> | |
2181 ( | |
2182 <span id="typeTemplate"> | |
2183 <span> | |
2184 <span>object</span> | |
2185 </span> | |
2186 </span> | |
2187 ) | |
2188 </div> | |
2189 </em> | |
2190 </dt> | |
2191 <dd class="todo"> | |
2192 Undocumented. | |
2193 </dd> | |
2194 <!-- OBJECT PROPERTIES --> | |
2195 <dd> | |
2196 <dl> | |
2197 <div> | |
2198 <div> | |
2199 <dt> | |
2200 <var>bytesWritten</var> | |
2201 <em> | |
2202 <!-- TYPE --> | |
2203 <div style="display:inline"> | |
2204 ( | |
2205 <span id="typeTemplate"> | |
2206 <span> | |
2207 <span>integer</span> | |
2208 </span> | |
2209 </span> | |
2210 ) | |
2211 </div> | |
2212 </em> | |
2213 </dt> | |
2214 <dd>The number of bytes sent, or a negative error code.</dd> | |
2215 <!-- OBJECT PROPERTIES --> | |
2216 <!-- OBJECT METHODS --> | |
2217 <!-- OBJECT EVENT FIELDS --> | |
2218 <!-- FUNCTION PARAMETERS --> | |
2219 </div> | |
2220 </div> | |
2221 </dl> | |
2222 </dd> | |
2223 <!-- OBJECT METHODS --> | |
2224 <!-- OBJECT EVENT FIELDS --> | |
2225 <!-- FUNCTION PARAMETERS --> | |
2226 </div> | |
2227 </div><div class="apiItem"> | |
2228 <a name="type-experimental.socket.RecvFromInfo"></a> | |
2229 <h4>experimental.socket.RecvFromInfo</h4> | |
2230 <div> | |
2231 <dt> | |
2232 <em> | |
2233 <!-- TYPE --> | |
2234 <div style="display:inline"> | |
2235 ( | |
2236 <span id="typeTemplate"> | |
2237 <span> | |
2238 <span>object</span> | |
2239 </span> | |
2240 </span> | |
2241 ) | |
2242 </div> | |
2243 </em> | |
2244 </dt> | |
2245 <dd class="todo"> | |
2246 Undocumented. | |
2247 </dd> | |
2248 <!-- OBJECT PROPERTIES --> | |
2249 <dd> | |
2250 <dl> | |
2251 <div> | |
2252 <div> | |
2253 <dt> | |
2254 <var>address</var> | |
2255 <em> | |
2256 <!-- TYPE --> | |
2257 <div style="display:inline"> | |
2258 ( | |
2259 <span id="typeTemplate"> | |
2260 <span> | |
2261 <span>string</span> | |
2262 </span> | |
2263 </span> | |
2264 ) | |
2265 </div> | |
2266 </em> | |
2267 </dt> | |
2268 <dd>The address of the remote machine.</dd> | |
2269 <!-- OBJECT PROPERTIES --> | |
2270 <!-- OBJECT METHODS --> | |
2271 <!-- OBJECT EVENT FIELDS --> | |
2272 <!-- FUNCTION PARAMETERS --> | |
2273 </div> | |
2274 </div><div> | |
2275 <div> | |
2276 <dt> | |
2277 <var>data</var> | |
2278 <em> | |
2279 <!-- TYPE --> | |
2280 <div style="display:inline"> | |
2281 ( | |
2282 <span id="typeTemplate"> | |
2283 <span> | |
2284 <span>ArrayBuffer</span> | |
2285 </span> | |
2286 </span> | |
2287 ) | |
2288 </div> | |
2289 </em> | |
2290 </dt> | |
2291 <dd class="todo"> | |
2292 Undocumented. | |
2293 </dd> | |
2294 <!-- OBJECT PROPERTIES --> | |
2295 <!-- OBJECT METHODS --> | |
2296 <!-- OBJECT EVENT FIELDS --> | |
2297 <!-- FUNCTION PARAMETERS --> | |
2298 </div> | |
2299 </div><div> | |
2300 <div> | |
2301 <dt> | |
2302 <var>port</var> | |
2303 <em> | |
2304 <!-- TYPE --> | |
2305 <div style="display:inline"> | |
2306 ( | |
2307 <span id="typeTemplate"> | |
2308 <span> | |
2309 <span>integer</span> | |
2310 </span> | |
2311 </span> | |
2312 ) | |
2313 </div> | |
2314 </em> | |
2315 </dt> | |
2316 <dd class="todo"> | |
2317 Undocumented. | |
2318 </dd> | |
2319 <!-- OBJECT PROPERTIES --> | |
2320 <!-- OBJECT METHODS --> | |
2321 <!-- OBJECT EVENT FIELDS --> | |
2322 <!-- FUNCTION PARAMETERS --> | |
2323 </div> | |
2324 </div><div> | |
2325 <div> | |
2326 <dt> | |
2327 <var>resultCode</var> | |
2328 <em> | |
2329 <!-- TYPE --> | |
2330 <div style="display:inline"> | |
2331 ( | |
2332 <span id="typeTemplate"> | |
2333 <span> | |
2334 <span>integer</span> | |
2335 </span> | |
2336 </span> | |
2337 ) | |
2338 </div> | |
2339 </em> | |
2340 </dt> | |
2341 <dd>The resultCode returned from the underlying recvfrom() call.</dd> | |
2342 <!-- OBJECT PROPERTIES --> | |
2343 <!-- OBJECT METHODS --> | |
2344 <!-- OBJECT EVENT FIELDS --> | |
2345 <!-- FUNCTION PARAMETERS --> | |
2346 </div> | |
2347 </div> | |
2348 </dl> | |
2349 </dd> | |
2350 <!-- OBJECT METHODS --> | |
2351 <!-- OBJECT EVENT FIELDS --> | |
2352 <!-- FUNCTION PARAMETERS --> | |
2353 </div> | |
2354 </div> <!-- /apiItem --> | |
2355 </div> <!-- /apiGroup --> | |
2356 </div> <!-- /apiPage --> | |
2357 </div> <!-- /gc-pagecontent --> | |
2358 </div> <!-- /g-section --> | |
2359 </div> <!-- /codesiteContent --> | |
2360 <div id="gc-footer" --=""> | |
2361 <div class="text"> | |
2362 <p> | |
2363 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, | |
2364 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons | |
2365 Attribution 3.0 License</a>, and code samples are licensed under the | |
2366 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. | |
2367 </p> | |
2368 <p> | |
2369 ©2011 Google | |
2370 </p> | |
2371 <!-- begin analytics --> | |
2372 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript">
</script> | |
2373 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc
ript> | |
2374 <script type="text/javascript"> | |
2375 // chrome doc tracking | |
2376 try { | |
2377 var engdocs = _gat._getTracker("YT-10763712-2"); | |
2378 engdocs._trackPageview(); | |
2379 } catch(err) {} | |
2380 // code.google.com site-wide tracking | |
2381 try { | |
2382 _uacct="UA-18071-1"; | |
2383 _uanchor=1; | |
2384 _uff=0; | |
2385 urchinTracker(); | |
2386 } | |
2387 catch(e) {/* urchinTracker not available. */} | |
2388 </script> | |
2389 <!-- end analytics --> | |
2390 </div> | |
2391 </div> <!-- /gc-footer --> | |
2392 </div> <!-- /gc-container --> | |
2393 </body></html> | |
OLD | NEW |