PageRenderTime 42ms CodeModel.GetById 13ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/io/socket/IOConnection.html

https://github.com/clwillingham/socket.io-java-client
HTML | 660 lines | 567 code | 71 blank | 22 comment | 0 complexity | c5d56327998e919ba255f2828598eaf5 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. IOConnection
  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="IOConnection";
  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/IOConnection.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/IOCallback.html" title="interface in io.socket"><B>PREV CLASS</B></A>&nbsp;
  50. &nbsp;<A HREF="../../io/socket/IOMessage.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/IOConnection.html" target="_top"><B>FRAMES</B></A> &nbsp;
  53. &nbsp;<A HREF="IOConnection.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;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  69. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  70. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&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 IOConnection</H2>
  82. <PRE>
  83. java.lang.Object
  84. <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>io.socket.IOConnection</B>
  85. </PRE>
  86. <HR>
  87. <DL>
  88. <DT><PRE> class <B>IOConnection</B><DT>extends java.lang.Object</DL>
  89. </PRE>
  90. <P>
  91. The Class IOConnection.
  92. <P>
  93. <P>
  94. <HR>
  95. <P>
  96. <!-- =========== FIELD SUMMARY =========== -->
  97. <A NAME="field_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>Field Summary</B></FONT></TH>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  105. <CODE>(package private) &nbsp;java.util.HashMap&lt;java.lang.Integer,<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&gt;</CODE></FONT></TD>
  106. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#acknowledge">acknowledge</A></B></CODE>
  107. <BR>
  108. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Acknowledges.</TD>
  109. </TR>
  110. <TR BGCOLOR="white" CLASS="TableRowColor">
  111. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  112. <CODE>static&nbsp;<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A></CODE></FONT></TD>
  113. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#DUMMY_CALLBACK">DUMMY_CALLBACK</A></B></CODE>
  114. <BR>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A dummy callback used when IOConnection receives a unexpected message.</TD>
  116. </TR>
  117. <TR BGCOLOR="white" CLASS="TableRowColor">
  118. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  119. <CODE>(package private) &nbsp;java.util.TimerTask</CODE></FONT></TD>
  120. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#heartBeatTask">heartBeatTask</A></B></CODE>
  121. <BR>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The heart beat task.</TD>
  123. </TR>
  124. <TR BGCOLOR="white" CLASS="TableRowColor">
  125. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  126. <CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
  127. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#SOCKET_IO_1">SOCKET_IO_1</A></B></CODE>
  128. <BR>
  129. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Socket.io path.</TD>
  130. </TR>
  131. </TABLE>
  132. &nbsp;
  133. <!-- ========== METHOD SUMMARY =========== -->
  134. <A NAME="method_summary"><!-- --></A>
  135. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  136. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  137. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  138. <B>Method Summary</B></FONT></TH>
  139. </TR>
  140. <TR BGCOLOR="white" CLASS="TableRowColor">
  141. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  142. <CODE>&nbsp;void</CODE></FONT></TD>
  143. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#emit(io.socket.SocketIO, java.lang.String, io.socket.IOAcknowledge, java.lang.Object...)">emit</A></B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket,
  144. java.lang.String&nbsp;event,
  145. <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  146. java.lang.Object...&nbsp;args)</CODE>
  147. <BR>
  148. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;emits an event from <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> to the <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A>.</TD>
  149. </TR>
  150. <TR BGCOLOR="white" CLASS="TableRowColor">
  151. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  152. <CODE>protected &nbsp;void</CODE></FONT></TD>
  153. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#error(io.socket.SocketIOException)">error</A></B>(<A HREF="../../io/socket/SocketIOException.html" title="class in io.socket">SocketIOException</A>&nbsp;e)</CODE>
  154. <BR>
  155. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Populates an error to the connected <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket"><CODE>IOCallback</CODE></A>s and shuts down.</TD>
  156. </TR>
  157. <TR BGCOLOR="white" CLASS="TableRowColor">
  158. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  159. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  160. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#getSessionId()">getSessionId</A></B>()</CODE>
  161. <BR>
  162. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the session id.</TD>
  163. </TR>
  164. <TR BGCOLOR="white" CLASS="TableRowColor">
  165. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  166. <CODE>&nbsp;int</CODE></FONT></TD>
  167. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#getState()">getState</A></B>()</CODE>
  168. <BR>
  169. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  170. </TR>
  171. <TR BGCOLOR="white" CLASS="TableRowColor">
  172. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  173. <CODE>&nbsp;boolean</CODE></FONT></TD>
  174. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#isConnected()">isConnected</A></B>()</CODE>
  175. <BR>
  176. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if IOConnection is currently connected.</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/IOConnection.html#reconnect()">reconnect</A></B>()</CODE>
  182. <BR>
  183. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;forces a reconnect.</TD>
  184. </TR>
  185. <TR BGCOLOR="white" CLASS="TableRowColor">
  186. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  187. <CODE>&nbsp;void</CODE></FONT></TD>
  188. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#register(io.socket.SocketIO)">register</A></B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket)</CODE>
  189. <BR>
  190. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Connects a socket to the IOConnection.</TD>
  191. </TR>
  192. <TR BGCOLOR="white" CLASS="TableRowColor">
  193. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  194. <CODE>static&nbsp;<A HREF="../../io/socket/IOConnection.html" title="class in io.socket">IOConnection</A></CODE></FONT></TD>
  195. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#register(java.lang.String, io.socket.SocketIO)">register</A></B>(java.lang.String&nbsp;origin,
  196. <A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket)</CODE>
  197. <BR>
  198. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new connection or returns the corresponding one.</TD>
  199. </TR>
  200. <TR BGCOLOR="white" CLASS="TableRowColor">
  201. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  202. <CODE>&nbsp;void</CODE></FONT></TD>
  203. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#send(io.socket.SocketIO, io.socket.IOAcknowledge, org.json.JSONObject)">send</A></B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket,
  204. <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  205. org.json.JSONObject&nbsp;json)</CODE>
  206. <BR>
  207. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sends a JSON message from <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> to the <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A>.</TD>
  208. </TR>
  209. <TR BGCOLOR="white" CLASS="TableRowColor">
  210. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  211. <CODE>&nbsp;void</CODE></FONT></TD>
  212. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#send(io.socket.SocketIO, io.socket.IOAcknowledge, java.lang.String)">send</A></B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket,
  213. <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  214. java.lang.String&nbsp;text)</CODE>
  215. <BR>
  216. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sends a String message from <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> to the <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A>.</TD>
  217. </TR>
  218. <TR BGCOLOR="white" CLASS="TableRowColor">
  219. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  220. <CODE>&nbsp;void</CODE></FONT></TD>
  221. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#setState(int)">setState</A></B>(int&nbsp;state)</CODE>
  222. <BR>
  223. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  224. </TR>
  225. <TR BGCOLOR="white" CLASS="TableRowColor">
  226. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  227. <CODE>&nbsp;void</CODE></FONT></TD>
  228. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#transportConnected()">transportConnected</A></B>()</CODE>
  229. <BR>
  230. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Transport connected.</TD>
  231. </TR>
  232. <TR BGCOLOR="white" CLASS="TableRowColor">
  233. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  234. <CODE>&nbsp;void</CODE></FONT></TD>
  235. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#transportDisconnected()">transportDisconnected</A></B>()</CODE>
  236. <BR>
  237. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Transport disconnected.</TD>
  238. </TR>
  239. <TR BGCOLOR="white" CLASS="TableRowColor">
  240. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  241. <CODE>&nbsp;void</CODE></FONT></TD>
  242. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#transportError(java.lang.Exception)">transportError</A></B>(java.lang.Exception&nbsp;error)</CODE>
  243. <BR>
  244. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Transport error.</TD>
  245. </TR>
  246. <TR BGCOLOR="white" CLASS="TableRowColor">
  247. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  248. <CODE>&nbsp;void</CODE></FONT></TD>
  249. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#transportMessage(java.lang.String)">transportMessage</A></B>(java.lang.String&nbsp;text)</CODE>
  250. <BR>
  251. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Transport message.</TD>
  252. </TR>
  253. <TR BGCOLOR="white" CLASS="TableRowColor">
  254. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  255. <CODE>&nbsp;void</CODE></FONT></TD>
  256. <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#unregister(io.socket.SocketIO)">unregister</A></B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket)</CODE>
  257. <BR>
  258. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Disconnect a socket from the IOConnection.</TD>
  259. </TR>
  260. </TABLE>
  261. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  262. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  263. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  264. <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
  265. </TR>
  266. <TR BGCOLOR="white" CLASS="TableRowColor">
  267. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
  268. </TR>
  269. </TABLE>
  270. &nbsp;
  271. <P>
  272. <!-- ============ FIELD DETAIL =========== -->
  273. <A NAME="field_detail"><!-- --></A>
  274. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  275. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  276. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  277. <B>Field Detail</B></FONT></TH>
  278. </TR>
  279. </TABLE>
  280. <A NAME="SOCKET_IO_1"><!-- --></A><H3>
  281. SOCKET_IO_1</H3>
  282. <PRE>
  283. public static final java.lang.String <B>SOCKET_IO_1</B></PRE>
  284. <DL>
  285. <DD>Socket.io path.
  286. <P>
  287. <DL>
  288. <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#io.socket.IOConnection.SOCKET_IO_1">Constant Field Values</A></DL>
  289. </DL>
  290. <HR>
  291. <A NAME="acknowledge"><!-- --></A><H3>
  292. acknowledge</H3>
  293. <PRE>
  294. java.util.HashMap&lt;java.lang.Integer,<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&gt; <B>acknowledge</B></PRE>
  295. <DL>
  296. <DD>Acknowledges.
  297. <P>
  298. <DL>
  299. </DL>
  300. </DL>
  301. <HR>
  302. <A NAME="heartBeatTask"><!-- --></A><H3>
  303. heartBeatTask</H3>
  304. <PRE>
  305. final java.util.TimerTask <B>heartBeatTask</B></PRE>
  306. <DL>
  307. <DD>The heart beat task.
  308. <P>
  309. <DL>
  310. </DL>
  311. </DL>
  312. <HR>
  313. <A NAME="DUMMY_CALLBACK"><!-- --></A><H3>
  314. DUMMY_CALLBACK</H3>
  315. <PRE>
  316. public static final <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> <B>DUMMY_CALLBACK</B></PRE>
  317. <DL>
  318. <DD>A dummy callback used when IOConnection receives a unexpected message.
  319. <P>
  320. <DL>
  321. </DL>
  322. </DL>
  323. <!-- ============ METHOD DETAIL ========== -->
  324. <A NAME="method_detail"><!-- --></A>
  325. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  326. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  327. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  328. <B>Method Detail</B></FONT></TH>
  329. </TR>
  330. </TABLE>
  331. <A NAME="register(java.lang.String, io.socket.SocketIO)"><!-- --></A><H3>
  332. register</H3>
  333. <PRE>
  334. public static <A HREF="../../io/socket/IOConnection.html" title="class in io.socket">IOConnection</A> <B>register</B>(java.lang.String&nbsp;origin,
  335. <A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket)</PRE>
  336. <DL>
  337. <DD>Creates a new connection or returns the corresponding one.
  338. <P>
  339. <DD><DL>
  340. <DT><B>Parameters:</B><DD><CODE>origin</CODE> - the origin<DD><CODE>socket</CODE> - the socket
  341. <DT><B>Returns:</B><DD>a IOConnection object</DL>
  342. </DD>
  343. </DL>
  344. <HR>
  345. <A NAME="error(io.socket.SocketIOException)"><!-- --></A><H3>
  346. error</H3>
  347. <PRE>
  348. protected void <B>error</B>(<A HREF="../../io/socket/SocketIOException.html" title="class in io.socket">SocketIOException</A>&nbsp;e)</PRE>
  349. <DL>
  350. <DD>Populates an error to the connected <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket"><CODE>IOCallback</CODE></A>s and shuts down.
  351. <P>
  352. <DD><DL>
  353. <DT><B>Parameters:</B><DD><CODE>e</CODE> - an exception</DL>
  354. </DD>
  355. </DL>
  356. <HR>
  357. <A NAME="register(io.socket.SocketIO)"><!-- --></A><H3>
  358. register</H3>
  359. <PRE>
  360. public void <B>register</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket)</PRE>
  361. <DL>
  362. <DD>Connects a socket to the IOConnection.
  363. <P>
  364. <DD><DL>
  365. <DT><B>Parameters:</B><DD><CODE>socket</CODE> - the socket to be connected</DL>
  366. </DD>
  367. </DL>
  368. <HR>
  369. <A NAME="unregister(io.socket.SocketIO)"><!-- --></A><H3>
  370. unregister</H3>
  371. <PRE>
  372. public void <B>unregister</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket)</PRE>
  373. <DL>
  374. <DD>Disconnect a socket from the IOConnection. Shuts down this IOConnection
  375. if no further connections are available for this IOConnection.
  376. <P>
  377. <DD><DL>
  378. <DT><B>Parameters:</B><DD><CODE>socket</CODE> - the socket to be shut down</DL>
  379. </DD>
  380. </DL>
  381. <HR>
  382. <A NAME="transportConnected()"><!-- --></A><H3>
  383. transportConnected</H3>
  384. <PRE>
  385. public void <B>transportConnected</B>()</PRE>
  386. <DL>
  387. <DD>Transport connected.
  388. <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A> calls this when a connection is established.
  389. <P>
  390. <DD><DL>
  391. </DL>
  392. </DD>
  393. </DL>
  394. <HR>
  395. <A NAME="transportDisconnected()"><!-- --></A><H3>
  396. transportDisconnected</H3>
  397. <PRE>
  398. public void <B>transportDisconnected</B>()</PRE>
  399. <DL>
  400. <DD>Transport disconnected.
  401. <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A> calls this when a connection has been shut down.
  402. <P>
  403. <DD><DL>
  404. </DL>
  405. </DD>
  406. </DL>
  407. <HR>
  408. <A NAME="transportError(java.lang.Exception)"><!-- --></A><H3>
  409. transportError</H3>
  410. <PRE>
  411. public void <B>transportError</B>(java.lang.Exception&nbsp;error)</PRE>
  412. <DL>
  413. <DD>Transport error.
  414. <P>
  415. <DD><DL>
  416. <DT><B>Parameters:</B><DD><CODE>error</CODE> - the error <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A> calls this, when an exception
  417. has occured and the transport is not usable anymore.</DL>
  418. </DD>
  419. </DL>
  420. <HR>
  421. <A NAME="transportMessage(java.lang.String)"><!-- --></A><H3>
  422. transportMessage</H3>
  423. <PRE>
  424. public void <B>transportMessage</B>(java.lang.String&nbsp;text)</PRE>
  425. <DL>
  426. <DD>Transport message.
  427. <P>
  428. <DD><DL>
  429. <DT><B>Parameters:</B><DD><CODE>text</CODE> - the text <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A> calls this, when a message has
  430. been received.</DL>
  431. </DD>
  432. </DL>
  433. <HR>
  434. <A NAME="reconnect()"><!-- --></A><H3>
  435. reconnect</H3>
  436. <PRE>
  437. public void <B>reconnect</B>()</PRE>
  438. <DL>
  439. <DD>forces a reconnect. This had become useful on some android devices which
  440. do not shut down TCP-connections when switching from HSDPA to Wifi
  441. <P>
  442. <DD><DL>
  443. </DL>
  444. </DD>
  445. </DL>
  446. <HR>
  447. <A NAME="getSessionId()"><!-- --></A><H3>
  448. getSessionId</H3>
  449. <PRE>
  450. public java.lang.String <B>getSessionId</B>()</PRE>
  451. <DL>
  452. <DD>Returns the session id. This should be called from the
  453. <P>
  454. <DD><DL>
  455. <DT><B>Returns:</B><DD>the session id <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A> to connect to the right
  456. Session.</DL>
  457. </DD>
  458. </DL>
  459. <HR>
  460. <A NAME="send(io.socket.SocketIO, io.socket.IOAcknowledge, java.lang.String)"><!-- --></A><H3>
  461. send</H3>
  462. <PRE>
  463. public void <B>send</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket,
  464. <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  465. java.lang.String&nbsp;text)</PRE>
  466. <DL>
  467. <DD>sends a String message from <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> to the <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A>.
  468. <P>
  469. <DD><DL>
  470. <DT><B>Parameters:</B><DD><CODE>socket</CODE> - the socket<DD><CODE>ack</CODE> - acknowledge package which can be called from the server<DD><CODE>text</CODE> - the text</DL>
  471. </DD>
  472. </DL>
  473. <HR>
  474. <A NAME="send(io.socket.SocketIO, io.socket.IOAcknowledge, org.json.JSONObject)"><!-- --></A><H3>
  475. send</H3>
  476. <PRE>
  477. public void <B>send</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket,
  478. <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  479. org.json.JSONObject&nbsp;json)</PRE>
  480. <DL>
  481. <DD>sends a JSON message from <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> to the <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A>.
  482. <P>
  483. <DD><DL>
  484. <DT><B>Parameters:</B><DD><CODE>socket</CODE> - the socket<DD><CODE>ack</CODE> - acknowledge package which can be called from the server<DD><CODE>json</CODE> - the json</DL>
  485. </DD>
  486. </DL>
  487. <HR>
  488. <A NAME="emit(io.socket.SocketIO, java.lang.String, io.socket.IOAcknowledge, java.lang.Object...)"><!-- --></A><H3>
  489. emit</H3>
  490. <PRE>
  491. public void <B>emit</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>&nbsp;socket,
  492. java.lang.String&nbsp;event,
  493. <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>&nbsp;ack,
  494. java.lang.Object...&nbsp;args)</PRE>
  495. <DL>
  496. <DD>emits an event from <A HREF="../../io/socket/SocketIO.html" title="class in io.socket"><CODE>SocketIO</CODE></A> to the <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A>.
  497. <P>
  498. <DD><DL>
  499. <DT><B>Parameters:</B><DD><CODE>socket</CODE> - the socket<DD><CODE>event</CODE> - the event<DD><CODE>ack</CODE> - acknowledge package which can be called from the server<DD><CODE>args</CODE> - the arguments to be send</DL>
  500. </DD>
  501. </DL>
  502. <HR>
  503. <A NAME="isConnected()"><!-- --></A><H3>
  504. isConnected</H3>
  505. <PRE>
  506. public boolean <B>isConnected</B>()</PRE>
  507. <DL>
  508. <DD>Checks if IOConnection is currently connected.
  509. <P>
  510. <DD><DL>
  511. <DT><B>Returns:</B><DD>true, if is connected</DL>
  512. </DD>
  513. </DL>
  514. <HR>
  515. <A NAME="getState()"><!-- --></A><H3>
  516. getState</H3>
  517. <PRE>
  518. public int <B>getState</B>()</PRE>
  519. <DL>
  520. <DD><DL>
  521. </DL>
  522. </DD>
  523. </DL>
  524. <HR>
  525. <A NAME="setState(int)"><!-- --></A><H3>
  526. setState</H3>
  527. <PRE>
  528. public void <B>setState</B>(int&nbsp;state)</PRE>
  529. <DL>
  530. <DD><DL>
  531. </DL>
  532. </DD>
  533. </DL>
  534. <!-- ========= END OF CLASS DATA ========= -->
  535. <HR>
  536. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  537. <A NAME="navbar_bottom"><!-- --></A>
  538. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  539. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  540. <TR>
  541. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  542. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  543. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  544. <TR ALIGN="center" VALIGN="top">
  545. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../io/socket/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  546. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  547. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IOConnection.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  548. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  549. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  550. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  551. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  552. </TR>
  553. </TABLE>
  554. </TD>
  555. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  556. </EM>
  557. </TD>
  558. </TR>
  559. <TR>
  560. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  561. &nbsp;<A HREF="../../io/socket/IOCallback.html" title="interface in io.socket"><B>PREV CLASS</B></A>&nbsp;
  562. &nbsp;<A HREF="../../io/socket/IOMessage.html" title="class in io.socket"><B>NEXT CLASS</B></A></FONT></TD>
  563. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  564. <A HREF="../../index.html?io/socket/IOConnection.html" target="_top"><B>FRAMES</B></A> &nbsp;
  565. &nbsp;<A HREF="IOConnection.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  566. &nbsp;<SCRIPT type="text/javascript">
  567. <!--
  568. if(window==top) {
  569. document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
  570. }
  571. //-->
  572. </SCRIPT>
  573. <NOSCRIPT>
  574. <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
  575. </NOSCRIPT>
  576. </FONT></TD>
  577. </TR>
  578. <TR>
  579. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  580. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  581. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  582. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  583. </TR>
  584. </TABLE>
  585. <A NAME="skip-navbar_bottom"></A>
  586. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  587. <HR>
  588. </BODY>
  589. </HTML>