This repository was archived by the owner on Mar 6, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 387
/
Copy pathSocketIO.html
executable file
·793 lines (707 loc) · 29.9 KB
/
SocketIO.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_29) on Fri Mar 16 19:10:59 CET 2012 -->
<TITLE>
SocketIO
</TITLE>
<META NAME="date" CONTENT="2012-03-16">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SocketIO";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../io/socket/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketIO.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><B>PREV CLASS</B></A>
<A HREF="../../io/socket/SocketIOException.html" title="class in io.socket"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?io/socket/SocketIO.html" target="_top"><B>FRAMES</B></A>
<A HREF="SocketIO.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
io.socket</FONT>
<BR>
Class SocketIO</H2>
<PRE>
java.lang.Object
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>io.socket.SocketIO</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>SocketIO</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
The Class SocketIO.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO()">SocketIO</A></B>()</CODE>
<BR>
Instantiates a new socket.io connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.lang.String)">SocketIO</A></B>(java.lang.String url)</CODE>
<BR>
Instantiates a new socket.io connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.lang.String, io.socket.IOCallback)">SocketIO</A></B>(java.lang.String url,
<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)</CODE>
<BR>
Instantiates a new socket.io object and connects to the given url.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.lang.String, java.util.Properties)">SocketIO</A></B>(java.lang.String url,
java.util.Properties headers)</CODE>
<BR>
Instantiates a new socket.io connection and sets the request headers used
while connecting the first time for authorizing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.net.URL)">SocketIO</A></B>(java.net.URL url)</CODE>
<BR>
Instantiates a new socket.io connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.net.URL, io.socket.IOCallback)">SocketIO</A></B>(java.net.URL url,
<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)</CODE>
<BR>
Instantiates a new socket.io object and connects to the given url.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#addHeader(java.lang.String, java.lang.String)">addHeader</A></B>(java.lang.String key,
java.lang.String value)</CODE>
<BR>
Adds an header to the <A HREF="../../io/socket/SocketIO.html#headers"><CODE>headers</CODE></A></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#connect(io.socket.IOCallback)">connect</A></B>(<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)</CODE>
<BR>
connects to an already set host.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#connect(java.lang.String, io.socket.IOCallback)">connect</A></B>(java.lang.String url,
<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)</CODE>
<BR>
connects to supplied host using callback.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#connect(java.net.URL, io.socket.IOCallback)">connect</A></B>(java.net.URL url,
<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)</CODE>
<BR>
connects to supplied host using callback.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#disconnect()">disconnect</A></B>()</CODE>
<BR>
Disconnect the socket.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#emit(java.lang.String, io.socket.IOAcknowledge, java.lang.Object...)">emit</A></B>(java.lang.String event,
<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
java.lang.Object... args)</CODE>
<BR>
Emits an event to the Socket.IO server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#emit(java.lang.String, java.lang.Object...)">emit</A></B>(java.lang.String event,
java.lang.Object... args)</CODE>
<BR>
Emits an event to the Socket.IO server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#getCallback()">getCallback</A></B>()</CODE>
<BR>
Gets the callback.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#getHeader(java.lang.String)">getHeader</A></B>(java.lang.String key)</CODE>
<BR>
Returns the header value</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Properties</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#getHeaders()">getHeaders</A></B>()</CODE>
<BR>
Returns the headers used while handshaking.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#getNamespace()">getNamespace</A></B>()</CODE>
<BR>
Gets the namespace.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#getTransport()">getTransport</A></B>()</CODE>
<BR>
Returns the name of the used transport</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#isConnected()">isConnected</A></B>()</CODE>
<BR>
Returns, if a connection is established at the moment</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#reconnect()">reconnect</A></B>()</CODE>
<BR>
Triggers the transport to reconnect.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#send(io.socket.IOAcknowledge, org.json.JSONObject)">send</A></B>(<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
org.json.JSONObject json)</CODE>
<BR>
Send JSON data to the Socket.io server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#send(io.socket.IOAcknowledge, java.lang.String)">send</A></B>(<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
java.lang.String message)</CODE>
<BR>
Send JSON data to the Socket.io server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#send(org.json.JSONObject)">send</A></B>(org.json.JSONObject json)</CODE>
<BR>
Send JSON data to the Socket.io server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#send(java.lang.String)">send</A></B>(java.lang.String message)</CODE>
<BR>
Send String data to the Socket.io server.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../io/socket/SocketIO.html#setHeaders(java.util.Properties)">setHeaders</A></B>(java.util.Properties headers)</CODE>
<BR>
Sets the headers used while handshaking.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="SocketIO()"><!-- --></A><H3>
SocketIO</H3>
<PRE>
public <B>SocketIO</B>()</PRE>
<DL>
<DD>Instantiates a new socket.io connection. The object connects after
calling <A HREF="../../io/socket/SocketIO.html#connect(java.net.URL, io.socket.IOCallback)"><CODE>connect(URL, IOCallback)</CODE></A> or
<A HREF="../../io/socket/SocketIO.html#connect(java.lang.String, io.socket.IOCallback)"><CODE>connect(String, IOCallback)</CODE></A>
<P>
</DL>
<HR>
<A NAME="SocketIO(java.lang.String)"><!-- --></A><H3>
SocketIO</H3>
<PRE>
public <B>SocketIO</B>(java.lang.String url)
throws java.net.MalformedURLException</PRE>
<DL>
<DD>Instantiates a new socket.io connection. The object connects after
calling <A HREF="../../io/socket/SocketIO.html#connect(io.socket.IOCallback)"><CODE>connect(IOCallback)</CODE></A>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the url
<DT><B>Throws:</B>
<DD><CODE>java.net.MalformedURLException</CODE> - the malformed url exception</DL>
</DL>
<HR>
<A NAME="SocketIO(java.lang.String, java.util.Properties)"><!-- --></A><H3>
SocketIO</H3>
<PRE>
public <B>SocketIO</B>(java.lang.String url,
java.util.Properties headers)
throws java.net.MalformedURLException</PRE>
<DL>
<DD>Instantiates a new socket.io connection and sets the request headers used
while connecting the first time for authorizing. The object connects
after calling <A HREF="../../io/socket/SocketIO.html#connect(io.socket.IOCallback)"><CODE>connect(IOCallback)</CODE></A>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>headers</CODE> - the <CODE>headers</CODE> used while handshaking
<DT><B>Throws:</B>
<DD><CODE>java.net.MalformedURLException</CODE> - the malformed url exception</DL>
</DL>
<HR>
<A NAME="SocketIO(java.lang.String, io.socket.IOCallback)"><!-- --></A><H3>
SocketIO</H3>
<PRE>
public <B>SocketIO</B>(java.lang.String url,
<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)
throws java.net.MalformedURLException</PRE>
<DL>
<DD>Instantiates a new socket.io object and connects to the given url. Do not
call any of the connect() methods afterwards.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>callback</CODE> - the callback
<DT><B>Throws:</B>
<DD><CODE>java.net.MalformedURLException</CODE> - the malformed url exception</DL>
</DL>
<HR>
<A NAME="SocketIO(java.net.URL, io.socket.IOCallback)"><!-- --></A><H3>
SocketIO</H3>
<PRE>
public <B>SocketIO</B>(java.net.URL url,
<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)</PRE>
<DL>
<DD>Instantiates a new socket.io object and connects to the given url. Do not
call any of the connect() methods afterwards.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>callback</CODE> - the callback</DL>
</DL>
<HR>
<A NAME="SocketIO(java.net.URL)"><!-- --></A><H3>
SocketIO</H3>
<PRE>
public <B>SocketIO</B>(java.net.URL url)</PRE>
<DL>
<DD>Instantiates a new socket.io connection. The object connects after
calling <A HREF="../../io/socket/SocketIO.html#connect(io.socket.IOCallback)"><CODE>connect(IOCallback)</CODE></A>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the url</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="connect(java.lang.String, io.socket.IOCallback)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</B>(java.lang.String url,
<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)
throws java.net.MalformedURLException</PRE>
<DL>
<DD>connects to supplied host using callback. Do only use this method if you
instantiate <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> using <A HREF="../../io/socket/SocketIO.html#SocketIO()"><CODE>SocketIO()</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>callback</CODE> - the callback
<DT><B>Throws:</B>
<DD><CODE>java.net.MalformedURLException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="connect(java.net.URL, io.socket.IOCallback)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</B>(java.net.URL url,
<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)</PRE>
<DL>
<DD>connects to supplied host using callback. Do only use this method if you
instantiate <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> using <A HREF="../../io/socket/SocketIO.html#SocketIO()"><CODE>SocketIO()</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>callback</CODE> - the callback</DL>
</DD>
</DL>
<HR>
<A NAME="connect(io.socket.IOCallback)"><!-- --></A><H3>
connect</H3>
<PRE>
public void <B>connect</B>(<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> callback)</PRE>
<DL>
<DD>connects to an already set host. Do only use this method if you
instantiate <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> using <A HREF="../../io/socket/SocketIO.html#SocketIO(java.lang.String)"><CODE>SocketIO(String)</CODE></A> or
<A HREF="../../io/socket/SocketIO.html#SocketIO(java.net.URL)"><CODE>SocketIO(URL)</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>callback</CODE> - the callback</DL>
</DD>
</DL>
<HR>
<A NAME="emit(java.lang.String, java.lang.Object...)"><!-- --></A><H3>
emit</H3>
<PRE>
public void <B>emit</B>(java.lang.String event,
java.lang.Object... args)</PRE>
<DL>
<DD>Emits an event to the Socket.IO server. If the connection is not
established, the call will be buffered and sent as soon as it is
possible.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>event</CODE> - the event name<DD><CODE>args</CODE> - arguments. can be any argument <CODE>JSONArray.put(Object)</CODE> can take.</DL>
</DD>
</DL>
<HR>
<A NAME="emit(java.lang.String, io.socket.IOAcknowledge, java.lang.Object...)"><!-- --></A><H3>
emit</H3>
<PRE>
public void <B>emit</B>(java.lang.String event,
<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
java.lang.Object... args)</PRE>
<DL>
<DD>Emits an event to the Socket.IO server. If the connection is not
established, the call will be buffered and sent as soon as it is
possible.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>event</CODE> - the event name<DD><CODE>ack</CODE> - an acknowledge implementation<DD><CODE>args</CODE> - arguments. can be any argument <CODE>JSONArray.put(Object)</CODE> can take.</DL>
</DD>
</DL>
<HR>
<A NAME="getCallback()"><!-- --></A><H3>
getCallback</H3>
<PRE>
public <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> <B>getCallback</B>()</PRE>
<DL>
<DD>Gets the callback. Internally used.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the callback</DL>
</DD>
</DL>
<HR>
<A NAME="getNamespace()"><!-- --></A><H3>
getNamespace</H3>
<PRE>
public java.lang.String <B>getNamespace</B>()</PRE>
<DL>
<DD>Gets the namespace. Internally used.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the namespace</DL>
</DD>
</DL>
<HR>
<A NAME="send(org.json.JSONObject)"><!-- --></A><H3>
send</H3>
<PRE>
public void <B>send</B>(org.json.JSONObject json)</PRE>
<DL>
<DD>Send JSON data to the Socket.io server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>json</CODE> - the JSON object</DL>
</DD>
</DL>
<HR>
<A NAME="send(io.socket.IOAcknowledge, org.json.JSONObject)"><!-- --></A><H3>
send</H3>
<PRE>
public void <B>send</B>(<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
org.json.JSONObject json)</PRE>
<DL>
<DD>Send JSON data to the Socket.io server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ack</CODE> - an acknowledge implementation<DD><CODE>json</CODE> - the JSON object</DL>
</DD>
</DL>
<HR>
<A NAME="send(java.lang.String)"><!-- --></A><H3>
send</H3>
<PRE>
public void <B>send</B>(java.lang.String message)</PRE>
<DL>
<DD>Send String data to the Socket.io server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message String</DL>
</DD>
</DL>
<HR>
<A NAME="send(io.socket.IOAcknowledge, java.lang.String)"><!-- --></A><H3>
send</H3>
<PRE>
public void <B>send</B>(<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
java.lang.String message)</PRE>
<DL>
<DD>Send JSON data to the Socket.io server.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ack</CODE> - an acknowledge implementation<DD><CODE>message</CODE> - the message String</DL>
</DD>
</DL>
<HR>
<A NAME="disconnect()"><!-- --></A><H3>
disconnect</H3>
<PRE>
public void <B>disconnect</B>()</PRE>
<DL>
<DD>Disconnect the socket.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="reconnect()"><!-- --></A><H3>
reconnect</H3>
<PRE>
public void <B>reconnect</B>()</PRE>
<DL>
<DD>Triggers the transport to reconnect.
This had become useful on some android devices which do not shut down
tcp-connections when switching from HSDPA to Wifi
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isConnected()"><!-- --></A><H3>
isConnected</H3>
<PRE>
public boolean <B>isConnected</B>()</PRE>
<DL>
<DD>Returns, if a connection is established at the moment
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if a connection is established, false if the transport is
not connected or currently connecting</DL>
</DD>
</DL>
<HR>
<A NAME="getTransport()"><!-- --></A><H3>
getTransport</H3>
<PRE>
public java.lang.String <B>getTransport</B>()</PRE>
<DL>
<DD>Returns the name of the used transport
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the name of the currently used transport</DL>
</DD>
</DL>
<HR>
<A NAME="getHeaders()"><!-- --></A><H3>
getHeaders</H3>
<PRE>
public java.util.Properties <B>getHeaders</B>()</PRE>
<DL>
<DD>Returns the headers used while handshaking. These Properties are not
necessarily the ones set by <A HREF="../../io/socket/SocketIO.html#addHeader(java.lang.String, java.lang.String)"><CODE>addHeader(String, String)</CODE></A> or
<A HREF="../../io/socket/SocketIO.html#SocketIO(java.lang.String, java.util.Properties)"><CODE>SocketIO(String, Properties)</CODE></A> but the ones used for the
handshake.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the headers used while handshaking</DL>
</DD>
</DL>
<HR>
<A NAME="setHeaders(java.util.Properties)"><!-- --></A><H3>
setHeaders</H3>
<PRE>
void <B>setHeaders</B>(java.util.Properties headers)</PRE>
<DL>
<DD>Sets the headers used while handshaking. Internally used. Use
<A HREF="../../io/socket/SocketIO.html#SocketIO(java.lang.String, java.util.Properties)"><CODE>SocketIO(String, Properties)</CODE></A> or
<A HREF="../../io/socket/SocketIO.html#addHeader(java.lang.String, java.lang.String)"><CODE>addHeader(String, String)</CODE></A> instead.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>headers</CODE> - the headers used while handshaking</DL>
</DD>
</DL>
<HR>
<A NAME="addHeader(java.lang.String, java.lang.String)"><!-- --></A><H3>
addHeader</H3>
<PRE>
public <A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> <B>addHeader</B>(java.lang.String key,
java.lang.String value)</PRE>
<DL>
<DD>Adds an header to the <A HREF="../../io/socket/SocketIO.html#headers"><CODE>headers</CODE></A>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>SocketIO.this for daisy chaining.</DL>
</DD>
</DL>
<HR>
<A NAME="getHeader(java.lang.String)"><!-- --></A><H3>
getHeader</H3>
<PRE>
public java.lang.String <B>getHeader</B>(java.lang.String key)</PRE>
<DL>
<DD>Returns the header value
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the header value or <code>null</code> if not present</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../io/socket/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketIO.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><B>PREV CLASS</B></A>
<A HREF="../../io/socket/SocketIOException.html" title="class in io.socket"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?io/socket/SocketIO.html" target="_top"><B>FRAMES</B></A>
<A HREF="SocketIO.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>