X Tutup
Skip to content

Commit d233be3

Browse files
committed
Updating Documentation, correcting typo
1 parent 429bb04 commit d233be3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1574
-935
lines changed

README.markdown

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ Using socket.io-java-client is quite simple. But lets see:
2727
SocketIO socket = new IOSocket("http://127.0.0.1:3001")
2828
socket.connect(new IOCallback() {
2929
@Override
30-
public void onMessage(JSONObject json) {
30+
public void onMessage(JSONObject json, IOAcknowleged ack) {
3131
System.out.println("We received a message: " + json.toString(2));
3232
}
3333

3434
@Override
35-
public void onMessage(String data) {
35+
public void onMessage(String data, IOAcknowleged ack) {
3636
System.out.println("We received a message:" + data);
3737
}
3838

@@ -54,8 +54,9 @@ Using socket.io-java-client is quite simple. But lets see:
5454
}
5555

5656
@Override
57-
public void on(String event, JSONObject... args) {
57+
public void on(String event, IOAcknowleged ack, JSONObject... args) {
5858
try {
59+
ack.ack("Roger that!");
5960
socket.emit("answer", new JSONObject().put("msg", "Hello again Socket.io!"));
6061
} catch (JSONException e) {
6162
e.printStackTrace();

doc/Example.html

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
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 Mon Jan 02 05:09:59 CET 2012 -->
6+
<TITLE>
7+
Example
8+
</TITLE>
9+
10+
<META NAME="date" CONTENT="2012-01-02">
11+
12+
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
13+
14+
<SCRIPT type="text/javascript">
15+
function windowTitle()
16+
{
17+
if (location.href.indexOf('is-external=true') == -1) {
18+
parent.document.title="Example";
19+
}
20+
}
21+
</SCRIPT>
22+
<NOSCRIPT>
23+
</NOSCRIPT>
24+
25+
</HEAD>
26+
27+
<BODY BGCOLOR="white" onload="windowTitle();">
28+
<HR>
29+
30+
31+
<!-- ========= START OF TOP NAVBAR ======= -->
32+
<A NAME="navbar_top"><!-- --></A>
33+
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34+
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35+
<TR>
36+
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37+
<A NAME="navbar_top_firstrow"><!-- --></A>
38+
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39+
<TR ALIGN="center" VALIGN="top">
40+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42+
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Example.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48+
</TR>
49+
</TABLE>
50+
</TD>
51+
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52+
</EM>
53+
</TD>
54+
</TR>
55+
56+
<TR>
57+
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58+
&nbsp;PREV CLASS&nbsp;
59+
&nbsp;NEXT CLASS</FONT></TD>
60+
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61+
<A HREF="index.html?Example.html" target="_top"><B>FRAMES</B></A> &nbsp;
62+
&nbsp;<A HREF="Example.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
63+
&nbsp;<SCRIPT type="text/javascript">
64+
<!--
65+
if(window==top) {
66+
document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
67+
}
68+
//-->
69+
</SCRIPT>
70+
<NOSCRIPT>
71+
<A HREF="allclasses-noframe.html"><B>All Classes</B></A>
72+
</NOSCRIPT>
73+
74+
75+
</FONT></TD>
76+
</TR>
77+
<TR>
78+
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79+
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80+
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81+
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82+
</TR>
83+
</TABLE>
84+
<A NAME="skip-navbar_top"></A>
85+
<!-- ========= END OF TOP NAVBAR ========= -->
86+
87+
<HR>
88+
<!-- ======== START OF CLASS DATA ======== -->
89+
<H2>
90+
Class Example</H2>
91+
<PRE>
92+
java.lang.Object
93+
<IMG SRC="./resources/inherit.gif" ALT="extended by "><B>Example</B>
94+
</PRE>
95+
<HR>
96+
<DL>
97+
<DT><PRE>public class <B>Example</B><DT>extends java.lang.Object</DL>
98+
</PRE>
99+
100+
<P>
101+
<HR>
102+
103+
<P>
104+
105+
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
106+
107+
<A NAME="constructor_summary"><!-- --></A>
108+
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
109+
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
110+
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
111+
<B>Constructor Summary</B></FONT></TH>
112+
</TR>
113+
<TR BGCOLOR="white" CLASS="TableRowColor">
114+
<TD><CODE><B><A HREF="Example.html#Example()">Example</A></B>()</CODE>
115+
116+
<BR>
117+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
118+
</TR>
119+
</TABLE>
120+
&nbsp;
121+
<!-- ========== METHOD SUMMARY =========== -->
122+
123+
<A NAME="method_summary"><!-- --></A>
124+
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125+
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126+
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127+
<B>Method Summary</B></FONT></TH>
128+
</TR>
129+
<TR BGCOLOR="white" CLASS="TableRowColor">
130+
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131+
<CODE>static&nbsp;void</CODE></FONT></TD>
132+
<TD><CODE><B><A HREF="Example.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
133+
134+
<BR>
135+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
136+
</TR>
137+
</TABLE>
138+
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
139+
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140+
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
141+
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
142+
</TR>
143+
<TR BGCOLOR="white" CLASS="TableRowColor">
144+
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
145+
</TR>
146+
</TABLE>
147+
&nbsp;
148+
<P>
149+
150+
<!-- ========= CONSTRUCTOR DETAIL ======== -->
151+
152+
<A NAME="constructor_detail"><!-- --></A>
153+
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154+
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155+
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
156+
<B>Constructor Detail</B></FONT></TH>
157+
</TR>
158+
</TABLE>
159+
160+
<A NAME="Example()"><!-- --></A><H3>
161+
Example</H3>
162+
<PRE>
163+
public <B>Example</B>()</PRE>
164+
<DL>
165+
</DL>
166+
167+
<!-- ============ METHOD DETAIL ========== -->
168+
169+
<A NAME="method_detail"><!-- --></A>
170+
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
171+
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
172+
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
173+
<B>Method Detail</B></FONT></TH>
174+
</TR>
175+
</TABLE>
176+
177+
<A NAME="main(java.lang.String[])"><!-- --></A><H3>
178+
main</H3>
179+
<PRE>
180+
public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
181+
<DL>
182+
<DD><DL>
183+
<DT><B>Parameters:</B><DD><CODE>args</CODE> - </DL>
184+
</DD>
185+
</DL>
186+
<!-- ========= END OF CLASS DATA ========= -->
187+
<HR>
188+
189+
190+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
191+
<A NAME="navbar_bottom"><!-- --></A>
192+
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
193+
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
194+
<TR>
195+
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
196+
<A NAME="navbar_bottom_firstrow"><!-- --></A>
197+
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
198+
<TR ALIGN="center" VALIGN="top">
199+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
200+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
201+
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
202+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Example.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
203+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
204+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
205+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
206+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
207+
</TR>
208+
</TABLE>
209+
</TD>
210+
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
211+
</EM>
212+
</TD>
213+
</TR>
214+
215+
<TR>
216+
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
217+
&nbsp;PREV CLASS&nbsp;
218+
&nbsp;NEXT CLASS</FONT></TD>
219+
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
220+
<A HREF="index.html?Example.html" target="_top"><B>FRAMES</B></A> &nbsp;
221+
&nbsp;<A HREF="Example.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
222+
&nbsp;<SCRIPT type="text/javascript">
223+
<!--
224+
if(window==top) {
225+
document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
226+
}
227+
//-->
228+
</SCRIPT>
229+
<NOSCRIPT>
230+
<A HREF="allclasses-noframe.html"><B>All Classes</B></A>
231+
</NOSCRIPT>
232+
233+
234+
</FONT></TD>
235+
</TR>
236+
<TR>
237+
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
238+
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
239+
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
240+
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
241+
</TR>
242+
</TABLE>
243+
<A NAME="skip-navbar_bottom"></A>
244+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
245+
246+
<HR>
247+
248+
</BODY>
249+
</HTML>

doc/allclasses-frame.html

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
<!--NewPage-->
33
<HTML>
44
<HEAD>
5-
<!-- Generated by javadoc (build 1.6.0_29) on Thu Dec 29 18:41:58 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Mon Jan 02 05:10:34 CET 2012 -->
66
<TITLE>
77
All Classes
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-29">
10+
<META NAME="date" CONTENT="2012-01-02">
1111

1212
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
1313

@@ -21,21 +21,7 @@
2121

2222
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
2323
<TR>
24-
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="io/socket/IOCallback.html" title="interface in io.socket" target="classFrame"><I>IOCallback</I></A>
25-
<BR>
26-
<A HREF="io/socket/IOConnection.html" title="class in io.socket" target="classFrame">IOConnection</A>
27-
<BR>
28-
<A HREF="io/socket/IOMessage.html" title="class in io.socket" target="classFrame">IOMessage</A>
29-
<BR>
30-
<A HREF="io/socket/IOTransport.html" title="interface in io.socket" target="classFrame"><I>IOTransport</I></A>
31-
<BR>
32-
<A HREF="io/socket/SocketIO.html" title="class in io.socket" target="classFrame">SocketIO</A>
33-
<BR>
34-
<A HREF="io/socket/SocketIOException.html" title="class in io.socket" target="classFrame">SocketIOException</A>
35-
<BR>
36-
<A HREF="Test.html" title="class in &lt;Unnamed&gt;" target="classFrame">Test</A>
37-
<BR>
38-
<A HREF="io/socket/transports/WebsocketTransport.html" title="class in io.socket.transports" target="classFrame">WebsocketTransport</A>
24+
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="io/socket/SocketIO.html" title="class in io.socket" target="classFrame">SocketIO</A>
3925
<BR>
4026
</FONT></TD>
4127
</TR>

doc/allclasses-noframe.html

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
<!--NewPage-->
33
<HTML>
44
<HEAD>
5-
<!-- Generated by javadoc (build 1.6.0_29) on Thu Dec 29 18:41:58 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Mon Jan 02 05:10:34 CET 2012 -->
66
<TITLE>
77
All Classes
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-29">
10+
<META NAME="date" CONTENT="2012-01-02">
1111

1212
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
1313

@@ -21,21 +21,7 @@
2121

2222
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
2323
<TR>
24-
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="io/socket/IOCallback.html" title="interface in io.socket"><I>IOCallback</I></A>
25-
<BR>
26-
<A HREF="io/socket/IOConnection.html" title="class in io.socket">IOConnection</A>
27-
<BR>
28-
<A HREF="io/socket/IOMessage.html" title="class in io.socket">IOMessage</A>
29-
<BR>
30-
<A HREF="io/socket/IOTransport.html" title="interface in io.socket"><I>IOTransport</I></A>
31-
<BR>
32-
<A HREF="io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>
33-
<BR>
34-
<A HREF="io/socket/SocketIOException.html" title="class in io.socket">SocketIOException</A>
35-
<BR>
36-
<A HREF="Test.html" title="class in &lt;Unnamed&gt;">Test</A>
37-
<BR>
38-
<A HREF="io/socket/transports/WebsocketTransport.html" title="class in io.socket.transports">WebsocketTransport</A>
24+
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>
3925
<BR>
4026
</FONT></TD>
4127
</TR>

0 commit comments

Comments
 (0)
X Tutup