/doc/io/socket/IOConnection.html
HTML | 660 lines | 567 code | 71 blank | 22 comment | 0 complexity | c5d56327998e919ba255f2828598eaf5 MD5 | raw file
- <!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 Thu Feb 16 08:46:29 CET 2012 -->
- <TITLE>
- IOConnection
- </TITLE>
- <META NAME="date" CONTENT="2012-02-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="IOConnection";
- }
- }
- </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/IOConnection.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/IOCallback.html" title="interface in io.socket"><B>PREV CLASS</B></A>
- <A HREF="../../io/socket/IOMessage.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/IOConnection.html" target="_top"><B>FRAMES</B></A>
- <A HREF="IOConnection.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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 IOConnection</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>io.socket.IOConnection</B>
- </PRE>
- <HR>
- <DL>
- <DT><PRE> class <B>IOConnection</B><DT>extends java.lang.Object</DL>
- </PRE>
- <P>
- The Class IOConnection.
- <P>
- <P>
- <HR>
- <P>
- <!-- =========== FIELD SUMMARY =========== -->
- <A NAME="field_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>Field Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>(package private) java.util.HashMap<java.lang.Integer,<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#acknowledge">acknowledge</A></B></CODE>
- <BR>
- Acknowledges.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#DUMMY_CALLBACK">DUMMY_CALLBACK</A></B></CODE>
- <BR>
- A dummy callback used when IOConnection receives a unexpected message.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>(package private) java.util.TimerTask</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#heartBeatTask">heartBeatTask</A></B></CODE>
- <BR>
- The heart beat task.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static java.lang.String</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#SOCKET_IO_1">SOCKET_IO_1</A></B></CODE>
- <BR>
- Socket.io path.</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> void</CODE></FONT></TD>
- <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> socket,
- 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 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>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>protected void</CODE></FONT></TD>
- <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> e)</CODE>
- <BR>
- 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>
- </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/IOConnection.html#getSessionId()">getSessionId</A></B>()</CODE>
- <BR>
- Returns the session id.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE> int</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#getState()">getState</A></B>()</CODE>
- <BR>
- </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/IOConnection.html#isConnected()">isConnected</A></B>()</CODE>
- <BR>
- Checks if IOConnection is currently connected.</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/IOConnection.html#reconnect()">reconnect</A></B>()</CODE>
- <BR>
- forces a 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/IOConnection.html#register(io.socket.SocketIO)">register</A></B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket)</CODE>
- <BR>
- Connects a socket to the IOConnection.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static <A HREF="../../io/socket/IOConnection.html" title="class in io.socket">IOConnection</A></CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../io/socket/IOConnection.html#register(java.lang.String, io.socket.SocketIO)">register</A></B>(java.lang.String origin,
- <A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket)</CODE>
- <BR>
- Creates a new connection or returns the corresponding one.</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/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> socket,
- <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
- org.json.JSONObject json)</CODE>
- <BR>
- 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>
- </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/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> socket,
- <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
- java.lang.String text)</CODE>
- <BR>
- 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>
- </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/IOConnection.html#setState(int)">setState</A></B>(int state)</CODE>
- <BR>
- </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/IOConnection.html#transportConnected()">transportConnected</A></B>()</CODE>
- <BR>
- Transport connected.</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/IOConnection.html#transportDisconnected()">transportDisconnected</A></B>()</CODE>
- <BR>
- Transport disconnected.</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/IOConnection.html#transportError(java.lang.Exception)">transportError</A></B>(java.lang.Exception error)</CODE>
- <BR>
- Transport error.</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/IOConnection.html#transportMessage(java.lang.String)">transportMessage</A></B>(java.lang.String text)</CODE>
- <BR>
- Transport message.</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/IOConnection.html#unregister(io.socket.SocketIO)">unregister</A></B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket)</CODE>
- <BR>
- Disconnect a socket from the IOConnection.</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>
- <!-- ============ FIELD DETAIL =========== -->
- <A NAME="field_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>Field Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="SOCKET_IO_1"><!-- --></A><H3>
- SOCKET_IO_1</H3>
- <PRE>
- public static final java.lang.String <B>SOCKET_IO_1</B></PRE>
- <DL>
- <DD>Socket.io path.
- <P>
- <DL>
- <DT><B>See Also:</B><DD><A HREF="../../constant-values.html#io.socket.IOConnection.SOCKET_IO_1">Constant Field Values</A></DL>
- </DL>
- <HR>
- <A NAME="acknowledge"><!-- --></A><H3>
- acknowledge</H3>
- <PRE>
- java.util.HashMap<java.lang.Integer,<A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A>> <B>acknowledge</B></PRE>
- <DL>
- <DD>Acknowledges.
- <P>
- <DL>
- </DL>
- </DL>
- <HR>
- <A NAME="heartBeatTask"><!-- --></A><H3>
- heartBeatTask</H3>
- <PRE>
- final java.util.TimerTask <B>heartBeatTask</B></PRE>
- <DL>
- <DD>The heart beat task.
- <P>
- <DL>
- </DL>
- </DL>
- <HR>
- <A NAME="DUMMY_CALLBACK"><!-- --></A><H3>
- DUMMY_CALLBACK</H3>
- <PRE>
- public static final <A HREF="../../io/socket/IOCallback.html" title="interface in io.socket">IOCallback</A> <B>DUMMY_CALLBACK</B></PRE>
- <DL>
- <DD>A dummy callback used when IOConnection receives a unexpected message.
- <P>
- <DL>
- </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="register(java.lang.String, io.socket.SocketIO)"><!-- --></A><H3>
- register</H3>
- <PRE>
- public static <A HREF="../../io/socket/IOConnection.html" title="class in io.socket">IOConnection</A> <B>register</B>(java.lang.String origin,
- <A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket)</PRE>
- <DL>
- <DD>Creates a new connection or returns the corresponding one.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>origin</CODE> - the origin<DD><CODE>socket</CODE> - the socket
- <DT><B>Returns:</B><DD>a IOConnection object</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="error(io.socket.SocketIOException)"><!-- --></A><H3>
- error</H3>
- <PRE>
- protected void <B>error</B>(<A HREF="../../io/socket/SocketIOException.html" title="class in io.socket">SocketIOException</A> e)</PRE>
- <DL>
- <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.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>e</CODE> - an exception</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="register(io.socket.SocketIO)"><!-- --></A><H3>
- register</H3>
- <PRE>
- public void <B>register</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket)</PRE>
- <DL>
- <DD>Connects a socket to the IOConnection.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>socket</CODE> - the socket to be connected</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="unregister(io.socket.SocketIO)"><!-- --></A><H3>
- unregister</H3>
- <PRE>
- public void <B>unregister</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket)</PRE>
- <DL>
- <DD>Disconnect a socket from the IOConnection. Shuts down this IOConnection
- if no further connections are available for this IOConnection.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>socket</CODE> - the socket to be shut down</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="transportConnected()"><!-- --></A><H3>
- transportConnected</H3>
- <PRE>
- public void <B>transportConnected</B>()</PRE>
- <DL>
- <DD>Transport connected.
-
- <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A> calls this when a connection is established.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="transportDisconnected()"><!-- --></A><H3>
- transportDisconnected</H3>
- <PRE>
- public void <B>transportDisconnected</B>()</PRE>
- <DL>
- <DD>Transport disconnected.
-
- <A HREF="../../io/socket/IOTransport.html" title="interface in io.socket"><CODE>IOTransport</CODE></A> calls this when a connection has been shut down.
- <P>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="transportError(java.lang.Exception)"><!-- --></A><H3>
- transportError</H3>
- <PRE>
- public void <B>transportError</B>(java.lang.Exception error)</PRE>
- <DL>
- <DD>Transport error.
- <P>
- <DD><DL>
- <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
- has occured and the transport is not usable anymore.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="transportMessage(java.lang.String)"><!-- --></A><H3>
- transportMessage</H3>
- <PRE>
- public void <B>transportMessage</B>(java.lang.String text)</PRE>
- <DL>
- <DD>Transport message.
- <P>
- <DD><DL>
- <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
- been received.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="reconnect()"><!-- --></A><H3>
- reconnect</H3>
- <PRE>
- public void <B>reconnect</B>()</PRE>
- <DL>
- <DD>forces a 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="getSessionId()"><!-- --></A><H3>
- getSessionId</H3>
- <PRE>
- public java.lang.String <B>getSessionId</B>()</PRE>
- <DL>
- <DD>Returns the session id. This should be called from the
- <P>
- <DD><DL>
- <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
- Session.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="send(io.socket.SocketIO, io.socket.IOAcknowledge, java.lang.String)"><!-- --></A><H3>
- send</H3>
- <PRE>
- public void <B>send</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket,
- <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
- java.lang.String text)</PRE>
- <DL>
- <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>.
- <P>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="send(io.socket.SocketIO, io.socket.IOAcknowledge, org.json.JSONObject)"><!-- --></A><H3>
- send</H3>
- <PRE>
- public void <B>send</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket,
- <A HREF="../../io/socket/IOAcknowledge.html" title="interface in io.socket">IOAcknowledge</A> ack,
- org.json.JSONObject json)</PRE>
- <DL>
- <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>.
- <P>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="emit(io.socket.SocketIO, java.lang.String, io.socket.IOAcknowledge, java.lang.Object...)"><!-- --></A><H3>
- emit</H3>
- <PRE>
- public void <B>emit</B>(<A HREF="../../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A> socket,
- 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 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>.
- <P>
- <DD><DL>
- <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>
- </DD>
- </DL>
- <HR>
- <A NAME="isConnected()"><!-- --></A><H3>
- isConnected</H3>
- <PRE>
- public boolean <B>isConnected</B>()</PRE>
- <DL>
- <DD>Checks if IOConnection is currently connected.
- <P>
- <DD><DL>
- <DT><B>Returns:</B><DD>true, if is connected</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="getState()"><!-- --></A><H3>
- getState</H3>
- <PRE>
- public int <B>getState</B>()</PRE>
- <DL>
- <DD><DL>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="setState(int)"><!-- --></A><H3>
- setState</H3>
- <PRE>
- public void <B>setState</B>(int state)</PRE>
- <DL>
- <DD><DL>
- </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/IOConnection.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/IOCallback.html" title="interface in io.socket"><B>PREV CLASS</B></A>
- <A HREF="../../io/socket/IOMessage.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/IOConnection.html" target="_top"><B>FRAMES</B></A>
- <A HREF="IOConnection.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 | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- </BODY>
- </HTML>