/doc/io/socket/SocketIO.html
HTML | 651 lines | 559 code | 70 blank | 22 comment | 0 complexity | 00bef5242058e71921cfee8125d093a4 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>
- SocketIO
- </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="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.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> 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#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> 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>
- </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, 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> - the arguments</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> - the arguments</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>
- <!-- ========= 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>