PageRenderTime 61ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/doc/io/socket/SocketIO.html

https://github.com/clwillingham/socket.io-java-client
HTML | 651 lines | 559 code | 70 blank | 22 comment | 0 complexity | 00bef5242058e71921cfee8125d093a4 MD5 | raw file
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_29) on Thu Feb 16 08:46:29 CET 2012 -->
  6. <TITLE>
  7. SocketIO
  8. </TITLE>
  9. <META NAME="date" CONTENT="2012-02-16">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
  11. <SCRIPT type="text/javascript">
  12. function windowTitle()
  13. {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="SocketIO";
  16. }
  17. }
  18. </SCRIPT>
  19. <NOSCRIPT>
  20. </NOSCRIPT>
  21. </HEAD>
  22. <BODY BGCOLOR="white" onload="windowTitle();">
  23. <HR>
  24. <!-- ========= START OF TOP NAVBAR ======= -->
  25. <A NAME="navbar_top"><!-- --></A>
  26. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  27. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  28. <TR>
  29. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  30. <A NAME="navbar_top_firstrow"><!-- --></A>
  31. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  32. <TR ALIGN="center" VALIGN="top">
  33. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../io/socket/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  34. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketIO.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  37. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  38. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  39. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  40. </TR>
  41. </TABLE>
  42. </TD>
  43. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  44. </EM>
  45. </TD>
  46. </TR>
  47. <TR>
  48. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  49. &nbsp;<A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><B>PREV CLASS</B></A>&nbsp;
  50. &nbsp;<A HREF="../../io/socket/SocketIOException.html" title="class in io.socket"><B>NEXT CLASS</B></A></FONT></TD>
  51. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  52. <A HREF="../../index.html?io/socket/SocketIO.html" target="_top"><B>FRAMES</B></A> &nbsp;
  53. &nbsp;<A HREF="SocketIO.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  54. &nbsp;<SCRIPT type="text/javascript">
  55. <!--
  56. if(window==top) {
  57. document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  58. }
  59. //-->
  60. </SCRIPT>
  61. <NOSCRIPT>
  62. <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  63. </NOSCRIPT>
  64. </FONT></TD>
  65. </TR>
  66. <TR>
  67. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  68. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  71. </TR>
  72. </TABLE>
  73. <A NAME="skip-navbar_top"></A>
  74. <!-- ========= END OF TOP NAVBAR ========= -->
  75. <HR>
  76. <!-- ======== START OF CLASS DATA ======== -->
  77. <H2>
  78. <FONT SIZE="-1">
  79. io.socket</FONT>
  80. <BR>
  81. Class SocketIO</H2>
  82. <PRE>
  83. java.lang.Object
  84. <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>io.socket.SocketIO</B>
  85. </PRE>
  86. <HR>
  87. <DL>
  88. <DT><PRE>public class <B>SocketIO</B><DT>extends java.lang.Object</DL>
  89. </PRE>
  90. <P>
  91. The Class SocketIO.
  92. <P>
  93. <P>
  94. <HR>
  95. <P>
  96. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  97. <A NAME="constructor_summary"><!-- --></A>
  98. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  99. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  100. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  101. <B>Constructor Summary</B></FONT></TH>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO()">SocketIO</A></B>()</CODE>
  105. <BR>
  106. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instantiates a new socket.io connection.</TD>
  107. </TR>
  108. <TR BGCOLOR="white" CLASS="TableRowColor">
  109. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.lang.String)">SocketIO</A></B>(java.lang.String&nbsp;url)</CODE>
  110. <BR>
  111. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instantiates a new socket.io connection.</TD>
  112. </TR>
  113. <TR BGCOLOR="white" CLASS="TableRowColor">
  114. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.lang.String, io.socket.IOCallback)">SocketIO</A></B>(java.lang.String&nbsp;url,
  115. <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)</CODE>
  116. <BR>
  117. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instantiates a new socket.io object and connects to the given url.</TD>
  118. </TR>
  119. <TR BGCOLOR="white" CLASS="TableRowColor">
  120. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.net.URL)">SocketIO</A></B>(java.net.URL&nbsp;url)</CODE>
  121. <BR>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instantiates a new socket.io connection.</TD>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#SocketIO(java.net.URL, io.socket.IOCallback)">SocketIO</A></B>(java.net.URL&nbsp;url,
  126. <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)</CODE>
  127. <BR>
  128. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instantiates a new socket.io object and connects to the given url.</TD>
  129. </TR>
  130. </TABLE>
  131. &nbsp;
  132. <!-- ========== METHOD SUMMARY =========== -->
  133. <A NAME="method_summary"><!-- --></A>
  134. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  135. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  136. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  137. <B>Method Summary</B></FONT></TH>
  138. </TR>
  139. <TR BGCOLOR="white" CLASS="TableRowColor">
  140. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  141. <CODE>&nbsp;void</CODE></FONT></TD>
  142. <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>&nbsp;callback)</CODE>
  143. <BR>
  144. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;connects to an already set host.</TD>
  145. </TR>
  146. <TR BGCOLOR="white" CLASS="TableRowColor">
  147. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  148. <CODE>&nbsp;void</CODE></FONT></TD>
  149. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#connect(java.lang.String, io.socket.IOCallback)">connect</A></B>(java.lang.String&nbsp;url,
  150. <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)</CODE>
  151. <BR>
  152. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;connects to supplied host using callback.</TD>
  153. </TR>
  154. <TR BGCOLOR="white" CLASS="TableRowColor">
  155. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  156. <CODE>&nbsp;void</CODE></FONT></TD>
  157. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#connect(java.net.URL, io.socket.IOCallback)">connect</A></B>(java.net.URL&nbsp;url,
  158. <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)</CODE>
  159. <BR>
  160. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;connects to supplied host using callback.</TD>
  161. </TR>
  162. <TR BGCOLOR="white" CLASS="TableRowColor">
  163. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  164. <CODE>&nbsp;void</CODE></FONT></TD>
  165. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#disconnect()">disconnect</A></B>()</CODE>
  166. <BR>
  167. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Disconnect the socket.</TD>
  168. </TR>
  169. <TR BGCOLOR="white" CLASS="TableRowColor">
  170. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  171. <CODE>&nbsp;void</CODE></FONT></TD>
  172. <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&nbsp;event,
  173. <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  174. java.lang.Object...&nbsp;args)</CODE>
  175. <BR>
  176. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Emits an event to the Socket.IO server.</TD>
  177. </TR>
  178. <TR BGCOLOR="white" CLASS="TableRowColor">
  179. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  180. <CODE>&nbsp;void</CODE></FONT></TD>
  181. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#emit(java.lang.String, java.lang.Object...)">emit</A></B>(java.lang.String&nbsp;event,
  182. java.lang.Object...&nbsp;args)</CODE>
  183. <BR>
  184. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Emits an event to the Socket.IO server.</TD>
  185. </TR>
  186. <TR BGCOLOR="white" CLASS="TableRowColor">
  187. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  188. <CODE>&nbsp;<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A></CODE></FONT></TD>
  189. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#getCallback()">getCallback</A></B>()</CODE>
  190. <BR>
  191. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the callback.</TD>
  192. </TR>
  193. <TR BGCOLOR="white" CLASS="TableRowColor">
  194. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  195. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  196. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#getNamespace()">getNamespace</A></B>()</CODE>
  197. <BR>
  198. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the namespace.</TD>
  199. </TR>
  200. <TR BGCOLOR="white" CLASS="TableRowColor">
  201. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  202. <CODE>&nbsp;boolean</CODE></FONT></TD>
  203. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#isConnected()">isConnected</A></B>()</CODE>
  204. <BR>
  205. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns, if a connection is established at the moment</TD>
  206. </TR>
  207. <TR BGCOLOR="white" CLASS="TableRowColor">
  208. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  209. <CODE>&nbsp;void</CODE></FONT></TD>
  210. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#reconnect()">reconnect</A></B>()</CODE>
  211. <BR>
  212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Triggers the transport to reconnect.</TD>
  213. </TR>
  214. <TR BGCOLOR="white" CLASS="TableRowColor">
  215. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  216. <CODE>&nbsp;void</CODE></FONT></TD>
  217. <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>&nbsp;ack,
  218. org.json.JSONObject&nbsp;json)</CODE>
  219. <BR>
  220. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send JSON data to the Socket.io server.</TD>
  221. </TR>
  222. <TR BGCOLOR="white" CLASS="TableRowColor">
  223. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  224. <CODE>&nbsp;void</CODE></FONT></TD>
  225. <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>&nbsp;ack,
  226. java.lang.String&nbsp;message)</CODE>
  227. <BR>
  228. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send JSON data to the Socket.io server.</TD>
  229. </TR>
  230. <TR BGCOLOR="white" CLASS="TableRowColor">
  231. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  232. <CODE>&nbsp;void</CODE></FONT></TD>
  233. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#send(org.json.JSONObject)">send</A></B>(org.json.JSONObject&nbsp;json)</CODE>
  234. <BR>
  235. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send JSON data to the Socket.io server.</TD>
  236. </TR>
  237. <TR BGCOLOR="white" CLASS="TableRowColor">
  238. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  239. <CODE>&nbsp;void</CODE></FONT></TD>
  240. <TD><CODE><B><A HREF="../../io/socket/SocketIO.html#send(java.lang.String)">send</A></B>(java.lang.String&nbsp;message)</CODE>
  241. <BR>
  242. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send String data to the Socket.io server.</TD>
  243. </TR>
  244. </TABLE>
  245. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  246. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  247. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  248. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  249. </TR>
  250. <TR BGCOLOR="white" CLASS="TableRowColor">
  251. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  252. </TR>
  253. </TABLE>
  254. &nbsp;
  255. <P>
  256. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  257. <A NAME="constructor_detail"><!-- --></A>
  258. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  259. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  260. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  261. <B>Constructor Detail</B></FONT></TH>
  262. </TR>
  263. </TABLE>
  264. <A NAME="SocketIO()"><!-- --></A><H3>
  265. SocketIO</H3>
  266. <PRE>
  267. public <B>SocketIO</B>()</PRE>
  268. <DL>
  269. <DD>Instantiates a new socket.io connection. The object connects after
  270. calling <A HREF="../../io/socket/SocketIO.html#connect(java.net.URL, io.socket.IOCallback)"><CODE>connect(URL, IOCallback)</CODE></A> or
  271. <A HREF="../../io/socket/SocketIO.html#connect(java.lang.String, io.socket.IOCallback)"><CODE>connect(String, IOCallback)</CODE></A>
  272. <P>
  273. </DL>
  274. <HR>
  275. <A NAME="SocketIO(java.lang.String)"><!-- --></A><H3>
  276. SocketIO</H3>
  277. <PRE>
  278. public <B>SocketIO</B>(java.lang.String&nbsp;url)
  279. throws java.net.MalformedURLException</PRE>
  280. <DL>
  281. <DD>Instantiates a new socket.io connection. The object connects after
  282. calling <A HREF="../../io/socket/SocketIO.html#connect(io.socket.IOCallback)"><CODE>connect(IOCallback)</CODE></A>
  283. <P>
  284. <DL>
  285. <DT><B>Parameters:</B><DD><CODE>url</CODE> - the url
  286. <DT><B>Throws:</B>
  287. <DD><CODE>java.net.MalformedURLException</CODE> - the malformed url exception</DL>
  288. </DL>
  289. <HR>
  290. <A NAME="SocketIO(java.lang.String, io.socket.IOCallback)"><!-- --></A><H3>
  291. SocketIO</H3>
  292. <PRE>
  293. public <B>SocketIO</B>(java.lang.String&nbsp;url,
  294. <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)
  295. throws java.net.MalformedURLException</PRE>
  296. <DL>
  297. <DD>Instantiates a new socket.io object and connects to the given url. Do not
  298. call any of the connect() methods afterwards.
  299. <P>
  300. <DL>
  301. <DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>callback</CODE> - the callback
  302. <DT><B>Throws:</B>
  303. <DD><CODE>java.net.MalformedURLException</CODE> - the malformed url exception</DL>
  304. </DL>
  305. <HR>
  306. <A NAME="SocketIO(java.net.URL, io.socket.IOCallback)"><!-- --></A><H3>
  307. SocketIO</H3>
  308. <PRE>
  309. public <B>SocketIO</B>(java.net.URL&nbsp;url,
  310. <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)</PRE>
  311. <DL>
  312. <DD>Instantiates a new socket.io object and connects to the given url. Do not
  313. call any of the connect() methods afterwards.
  314. <P>
  315. <DL>
  316. <DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>callback</CODE> - the callback</DL>
  317. </DL>
  318. <HR>
  319. <A NAME="SocketIO(java.net.URL)"><!-- --></A><H3>
  320. SocketIO</H3>
  321. <PRE>
  322. public <B>SocketIO</B>(java.net.URL&nbsp;url)</PRE>
  323. <DL>
  324. <DD>Instantiates a new socket.io connection. The object connects after
  325. calling <A HREF="../../io/socket/SocketIO.html#connect(io.socket.IOCallback)"><CODE>connect(IOCallback)</CODE></A>
  326. <P>
  327. <DL>
  328. <DT><B>Parameters:</B><DD><CODE>url</CODE> - the url</DL>
  329. </DL>
  330. <!-- ============ METHOD DETAIL ========== -->
  331. <A NAME="method_detail"><!-- --></A>
  332. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  333. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  334. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  335. <B>Method Detail</B></FONT></TH>
  336. </TR>
  337. </TABLE>
  338. <A NAME="connect(java.lang.String, io.socket.IOCallback)"><!-- --></A><H3>
  339. connect</H3>
  340. <PRE>
  341. public void <B>connect</B>(java.lang.String&nbsp;url,
  342. <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)
  343. throws java.net.MalformedURLException</PRE>
  344. <DL>
  345. <DD>connects to supplied host using callback. Do only use this method if you
  346. 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>.
  347. <P>
  348. <DD><DL>
  349. <DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>callback</CODE> - the callback
  350. <DT><B>Throws:</B>
  351. <DD><CODE>java.net.MalformedURLException</CODE></DL>
  352. </DD>
  353. </DL>
  354. <HR>
  355. <A NAME="connect(java.net.URL, io.socket.IOCallback)"><!-- --></A><H3>
  356. connect</H3>
  357. <PRE>
  358. public void <B>connect</B>(java.net.URL&nbsp;url,
  359. <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)</PRE>
  360. <DL>
  361. <DD>connects to supplied host using callback. Do only use this method if you
  362. 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>.
  363. <P>
  364. <DD><DL>
  365. <DT><B>Parameters:</B><DD><CODE>url</CODE> - the url<DD><CODE>callback</CODE> - the callback</DL>
  366. </DD>
  367. </DL>
  368. <HR>
  369. <A NAME="connect(io.socket.IOCallback)"><!-- --></A><H3>
  370. connect</H3>
  371. <PRE>
  372. public void <B>connect</B>(<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A>&nbsp;callback)</PRE>
  373. <DL>
  374. <DD>connects to an already set host. Do only use this method if you
  375. 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
  376. <A HREF="../../io/socket/SocketIO.html#SocketIO(java.net.URL)"><CODE>SocketIO(URL)</CODE></A>.
  377. <P>
  378. <DD><DL>
  379. <DT><B>Parameters:</B><DD><CODE>callback</CODE> - the callback</DL>
  380. </DD>
  381. </DL>
  382. <HR>
  383. <A NAME="emit(java.lang.String, java.lang.Object...)"><!-- --></A><H3>
  384. emit</H3>
  385. <PRE>
  386. public void <B>emit</B>(java.lang.String&nbsp;event,
  387. java.lang.Object...&nbsp;args)</PRE>
  388. <DL>
  389. <DD>Emits an event to the Socket.IO server. If the connection is not
  390. established, the call will be buffered and sent as soon as it is
  391. possible.
  392. <P>
  393. <DD><DL>
  394. <DT><B>Parameters:</B><DD><CODE>event</CODE> - the event name<DD><CODE>args</CODE> - the arguments</DL>
  395. </DD>
  396. </DL>
  397. <HR>
  398. <A NAME="emit(java.lang.String, io.socket.IOAcknowledge, java.lang.Object...)"><!-- --></A><H3>
  399. emit</H3>
  400. <PRE>
  401. public void <B>emit</B>(java.lang.String&nbsp;event,
  402. <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  403. java.lang.Object...&nbsp;args)</PRE>
  404. <DL>
  405. <DD>Emits an event to the Socket.IO server. If the connection is not
  406. established, the call will be buffered and sent as soon as it is
  407. possible.
  408. <P>
  409. <DD><DL>
  410. <DT><B>Parameters:</B><DD><CODE>event</CODE> - the event name<DD><CODE>ack</CODE> - an acknowledge implementation<DD><CODE>args</CODE> - the arguments</DL>
  411. </DD>
  412. </DL>
  413. <HR>
  414. <A NAME="getCallback()"><!-- --></A><H3>
  415. getCallback</H3>
  416. <PRE>
  417. public <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> <B>getCallback</B>()</PRE>
  418. <DL>
  419. <DD>Gets the callback. Internally used.
  420. <P>
  421. <DD><DL>
  422. <DT><B>Returns:</B><DD>the callback</DL>
  423. </DD>
  424. </DL>
  425. <HR>
  426. <A NAME="getNamespace()"><!-- --></A><H3>
  427. getNamespace</H3>
  428. <PRE>
  429. public java.lang.String <B>getNamespace</B>()</PRE>
  430. <DL>
  431. <DD>Gets the namespace. Internally used.
  432. <P>
  433. <DD><DL>
  434. <DT><B>Returns:</B><DD>the namespace</DL>
  435. </DD>
  436. </DL>
  437. <HR>
  438. <A NAME="send(org.json.JSONObject)"><!-- --></A><H3>
  439. send</H3>
  440. <PRE>
  441. public void <B>send</B>(org.json.JSONObject&nbsp;json)</PRE>
  442. <DL>
  443. <DD>Send JSON data to the Socket.io server.
  444. <P>
  445. <DD><DL>
  446. <DT><B>Parameters:</B><DD><CODE>json</CODE> - the JSON object</DL>
  447. </DD>
  448. </DL>
  449. <HR>
  450. <A NAME="send(io.socket.IOAcknowledge, org.json.JSONObject)"><!-- --></A><H3>
  451. send</H3>
  452. <PRE>
  453. public void <B>send</B>(<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  454. org.json.JSONObject&nbsp;json)</PRE>
  455. <DL>
  456. <DD>Send JSON data to the Socket.io server.
  457. <P>
  458. <DD><DL>
  459. <DT><B>Parameters:</B><DD><CODE>ack</CODE> - an acknowledge implementation<DD><CODE>json</CODE> - the JSON object</DL>
  460. </DD>
  461. </DL>
  462. <HR>
  463. <A NAME="send(java.lang.String)"><!-- --></A><H3>
  464. send</H3>
  465. <PRE>
  466. public void <B>send</B>(java.lang.String&nbsp;message)</PRE>
  467. <DL>
  468. <DD>Send String data to the Socket.io server.
  469. <P>
  470. <DD><DL>
  471. <DT><B>Parameters:</B><DD><CODE>message</CODE> - the message String</DL>
  472. </DD>
  473. </DL>
  474. <HR>
  475. <A NAME="send(io.socket.IOAcknowledge, java.lang.String)"><!-- --></A><H3>
  476. send</H3>
  477. <PRE>
  478. public void <B>send</B>(<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  479. java.lang.String&nbsp;message)</PRE>
  480. <DL>
  481. <DD>Send JSON data to the Socket.io server.
  482. <P>
  483. <DD><DL>
  484. <DT><B>Parameters:</B><DD><CODE>ack</CODE> - an acknowledge implementation<DD><CODE>message</CODE> - the message String</DL>
  485. </DD>
  486. </DL>
  487. <HR>
  488. <A NAME="disconnect()"><!-- --></A><H3>
  489. disconnect</H3>
  490. <PRE>
  491. public void <B>disconnect</B>()</PRE>
  492. <DL>
  493. <DD>Disconnect the socket.
  494. <P>
  495. <DD><DL>
  496. </DL>
  497. </DD>
  498. </DL>
  499. <HR>
  500. <A NAME="reconnect()"><!-- --></A><H3>
  501. reconnect</H3>
  502. <PRE>
  503. public void <B>reconnect</B>()</PRE>
  504. <DL>
  505. <DD>Triggers the transport to reconnect.
  506. This had become useful on some android devices which do not shut down
  507. tcp-connections when switching from HSDPA to Wifi
  508. <P>
  509. <DD><DL>
  510. </DL>
  511. </DD>
  512. </DL>
  513. <HR>
  514. <A NAME="isConnected()"><!-- --></A><H3>
  515. isConnected</H3>
  516. <PRE>
  517. public boolean <B>isConnected</B>()</PRE>
  518. <DL>
  519. <DD>Returns, if a connection is established at the moment
  520. <P>
  521. <DD><DL>
  522. <DT><B>Returns:</B><DD>true if a connection is established, false if the transport is
  523. not connected or currently connecting</DL>
  524. </DD>
  525. </DL>
  526. <!-- ========= END OF CLASS DATA ========= -->
  527. <HR>
  528. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  529. <A NAME="navbar_bottom"><!-- --></A>
  530. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  531. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  532. <TR>
  533. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  534. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  535. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  536. <TR ALIGN="center" VALIGN="top">
  537. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../io/socket/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  538. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  539. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SocketIO.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  540. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  541. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  542. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  543. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  544. </TR>
  545. </TABLE>
  546. </TD>
  547. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  548. </EM>
  549. </TD>
  550. </TR>
  551. <TR>
  552. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  553. &nbsp;<A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><B>PREV CLASS</B></A>&nbsp;
  554. &nbsp;<A HREF="../../io/socket/SocketIOException.html" title="class in io.socket"><B>NEXT CLASS</B></A></FONT></TD>
  555. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  556. <A HREF="../../index.html?io/socket/SocketIO.html" target="_top"><B>FRAMES</B></A> &nbsp;
  557. &nbsp;<A HREF="SocketIO.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  558. &nbsp;<SCRIPT type="text/javascript">
  559. <!--
  560. if(window==top) {
  561. document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  562. }
  563. //-->
  564. </SCRIPT>
  565. <NOSCRIPT>
  566. <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  567. </NOSCRIPT>
  568. </FONT></TD>
  569. </TR>
  570. <TR>
  571. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  572. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  573. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  574. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  575. </TR>
  576. </TABLE>
  577. <A NAME="skip-navbar_bottom"></A>
  578. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  579. <HR>
  580. </BODY>
  581. </HTML>