X Tutup
Skip to content

Commit 511786b

Browse files
GottoxGottox
committed
Updating documentation, adding argument error handling to the new connect() API
1 parent 868558f commit 511786b

Some content is hidden

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

54 files changed

+817
-455
lines changed

‎README.markdown‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Features:
1616
when the transport is interrupted.
1717
* __easy to use API__ - implement an interface, instantiate a class - you're done.
1818
* __output buffer__ - send data while the transport is still connecting. No problem, socket.io-java-client handles that.
19+
* __meaningful exceptions__ - if something goes wrong, SocketIO tries to throw meaningful exceptions with hints for fixing.
1920

2021
## How to use
2122

@@ -24,7 +25,7 @@ Using socket.io-java-client is quite simple. But lets see:
2425
``` java
2526
// Initialise a socket:
2627
SocketIO socket = new IOSocket("http://127.0.0.1:3001")
27-
socket.go(new IOCallback() {
28+
socket.connect(new IOCallback() {
2829
@Override
2930
public void onMessage(JSONObject json) {
3031
System.out.println("We received a message: " + json.toString(2));

‎doc/Test.html‎

Lines changed: 2 additions & 2 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 Fri Dec 23 00:33:40 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:57 CET 2011 -->
66
<TITLE>
77
Test
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

‎doc/allclasses-frame.html‎

Lines changed: 2 additions & 2 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 Fri Dec 23 00:33:42 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:59 CET 2011 -->
66
<TITLE>
77
All Classes
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

‎doc/allclasses-noframe.html‎

Lines changed: 2 additions & 2 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 Fri Dec 23 00:33:42 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:59 CET 2011 -->
66
<TITLE>
77
All Classes
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

‎doc/class-use/Test.html‎

Lines changed: 2 additions & 2 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 Fri Dec 23 00:33:41 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:59 CET 2011 -->
66
<TITLE>
77
Uses of Class Test
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

‎doc/constant-values.html‎

Lines changed: 20 additions & 2 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 Fri Dec 23 00:33:41 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:59 CET 2011 -->
66
<TITLE>
77
Constant Field Values
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

@@ -210,6 +210,24 @@ <H1>
210210

211211
<P>
212212

213+
<P>
214+
215+
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
216+
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
217+
<TH ALIGN="left" COLSPAN="3">io.socket.transports.<A HREF="io/socket/transports/WebsocketTransport.html" title="class in io.socket.transports">WebsocketTransport</A></TH>
218+
</TR>
219+
<TR BGCOLOR="white" CLASS="TableRowColor">
220+
<A NAME="io.socket.transports.WebsocketTransport.TRANSPORT_NAME"><!-- --></A><TD ALIGN="right"><FONT SIZE="-1">
221+
<CODE>public&nbsp;static&nbsp;final&nbsp;java.lang.String</CODE></FONT></TD>
222+
<TD ALIGN="left"><CODE><A HREF="io/socket/transports/WebsocketTransport.html#TRANSPORT_NAME">TRANSPORT_NAME</A></CODE></TD>
223+
<TD ALIGN="right"><CODE>"websocket"</CODE></TD>
224+
</TR>
225+
</FONT></TD>
226+
</TR>
227+
</TABLE>
228+
229+
<P>
230+
213231
<P>
214232
<HR>
215233

‎doc/deprecated-list.html‎

Lines changed: 2 additions & 2 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 Fri Dec 23 00:33:42 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:59 CET 2011 -->
66
<TITLE>
77
Deprecated List
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

‎doc/help-doc.html‎

Lines changed: 2 additions & 2 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 Fri Dec 23 00:33:42 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:59 CET 2011 -->
66
<TITLE>
77
API Help
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

‎doc/index-files/index-1.html‎

Lines changed: 17 additions & 7 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 Fri Dec 23 00:33:42 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:59 CET 2011 -->
66
<TITLE>
77
C-Index
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

@@ -84,22 +84,32 @@
8484
<DL>
8585
<DT><A HREF="../io/socket/IOTransport.html#canSendBulk()"><B>canSendBulk()</B></A> -
8686
Method in interface io.socket.<A HREF="../io/socket/IOTransport.html" title="interface in io.socket">IOTransport</A>
87-
<DD>&nbsp;
87+
<DD>return true if the IOTransport prefers to send multiple messages at a
88+
time.
8889
<DT><A HREF="../io/socket/transports/WebsocketTransport.html#canSendBulk()"><B>canSendBulk()</B></A> -
8990
Method in class io.socket.transports.<A HREF="../io/socket/transports/WebsocketTransport.html" title="class in io.socket.transports">WebsocketTransport</A>
9091
<DD>&nbsp;
9192
<DT><A HREF="../io/socket/IOConnection.html#connect(io.socket.SocketIO)"><B>connect(SocketIO)</B></A> -
9293
Method in class io.socket.<A HREF="../io/socket/IOConnection.html" title="class in io.socket">IOConnection</A>
93-
<DD>&nbsp;
94+
<DD>Connects a socket to the IOConnection
9495
<DT><A HREF="../io/socket/IOTransport.html#connect()"><B>connect()</B></A> -
9596
Method in interface io.socket.<A HREF="../io/socket/IOTransport.html" title="interface in io.socket">IOTransport</A>
96-
<DD>&nbsp;
97+
<DD>Instructs the IOTransport to connect.
98+
<DT><A HREF="../io/socket/SocketIO.html#connect(java.lang.String, io.socket.IOCallback)"><B>connect(String, IOCallback)</B></A> -
99+
Method in class io.socket.<A HREF="../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>
100+
<DD>connects to supplied host using callback.
101+
<DT><A HREF="../io/socket/SocketIO.html#connect(java.net.URL, io.socket.IOCallback)"><B>connect(URL, IOCallback)</B></A> -
102+
Method in class io.socket.<A HREF="../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>
103+
<DD>connects to supplied host using callback.
104+
<DT><A HREF="../io/socket/SocketIO.html#connect(io.socket.IOCallback)"><B>connect(IOCallback)</B></A> -
105+
Method in class io.socket.<A HREF="../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>
106+
<DD>connects to an already set host.
97107
<DT><A HREF="../io/socket/IOConnection.html#create(java.lang.String)"><B>create(String)</B></A> -
98108
Static method in class io.socket.<A HREF="../io/socket/IOConnection.html" title="class in io.socket">IOConnection</A>
99-
<DD>&nbsp;
109+
<DD>Creates a new connection or returns the corresponding one.
100110
<DT><A HREF="../io/socket/transports/WebsocketTransport.html#create(java.net.URL, io.socket.IOConnection)"><B>create(URL, IOConnection)</B></A> -
101111
Static method in class io.socket.transports.<A HREF="../io/socket/transports/WebsocketTransport.html" title="class in io.socket.transports">WebsocketTransport</A>
102-
<DD>&nbsp;
112+
<DD>Creates a new Transport for the given url an <A HREF="../io/socket/IOConnection.html" title="class in io.socket"><CODE>IOConnection</CODE></A>.
103113
</DL>
104114
<HR>
105115

‎doc/index-files/index-10.html‎

Lines changed: 6 additions & 3 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 Fri Dec 23 00:33:42 CET 2011 -->
5+
<!-- Generated by javadoc (build 1.6.0_29) on Tue Dec 27 10:37:59 CET 2011 -->
66
<TITLE>
77
R-Index
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2011-12-23">
10+
<META NAME="date" CONTENT="2011-12-27">
1111

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

@@ -84,7 +84,10 @@
8484
<DL>
8585
<DT><A HREF="../io/socket/IOConnection.html#reconnect()"><B>reconnect()</B></A> -
8686
Method in class io.socket.<A HREF="../io/socket/IOConnection.html" title="class in io.socket">IOConnection</A>
87-
<DD>&nbsp;
87+
<DD>forces a reconnect.
88+
<DT><A HREF="../io/socket/SocketIO.html#reconnect()"><B>reconnect()</B></A> -
89+
Method in class io.socket.<A HREF="../io/socket/SocketIO.html" title="class in io.socket">SocketIO</A>
90+
<DD>Triggers the transport to reconnect.
8891
</DL>
8992
<HR>
9093

0 commit comments

Comments
 (0)
X Tutup