Skip to content

Commit d15befc

Browse files
TooTallNateTooTallNate
committed
Updated the compiled JavaDoc files in 'doc'.
1 parent b81e4f8 commit d15befc

15 files changed

Lines changed: 498 additions & 210 deletions

‎doc/WebSocket.html‎

Lines changed: 18 additions & 10 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_17) on Wed Jan 20 21:55:44 PST 2010 -->
5+
<!-- Generated by javadoc (build 1.6.0_17) on Fri Jan 22 21:40:12 PST 2010 -->
66
<TITLE>
77
WebSocket
88
</TITLE>
99

10-
<META NAME="date" CONTENT="2010-01-20">
10+
<META NAME="date" CONTENT="2010-01-22">
1111

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

@@ -99,6 +99,10 @@ <H2>
9999
Represents one end (client or server) of a single WebSocket connection.
100100
Takes care of the "handshake" phase, then allows for easy sending of
101101
text frames, and recieving frames through an event-based model.
102+
103+
This is an inner class, used by <tt>WebSocketClient</tt> and
104+
<tt>WebSocketServer</tt>, and should never need to be instantiated directly
105+
by your code.
102106
<P>
103107

104108
<P>
@@ -235,7 +239,8 @@ <H2>
235239
<TD><CODE><B><A HREF="WebSocket.html#close()">close</A></B>()</CODE>
236240

237241
<BR>
238-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
242+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Closes the underlying SocketChannel, and calls the listener's onClose
243+
event handler.</TD>
239244
</TR>
240245
<TR BGCOLOR="white" CLASS="TableRowColor">
241246
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -273,7 +278,7 @@ <H2>
273278
<TR BGCOLOR="white" CLASS="TableRowColor">
274279
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275280
<CODE>&nbsp;void</CODE></FONT></TD>
276-
<TD><CODE><B><A HREF="WebSocket.html#sendFrame(java.lang.String)">sendFrame</A></B>(java.lang.String&nbsp;text)</CODE>
281+
<TD><CODE><B><A HREF="WebSocket.html#send(java.lang.String)">send</A></B>(java.lang.String&nbsp;text)</CODE>
277282

278283
<BR>
279284
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
@@ -489,7 +494,7 @@ <H2>
489494
<DD><DL>
490495

491496
<DT><B>Throws:</B>
492-
<DD><CODE>java.io.IOException</CODE></DL>
497+
<DD><CODE>java.io.IOException</CODE> - When socket related I/O errors occur.</DL>
493498
</DD>
494499
</DL>
495500
<HR>
@@ -500,19 +505,22 @@ <H2>
500505
public void <B>close</B>()
501506
throws java.io.IOException</PRE>
502507
<DL>
508+
<DD>Closes the underlying SocketChannel, and calls the listener's onClose
509+
event handler.
510+
<P>
503511
<DD><DL>
504512

505513
<DT><B>Throws:</B>
506-
<DD><CODE>java.io.IOException</CODE></DL>
514+
<DD><CODE>java.io.IOException</CODE> - When socket related I/O errors occur.</DL>
507515
</DD>
508516
</DL>
509517
<HR>
510518

511-
<A NAME="sendFrame(java.lang.String)"><!-- --></A><H3>
512-
sendFrame</H3>
519+
<A NAME="send(java.lang.String)"><!-- --></A><H3>
520+
send</H3>
513521
<PRE>
514-
public void <B>sendFrame</B>(java.lang.String&nbsp;text)
515-
throws java.io.IOException</PRE>
522+
public void <B>send</B>(java.lang.String&nbsp;text)
523+
throws java.io.IOException</PRE>
516524
<DL>
517525
<DD><DL>
518526

0 commit comments

Comments
 (0)