diff --git a/dist/WebSocket.jar b/dist/WebSocket.jar index 750656dd5..f6719a1ff 100644 Binary files a/dist/WebSocket.jar and b/dist/WebSocket.jar differ diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html index a30104b82..1c44fb745 100644 --- a/doc/allclasses-frame.html +++ b/doc/allclasses-frame.html @@ -2,12 +2,12 @@ - + All Classes - + @@ -21,59 +21,83 @@ - diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html index 3dd807a22..e7a29efdd 100644 --- a/doc/allclasses-noframe.html +++ b/doc/allclasses-noframe.html @@ -2,12 +2,12 @@ - + All Classes - + @@ -21,59 +21,83 @@
Base64 +Base64
-Base64.InputStream +Base64.InputStream
-Base64.OutputStream +Base64.OutputStream
-Charsetfunctions +Charsetfunctions
-Draft +ClientHandshake
-Draft.HandshakeState +ClientHandshakeBuilder
-Draft_10 +CloseFrame
-Draft_17 +CloseFrameBuilder
-Draft_75 +Draft
-Draft_76 +Draft.CloseHandshakeType
-FrameBuilder +Draft.HandshakeState
-Framedata +Draft_10
-Framedata.Opcode +Draft_17
-FramedataImpl1 +Draft_75
-HandshakeBuilder +Draft_76
-Handshakedata +FrameBuilder
-HandshakedataImpl1 +Framedata
-IncompleteHandshakeException +Framedata.Opcode
-InvalidDataException +FramedataImpl1
-InvalidFrameException +HandshakeBuilder
-InvalidHandshakeException +Handshakedata
-LimitExedeedException +HandshakedataImpl1
-WebSocket +HandshakeImpl1Client
-WebSocket.Role +HandshakeImpl1Server
-WebSocketAdapter +IncompleteHandshakeException
-WebSocketClient +InvalidDataException
-WebSocketServer +InvalidFrameException +
+InvalidHandshakeException +
+LimitExedeedException +
+NotSendableException +
+ServerHandshake +
+ServerHandshakeBuilder +
+WebSocket +
+WebSocket.Role +
+WebSocketAdapter +
+WebSocketClient +
+WebSocketListener +
+WebSocketListener.MessageType +
+WebSocketServer
- diff --git a/doc/constant-values.html b/doc/constant-values.html index 030a41ecb..57255c284 100644 --- a/doc/constant-values.html +++ b/doc/constant-values.html @@ -2,12 +2,12 @@ - + Constant Field Values - + @@ -84,14 +84,14 @@

Contents - +

Base64 +Base64
-Base64.InputStream +Base64.InputStream
-Base64.OutputStream +Base64.OutputStream
-Charsetfunctions +Charsetfunctions
-Draft +ClientHandshake
-Draft.HandshakeState +ClientHandshakeBuilder
-Draft_10 +CloseFrame
-Draft_17 +CloseFrameBuilder
-Draft_75 +Draft
-Draft_76 +Draft.CloseHandshakeType
-FrameBuilder +Draft.HandshakeState
-Framedata +Draft_10
-Framedata.Opcode +Draft_17
-FramedataImpl1 +Draft_75
-HandshakeBuilder +Draft_76
-Handshakedata +FrameBuilder
-HandshakedataImpl1 +Framedata
-IncompleteHandshakeException +Framedata.Opcode
-InvalidDataException +FramedataImpl1
-InvalidFrameException +HandshakeBuilder
-InvalidHandshakeException +Handshakedata
-LimitExedeedException +HandshakedataImpl1
-WebSocket +HandshakeImpl1Client
-WebSocket.Role +HandshakeImpl1Server
-WebSocketAdapter +IncompleteHandshakeException
-WebSocketClient +InvalidDataException
-WebSocketServer +InvalidFrameException +
+InvalidHandshakeException +
+LimitExedeedException +
+NotSendableException +
+ServerHandshake +
+ServerHandshakeBuilder +
+WebSocket +
+WebSocket.Role +
+WebSocketAdapter +
+WebSocketClient +
+WebSocketListener +
+WebSocketListener.MessageType +
+WebSocketServer
+org.java_websocket.*
-net.tootallnate.*
@@ -99,55 +99,73 @@

- + - - - + + - - - + + - - - + + - - - + + - - - + + + + + +
net.tootallnate.websocket.Base64org.java_websocket.WebSocket
+ public static final intDECODE0DEFAULT_PORT80
+ public static final intDO_BREAK_LINES8READY_STATE_CLOSED3
+ public static final intDONT_GUNZIP4READY_STATE_CLOSING2
+ public static final intENCODE1READY_STATE_CONNECTING0
+ public static final intGZIP2READY_STATE_OPEN1
+ +

+ +

+ + + + - - - + + + - - - + + + - - - + + + + + + + + @@ -159,13 +177,85 @@

org.java_websocket.drafts.Draft_75
-public static final intNO_OPTIONS0 +public static final byteCR13
-public static final intORDERED32 +public static final byteEND_OF_FRAME-1
-public static final intURL_SAFE16 +public static final byteLF10
+public static final byteSTART_OF_FRAME0
- + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -177,32 +267,56 @@

net.tootallnate.websocket.WebSocketorg.java_websocket.framing.CloseFrame
+ public static final intDEFAULT_PORT80ABNROMAL_CLOSE1006
+public static final intBUGGYCLOSE-2
+public static final intEXTENSION1010
+public static final intFLASHPOLICY-3
+public static final intGOING_AWAY1001
+public static final intNEVERCONNECTED-1
+public static final intNO_UTF81007
+public static final intNOCODE1005
+public static final intNORMAL1000
+public static final intPOLICY_VALIDATION1008
+public static final intPROTOCOL_ERROR1002
+public static final intREFUSE1003
+public static final intTOOBIG1009
- + - - - + + + - - - + + + - - - + + + - - + + + + + + + + + + + + + + + + + + + + + +
net.tootallnate.websocket.drafts.Draft_75org.java_websocket.util.Base64
-public static final byteCR13 +public static final intDECODE0
-public static final byteEND_OF_FRAME-1 +public static final intDO_BREAK_LINES8
-public static final byteLF10 +public static final intDONT_GUNZIP4
-public static final byteSTART_OF_FRAME +public static final intENCODE1
+public static final intGZIP2
+public static final intNO_OPTIONS 0
+public static final intORDERED32
+public static final intURL_SAFE16
diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html index 638b6f30b..a64c56ce6 100644 --- a/doc/deprecated-list.html +++ b/doc/deprecated-list.html @@ -2,12 +2,12 @@ - + Deprecated List - + diff --git a/doc/help-doc.html b/doc/help-doc.html index cbd483c58..e07973f5f 100644 --- a/doc/help-doc.html +++ b/doc/help-doc.html @@ -2,12 +2,12 @@ - + API Help - + diff --git a/doc/index-all.html b/doc/index-all.html index d9bac5a00..8c3be44c9 100644 --- a/doc/index-all.html +++ b/doc/index-all.html @@ -2,12 +2,12 @@ - + Index - + @@ -77,836 +77,1131 @@ -A B C D E F G H I K L N O P R S T U V W

+A B C D E F G H I K L M N O P R S T U V W

A

-
abort() - -Method in class net.tootallnate.websocket.WebSocket +
ABNROMAL_CLOSE - +Static variable in interface org.java_websocket.framing.CloseFrame +
1006 is a reserved value and MUST NOT be set as a status code in a + Close control frame by an endpoint. +
acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - +Method in class org.java_websocket.drafts.Draft
  -
abort(String) - -Method in class net.tootallnate.websocket.WebSocket +
acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - +Method in class org.java_websocket.drafts.Draft_10
  -
acceptHandshakeAsClient(Handshakedata, Handshakedata) - -Method in class net.tootallnate.websocket.Draft +
acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - +Method in class org.java_websocket.drafts.Draft_75
  -
acceptHandshakeAsClient(Handshakedata, Handshakedata) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
acceptHandshakeAsClient(ClientHandshake, ServerHandshake) - +Method in class org.java_websocket.drafts.Draft_76
  -
acceptHandshakeAsClient(Handshakedata, Handshakedata) - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
acceptHandshakeAsServer(ClientHandshake) - +Method in class org.java_websocket.drafts.Draft
  -
acceptHandshakeAsClient(Handshakedata, Handshakedata) - -Method in class net.tootallnate.websocket.drafts.Draft_76 +
acceptHandshakeAsServer(ClientHandshake) - +Method in class org.java_websocket.drafts.Draft_10
  -
acceptHandshakeAsServer(Handshakedata) - -Method in class net.tootallnate.websocket.Draft +
acceptHandshakeAsServer(ClientHandshake) - +Method in class org.java_websocket.drafts.Draft_17
  -
acceptHandshakeAsServer(Handshakedata) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
acceptHandshakeAsServer(ClientHandshake) - +Method in class org.java_websocket.drafts.Draft_75
  -
acceptHandshakeAsServer(Handshakedata) - -Method in class net.tootallnate.websocket.drafts.Draft_17 +
acceptHandshakeAsServer(ClientHandshake) - +Method in class org.java_websocket.drafts.Draft_76
  -
acceptHandshakeAsServer(Handshakedata) - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
append(Framedata) - +Method in interface org.java_websocket.framing.Framedata
  -
acceptHandshakeAsServer(Handshakedata) - -Method in class net.tootallnate.websocket.drafts.Draft_76 +
append(Framedata) - +Method in class org.java_websocket.framing.FramedataImpl1
  -
append(Framedata) - -Method in interface net.tootallnate.websocket.Framedata -
  -
append(Framedata) - -Method in class net.tootallnate.websocket.FramedataImpl1 -
  -
asciiBytes(String) - -Static method in class net.tootallnate.websocket.Charsetfunctions +
asciiBytes(String) - +Static method in class org.java_websocket.util.Charsetfunctions
 

B

-
Base64 - Class in net.tootallnate.websocket
Encodes and decodes to and from Base64 notation.
Base64.InputStream - Class in net.tootallnate.websocket
A Base64.InputStream will read data from another +
Base64 - Class in org.java_websocket.util
Encodes and decodes to and from Base64 notation.
Base64.InputStream - Class in org.java_websocket.util
A Base64.InputStream will read data from another java.io.InputStream, given in the constructor, - and encode/decode to/from Base64 notation on the fly.
Base64.InputStream(InputStream) - -Constructor for class net.tootallnate.websocket.Base64.InputStream -
Constructs a Base64.InputStream in DECODE mode. -
Base64.InputStream(InputStream, int) - -Constructor for class net.tootallnate.websocket.Base64.InputStream -
Constructs a Base64.InputStream in + and encode/decode to/from Base64 notation on the fly.
Base64.InputStream(InputStream) - +Constructor for class org.java_websocket.util.Base64.InputStream +
Constructs a Base64.InputStream in DECODE mode. +
Base64.InputStream(InputStream, int) - +Constructor for class org.java_websocket.util.Base64.InputStream +
Constructs a Base64.InputStream in either ENCODE or DECODE mode. -
Base64.OutputStream - Class in net.tootallnate.websocket
A Base64.OutputStream will write data to another +
Base64.OutputStream - Class in org.java_websocket.util
A Base64.OutputStream will write data to another java.io.OutputStream, given in the constructor, - and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream(OutputStream) - -Constructor for class net.tootallnate.websocket.Base64.OutputStream -
Constructs a Base64.OutputStream in ENCODE mode. -
Base64.OutputStream(OutputStream, int) - -Constructor for class net.tootallnate.websocket.Base64.OutputStream -
Constructs a Base64.OutputStream in + and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream(OutputStream) - +Constructor for class org.java_websocket.util.Base64.OutputStream +
Constructs a Base64.OutputStream in ENCODE mode. +
Base64.OutputStream(OutputStream, int) - +Constructor for class org.java_websocket.util.Base64.OutputStream +
Constructs a Base64.OutputStream in either ENCODE or DECODE mode. -
basicAccept(Handshakedata) - -Method in class net.tootallnate.websocket.Draft +
basicAccept(Handshakedata) - +Method in class org.java_websocket.drafts.Draft +
  +
BUGGYCLOSE - +Static variable in interface org.java_websocket.framing.CloseFrame
 

C

-
Charsetfunctions - Class in net.tootallnate.websocket
 
Charsetfunctions() - -Constructor for class net.tootallnate.websocket.Charsetfunctions +
Charsetfunctions - Class in org.java_websocket.util
 
Charsetfunctions() - +Constructor for class org.java_websocket.util.Charsetfunctions
  -
checkAlloc(int) - -Method in class net.tootallnate.websocket.Draft +
checkAlloc(int) - +Method in class org.java_websocket.drafts.Draft
  -
close() - -Method in class net.tootallnate.websocket.Base64.OutputStream +
ClientHandshake - Interface in org.java_websocket.handshake
 
ClientHandshakeBuilder - Interface in org.java_websocket.handshake
 
close() - +Method in class org.java_websocket.util.Base64.OutputStream
Flushes and closes (I think, in the superclass) the stream. -
close() - -Method in class net.tootallnate.websocket.WebSocket -
Closes the underlying SocketChannel, and calls the listener's onClose - event handler. -
close() - -Method in class net.tootallnate.websocket.WebSocketClient -
Calls close on the underlying SocketChannel, which in turn - closes the socket connection, and ends the client socket thread. -
connect() - -Method in class net.tootallnate.websocket.WebSocketClient +
close(int, String) - +Method in class org.java_websocket.WebSocket +
sends the closing handshake. +
close(int) - +Method in class org.java_websocket.WebSocket +
  +
close(InvalidDataException) - +Method in class org.java_websocket.WebSocket +
  +
close() - +Method in class org.java_websocket.WebSocketClient +
  +
closeConnection(int, String, boolean) - +Method in class org.java_websocket.WebSocket +
closes the socket no matter if the closing handshake completed. +
closeConnection(int, boolean) - +Method in class org.java_websocket.WebSocket +
  +
closeDirect(int, String) - +Method in class org.java_websocket.WebSocket +
  +
CloseFrame - Interface in org.java_websocket.framing
 
CloseFrameBuilder - Class in org.java_websocket.framing
 
CloseFrameBuilder() - +Constructor for class org.java_websocket.framing.CloseFrameBuilder +
  +
CloseFrameBuilder(int) - +Constructor for class org.java_websocket.framing.CloseFrameBuilder +
  +
CloseFrameBuilder(int, String) - +Constructor for class org.java_websocket.framing.CloseFrameBuilder +
  +
codingErrorAction - +Static variable in class org.java_websocket.util.Charsetfunctions +
  +
connect() - +Method in class org.java_websocket.WebSocketClient
Starts a background thread that attempts and maintains a WebSocket connection to the URI specified in the constructor or via setURI. -
connections() - -Method in class net.tootallnate.websocket.WebSocketServer +
connections() - +Method in class org.java_websocket.WebSocketServer
Returns a WebSocket[] of currently connected clients. -
CR - -Static variable in class net.tootallnate.websocket.drafts.Draft_75 +
connectTiming(Date, Date) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
connectTiming(Date, Date) - +Method in interface org.java_websocket.WebSocketListener +
Informs the Listener how long it took to open a socket connection +
CR - +Static variable in class org.java_websocket.drafts.Draft_75
The byte representing CR, or Carriage Return, or \r -
createBinaryFrame(Framedata) - -Method in class net.tootallnate.websocket.Draft +
createBinaryFrame(Framedata) - +Method in class org.java_websocket.drafts.Draft
  -
createBinaryFrame(Framedata) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
createBinaryFrame(Framedata) - +Method in class org.java_websocket.drafts.Draft_10
  -
createBinaryFrame(Framedata) - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
createBinaryFrame(Framedata) - +Method in class org.java_websocket.drafts.Draft_75
  -
createChallenge(String, String, byte[]) - -Static method in class net.tootallnate.websocket.drafts.Draft_76 +
createBinaryFrame(Framedata) - +Method in class org.java_websocket.drafts.Draft_76
  -
createFrames(byte[], boolean) - -Method in class net.tootallnate.websocket.Draft +
createChallenge(String, String, byte[]) - +Static method in class org.java_websocket.drafts.Draft_76
  -
createFrames(String, boolean) - -Method in class net.tootallnate.websocket.Draft +
createFrames(byte[], boolean) - +Method in class org.java_websocket.drafts.Draft
  -
createFrames(byte[], boolean) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
createFrames(String, boolean) - +Method in class org.java_websocket.drafts.Draft
  -
createFrames(String, boolean) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
createFrames(byte[], boolean) - +Method in class org.java_websocket.drafts.Draft_10
  -
createFrames(byte[], boolean) - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
createFrames(String, boolean) - +Method in class org.java_websocket.drafts.Draft_10
  -
createFrames(String, boolean) - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
createFrames(byte[], boolean) - +Method in class org.java_websocket.drafts.Draft_75
  -
createHandshake(Handshakedata, WebSocket.Role) - -Method in class net.tootallnate.websocket.Draft +
createFrames(String, boolean) - +Method in class org.java_websocket.drafts.Draft_75
  -
createHandshake(Handshakedata, WebSocket.Role, boolean) - -Method in class net.tootallnate.websocket.Draft +
createHandshake(Handshakedata, WebSocket.Role) - +Method in class org.java_websocket.drafts.Draft +
  +
createHandshake(Handshakedata, WebSocket.Role, boolean) - +Method in class org.java_websocket.drafts.Draft +
  +
currentFrame - +Variable in class org.java_websocket.drafts.Draft_75
 

D

-
DEBUG - -Static variable in class net.tootallnate.websocket.WebSocket +
DEBUG - +Static variable in class org.java_websocket.WebSocket
  -
DECODE - -Static variable in class net.tootallnate.websocket.Base64 +
DECODE - +Static variable in class org.java_websocket.util.Base64
Specify decoding in first bit. -
decode(byte[]) - -Static method in class net.tootallnate.websocket.Base64 +
decode(byte[]) - +Static method in class org.java_websocket.util.Base64
Low-level access to decoding ASCII characters in the form of a byte array. -
decode(byte[], int, int, int) - -Static method in class net.tootallnate.websocket.Base64 +
decode(byte[], int, int, int) - +Static method in class org.java_websocket.util.Base64
Low-level access to decoding ASCII characters in the form of a byte array. -
decode(String) - -Static method in class net.tootallnate.websocket.Base64 +
decode(String) - +Static method in class org.java_websocket.util.Base64
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. -
decode(String, int) - -Static method in class net.tootallnate.websocket.Base64 +
decode(String, int) - +Static method in class org.java_websocket.util.Base64
Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it. -
decodeFileToFile(String, String) - -Static method in class net.tootallnate.websocket.Base64 +
decodeFileToFile(String, String) - +Static method in class org.java_websocket.util.Base64
Reads infile and decodes it to outfile. -
decodeFromFile(String) - -Static method in class net.tootallnate.websocket.Base64 +
decodeFromFile(String) - +Static method in class org.java_websocket.util.Base64
Convenience method for reading a base64-encoded file and decoding it. -
decodeToFile(String, String) - -Static method in class net.tootallnate.websocket.Base64 +
decodeToFile(String, String) - +Static method in class org.java_websocket.util.Base64
Convenience method for decoding data to a file. -
decodeToObject(String) - -Static method in class net.tootallnate.websocket.Base64 +
decodeToObject(String) - +Static method in class org.java_websocket.util.Base64
Attempts to decode Base64 data and deserialize a Java Object within. -
decodeToObject(String, int, ClassLoader) - -Static method in class net.tootallnate.websocket.Base64 +
decodeToObject(String, int, ClassLoader) - +Static method in class org.java_websocket.util.Base64
Attempts to decode Base64 data and deserialize a Java Object within. -
DEFAULT_PORT - -Static variable in class net.tootallnate.websocket.WebSocket +
DEFAULT_PORT - +Static variable in class org.java_websocket.WebSocket
The default port of WebSockets, as defined in the spec. -
DO_BREAK_LINES - -Static variable in class net.tootallnate.websocket.Base64 +
DO_BREAK_LINES - +Static variable in class org.java_websocket.util.Base64
Do break lines when encoding. -
DONT_GUNZIP - -Static variable in class net.tootallnate.websocket.Base64 +
DONT_GUNZIP - +Static variable in class org.java_websocket.util.Base64
Specify that gzipped data should not be automatically gunzipped. -
Draft - Class in net.tootallnate.websocket
 
Draft() - -Constructor for class net.tootallnate.websocket.Draft +
Draft - Class in org.java_websocket.drafts
Base class for everything of a websocket specification which is not common such as the way the handshake is read or frames are transfered.
Draft() - +Constructor for class org.java_websocket.drafts.Draft
  -
Draft.HandshakeState - Enum in net.tootallnate.websocket
 
Draft_10 - Class in net.tootallnate.websocket.drafts
 
Draft_10() - -Constructor for class net.tootallnate.websocket.drafts.Draft_10 +
Draft.CloseHandshakeType - Enum in org.java_websocket.drafts
 
Draft.HandshakeState - Enum in org.java_websocket.drafts
 
Draft_10 - Class in org.java_websocket.drafts
 
Draft_10() - +Constructor for class org.java_websocket.drafts.Draft_10
  -
Draft_17 - Class in net.tootallnate.websocket.drafts
 
Draft_17() - -Constructor for class net.tootallnate.websocket.drafts.Draft_17 +
Draft_17 - Class in org.java_websocket.drafts
 
Draft_17() - +Constructor for class org.java_websocket.drafts.Draft_17
  -
Draft_75 - Class in net.tootallnate.websocket.drafts
 
Draft_75() - -Constructor for class net.tootallnate.websocket.drafts.Draft_75 +
Draft_75 - Class in org.java_websocket.drafts
 
Draft_75() - +Constructor for class org.java_websocket.drafts.Draft_75
  -
Draft_76 - Class in net.tootallnate.websocket.drafts
 
Draft_76() - -Constructor for class net.tootallnate.websocket.drafts.Draft_76 +
Draft_76 - Class in org.java_websocket.drafts
 
Draft_76() - +Constructor for class org.java_websocket.drafts.Draft_76
 

E

-
ENCODE - -Static variable in class net.tootallnate.websocket.Base64 +
emptyarray - +Static variable in class org.java_websocket.framing.FramedataImpl1 +
  +
ENCODE - +Static variable in class org.java_websocket.util.Base64
Specify encoding in first bit. -
encode(ByteBuffer, ByteBuffer) - -Static method in class net.tootallnate.websocket.Base64 +
encode(ByteBuffer, ByteBuffer) - +Static method in class org.java_websocket.util.Base64
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded ByteBuffer. -
encode(ByteBuffer, CharBuffer) - -Static method in class net.tootallnate.websocket.Base64 +
encode(ByteBuffer, CharBuffer) - +Static method in class org.java_websocket.util.Base64
Performs Base64 encoding on the raw ByteBuffer, writing it to the encoded CharBuffer. -
encodeBytes(byte[]) - -Static method in class net.tootallnate.websocket.Base64 +
encodeBytes(byte[]) - +Static method in class org.java_websocket.util.Base64
Encodes a byte array into Base64 notation. -
encodeBytes(byte[], int) - -Static method in class net.tootallnate.websocket.Base64 +
encodeBytes(byte[], int) - +Static method in class org.java_websocket.util.Base64
Encodes a byte array into Base64 notation. -
encodeBytes(byte[], int, int) - -Static method in class net.tootallnate.websocket.Base64 +
encodeBytes(byte[], int, int) - +Static method in class org.java_websocket.util.Base64
Encodes a byte array into Base64 notation. -
encodeBytes(byte[], int, int, int) - -Static method in class net.tootallnate.websocket.Base64 +
encodeBytes(byte[], int, int, int) - +Static method in class org.java_websocket.util.Base64
Encodes a byte array into Base64 notation. -
encodeBytesToBytes(byte[]) - -Static method in class net.tootallnate.websocket.Base64 -
Similar to Base64.encodeBytes(byte[]) but returns +
encodeBytesToBytes(byte[]) - +Static method in class org.java_websocket.util.Base64 +
Similar to Base64.encodeBytes(byte[]) but returns a byte array instead of instantiating a String. -
encodeBytesToBytes(byte[], int, int, int) - -Static method in class net.tootallnate.websocket.Base64 -
Similar to Base64.encodeBytes(byte[], int, int, int) but returns +
encodeBytesToBytes(byte[], int, int, int) - +Static method in class org.java_websocket.util.Base64 +
Similar to Base64.encodeBytes(byte[], int, int, int) but returns a byte array instead of instantiating a String. -
encodeFileToFile(String, String) - -Static method in class net.tootallnate.websocket.Base64 +
encodeFileToFile(String, String) - +Static method in class org.java_websocket.util.Base64
Reads infile and encodes it to outfile. -
encodeFromFile(String) - -Static method in class net.tootallnate.websocket.Base64 +
encodeFromFile(String) - +Static method in class org.java_websocket.util.Base64
Convenience method for reading a binary file and base64-encoding it. -
encodeObject(Serializable) - -Static method in class net.tootallnate.websocket.Base64 +
encodeObject(Serializable) - +Static method in class org.java_websocket.util.Base64
Serializes an object and returns the Base64-encoded version of that serialized object. -
encodeObject(Serializable, int) - -Static method in class net.tootallnate.websocket.Base64 +
encodeObject(Serializable, int) - +Static method in class org.java_websocket.util.Base64
Serializes an object and returns the Base64-encoded version of that serialized object. -
encodeToFile(byte[], String) - -Static method in class net.tootallnate.websocket.Base64 +
encodeToFile(byte[], String) - +Static method in class org.java_websocket.util.Base64
Convenience method for encoding data to a file. -
END_OF_FRAME - -Static variable in class net.tootallnate.websocket.drafts.Draft_75 +
END_OF_FRAME - +Static variable in class org.java_websocket.drafts.Draft_75
The byte representing the end of a WebSocket text frame. +
EXTENSION - +Static variable in interface org.java_websocket.framing.CloseFrame +
1010 indicates that an endpoint (client) is terminating the + connection because it has expected the server to negotiate one or + more extension, but the server didn't return them in the response + message of the WebSocket handshake.

F

-
flushBase64() - -Method in class net.tootallnate.websocket.Base64.OutputStream +
fin - +Variable in class org.java_websocket.framing.FramedataImpl1 +
  +
FLASH_POLICY_REQUEST - +Static variable in class org.java_websocket.drafts.Draft +
  +
FLASHPOLICY - +Static variable in interface org.java_websocket.framing.CloseFrame +
  +
flush() - +Method in class org.java_websocket.WebSocket +
Empty the internal buffer, sending all the pending data before continuing. +
flush() - +Method in class org.java_websocket.WebSocketClient +
  +
flushBase64() - +Method in class org.java_websocket.util.Base64.OutputStream
Method added by PHIL. -
FrameBuilder - Interface in net.tootallnate.websocket
 
Framedata - Interface in net.tootallnate.websocket
 
Framedata.Opcode - Enum in net.tootallnate.websocket
 
FramedataImpl1 - Class in net.tootallnate.websocket
 
FramedataImpl1() - -Constructor for class net.tootallnate.websocket.FramedataImpl1 +
FrameBuilder - Interface in org.java_websocket.framing
 
Framedata - Interface in org.java_websocket.framing
 
Framedata.Opcode - Enum in org.java_websocket.framing
 
FramedataImpl1 - Class in org.java_websocket.framing
 
FramedataImpl1() - +Constructor for class org.java_websocket.framing.FramedataImpl1
  -
FramedataImpl1(Framedata.Opcode) - -Constructor for class net.tootallnate.websocket.FramedataImpl1 +
FramedataImpl1(Framedata.Opcode) - +Constructor for class org.java_websocket.framing.FramedataImpl1
  -
FramedataImpl1(Framedata) - -Constructor for class net.tootallnate.websocket.FramedataImpl1 +
FramedataImpl1(Framedata) - +Constructor for class org.java_websocket.framing.FramedataImpl1
 

G

-
getAddress() - -Method in class net.tootallnate.websocket.WebSocketServer +
getAddress() - +Method in class org.java_websocket.WebSocketServer +
  +
getBufferedAmount() - +Method in class org.java_websocket.WebSocketClient +
Amount of data buffered/queued but not sent yet. +
getCloseCode() - +Method in exception org.java_websocket.exeptions.InvalidDataException +
  +
getCloseCode() - +Method in interface org.java_websocket.framing.CloseFrame +
  +
getCloseCode() - +Method in class org.java_websocket.framing.CloseFrameBuilder +
  +
getCloseHandshakeType() - +Method in class org.java_websocket.drafts.Draft
  -
getContent() - -Method in interface net.tootallnate.websocket.Handshakedata +
getCloseHandshakeType() - +Method in class org.java_websocket.drafts.Draft_10
  -
getContent() - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
getCloseHandshakeType() - +Method in class org.java_websocket.drafts.Draft_75
  -
getDraft() - -Method in class net.tootallnate.websocket.WebSocketClient +
getCloseHandshakeType() - +Method in class org.java_websocket.drafts.Draft_76
  -
getDraft() - -Method in class net.tootallnate.websocket.WebSocketServer +
getConnection() - +Method in class org.java_websocket.WebSocketClient
  -
getFieldValue(String) - -Method in interface net.tootallnate.websocket.Handshakedata +
getContent() - +Method in interface org.java_websocket.handshake.Handshakedata
  -
getFieldValue(String) - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
getContent() - +Method in class org.java_websocket.handshake.HandshakedataImpl1
  -
getFlashPolicy(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketAdapter +
getDraft() - +Method in class org.java_websocket.WebSocketClient +
Returns the protocol version this client uses. +
getDraft() - +Method in class org.java_websocket.WebSocketServer +
  +
getFieldValue(String) - +Method in interface org.java_websocket.handshake.Handshakedata +
  +
getFieldValue(String) - +Method in class org.java_websocket.handshake.HandshakedataImpl1 +
  +
getFlashPolicy(WebSocket) - +Method in class org.java_websocket.WebSocketAdapter
Gets the XML string that should be returned if a client requests a Flash security policy. -
getFlashSecurityPolicy() - -Method in class net.tootallnate.websocket.WebSocketServer +
getFlashPolicy(WebSocket) - +Method in interface org.java_websocket.WebSocketListener
Gets the XML string that should be returned if a client requests a Flash security policy. -
getHttpStatusMessage() - -Method in interface net.tootallnate.websocket.Handshakedata +
getFlashSecurityPolicy() - +Method in class org.java_websocket.WebSocketServer +
Gets the XML string that should be returned if a client requests a Flash + security policy. +
getHttpStatus() - +Method in class org.java_websocket.handshake.HandshakeImpl1Server +
  +
getHttpStatus() - +Method in interface org.java_websocket.handshake.ServerHandshake
  -
getHttpStatusMessage() - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
getHttpStatusMessage() - +Method in class org.java_websocket.handshake.HandshakeImpl1Server
  -
getLocalSocketAddress() - -Method in class net.tootallnate.websocket.WebSocket +
getHttpStatusMessage() - +Method in interface org.java_websocket.handshake.ServerHandshake
  -
getOpcode() - -Method in interface net.tootallnate.websocket.Framedata +
getLocalSocketAddress() - +Method in class org.java_websocket.WebSocket
  -
getOpcode() - -Method in class net.tootallnate.websocket.FramedataImpl1 +
getMessage() - +Method in interface org.java_websocket.framing.CloseFrame
  -
getPayloadData() - -Method in interface net.tootallnate.websocket.Framedata +
getMessage() - +Method in class org.java_websocket.framing.CloseFrameBuilder
  -
getPayloadData() - -Method in class net.tootallnate.websocket.FramedataImpl1 +
getOpcode() - +Method in interface org.java_websocket.framing.Framedata
  -
getPort() - -Method in class net.tootallnate.websocket.WebSocketServer +
getOpcode() - +Method in class org.java_websocket.framing.FramedataImpl1 +
  +
getPayloadData() - +Method in class org.java_websocket.framing.CloseFrameBuilder +
  +
getPayloadData() - +Method in interface org.java_websocket.framing.Framedata +
  +
getPayloadData() - +Method in class org.java_websocket.framing.FramedataImpl1 +
  +
getPort() - +Method in class org.java_websocket.WebSocketServer
Gets the port number that this server listens on. -
getRemoteSocketAddress() - -Method in class net.tootallnate.websocket.WebSocket +
getReadyState() - +Method in class org.java_websocket.WebSocket +
Retrieve the WebSocket 'readyState'. +
getReadyState() - +Method in class org.java_websocket.WebSocketClient +
Retrieve the WebSocket 'readyState'. +
getRemoteSocketAddress() - +Method in class org.java_websocket.WebSocket
  -
getResourceDescriptor() - -Method in interface net.tootallnate.websocket.Handshakedata +
getResourceDescriptor() - +Method in interface org.java_websocket.handshake.ClientHandshake
  -
getResourceDescriptor() - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
getResourceDescriptor() - +Method in class org.java_websocket.handshake.HandshakeImpl1Client
  -
getTransfereMasked() - -Method in interface net.tootallnate.websocket.Framedata +
getTransfereMasked() - +Method in interface org.java_websocket.framing.Framedata
  -
getTransfereMasked() - -Method in class net.tootallnate.websocket.FramedataImpl1 +
getTransfereMasked() - +Method in class org.java_websocket.framing.FramedataImpl1
  -
getURI() - -Method in class net.tootallnate.websocket.WebSocketClient +
getURI() - +Method in class org.java_websocket.WebSocketClient
Gets the URI that this WebSocketClient is connected to. -
GZIP - -Static variable in class net.tootallnate.websocket.Base64 +
GOING_AWAY - +Static variable in interface org.java_websocket.framing.CloseFrame +
1001 indicates that an endpoint is "going away", such as a server + going down, or a browser having navigated away from a page. +
GZIP - +Static variable in class org.java_websocket.util.Base64
Specify that data should be gzip-compressed in second bit.

H

-
handleRead() - -Method in class net.tootallnate.websocket.WebSocket -
Should be called when a Selector has a key that is writable for this - WebSocket's SocketChannel connection. -
handleWrite() - -Method in class net.tootallnate.websocket.WebSocket +
HandshakeBuilder - Interface in org.java_websocket.handshake
 
Handshakedata - Interface in org.java_websocket.handshake
 
HandshakedataImpl1 - Class in org.java_websocket.handshake
 
HandshakedataImpl1() - +Constructor for class org.java_websocket.handshake.HandshakedataImpl1 +
  +
HandshakeImpl1Client - Class in org.java_websocket.handshake
 
HandshakeImpl1Client() - +Constructor for class org.java_websocket.handshake.HandshakeImpl1Client
  -
HandshakeBuilder - Interface in net.tootallnate.websocket
 
Handshakedata - Interface in net.tootallnate.websocket
 
HandshakedataImpl1 - Class in net.tootallnate.websocket
 
HandshakedataImpl1() - -Constructor for class net.tootallnate.websocket.HandshakedataImpl1 +
HandshakeImpl1Server - Class in org.java_websocket.handshake
 
HandshakeImpl1Server() - +Constructor for class org.java_websocket.handshake.HandshakeImpl1Server
  -
HandshakedataImpl1(Handshakedata) - -Constructor for class net.tootallnate.websocket.HandshakedataImpl1 +
hasFieldValue(String) - +Method in interface org.java_websocket.handshake.Handshakedata
  -
hasFieldValue(String) - -Method in interface net.tootallnate.websocket.Handshakedata +
hasFieldValue(String) - +Method in class org.java_websocket.handshake.HandshakedataImpl1
  -
hasFieldValue(String) - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
hashCode() - +Method in class org.java_websocket.WebSocket
 

I

-
IncompleteHandshakeException - Exception in net.tootallnate.websocket.exeptions
 
IncompleteHandshakeException() - -Constructor for exception net.tootallnate.websocket.exeptions.IncompleteHandshakeException +
IncompleteHandshakeException - Exception in org.java_websocket.exeptions
 
IncompleteHandshakeException() - +Constructor for exception org.java_websocket.exeptions.IncompleteHandshakeException
  -
IncompleteHandshakeException(String, Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.IncompleteHandshakeException +
IncompleteHandshakeException(String, Throwable) - +Constructor for exception org.java_websocket.exeptions.IncompleteHandshakeException
  -
IncompleteHandshakeException(String) - -Constructor for exception net.tootallnate.websocket.exeptions.IncompleteHandshakeException +
IncompleteHandshakeException(String) - +Constructor for exception org.java_websocket.exeptions.IncompleteHandshakeException
  -
IncompleteHandshakeException(Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.IncompleteHandshakeException +
IncompleteHandshakeException(Throwable) - +Constructor for exception org.java_websocket.exeptions.IncompleteHandshakeException
  -
InvalidDataException - Exception in net.tootallnate.websocket.exeptions
 
InvalidDataException() - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidDataException +
interruptableRun() - +Method in class org.java_websocket.WebSocketClient
  -
InvalidDataException(String) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidDataException +
InvalidDataException - Exception in org.java_websocket.exeptions
 
InvalidDataException(int) - +Constructor for exception org.java_websocket.exeptions.InvalidDataException
  -
InvalidDataException(Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidDataException +
InvalidDataException(int, String) - +Constructor for exception org.java_websocket.exeptions.InvalidDataException
  -
InvalidDataException(String, Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidDataException +
InvalidDataException(int, Throwable) - +Constructor for exception org.java_websocket.exeptions.InvalidDataException
  -
InvalidFrameException - Exception in net.tootallnate.websocket.exeptions
 
InvalidFrameException() - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidFrameException +
InvalidDataException(int, String, Throwable) - +Constructor for exception org.java_websocket.exeptions.InvalidDataException
  -
InvalidFrameException(String) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidFrameException +
InvalidFrameException - Exception in org.java_websocket.exeptions
 
InvalidFrameException() - +Constructor for exception org.java_websocket.exeptions.InvalidFrameException
  -
InvalidFrameException(Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidFrameException +
InvalidFrameException(String) - +Constructor for exception org.java_websocket.exeptions.InvalidFrameException
  -
InvalidFrameException(String, Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidFrameException +
InvalidFrameException(Throwable) - +Constructor for exception org.java_websocket.exeptions.InvalidFrameException
  -
InvalidHandshakeException - Exception in net.tootallnate.websocket.exeptions
 
InvalidHandshakeException() - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidHandshakeException +
InvalidFrameException(String, Throwable) - +Constructor for exception org.java_websocket.exeptions.InvalidFrameException
  -
InvalidHandshakeException(String, Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidHandshakeException +
InvalidHandshakeException - Exception in org.java_websocket.exeptions
 
InvalidHandshakeException() - +Constructor for exception org.java_websocket.exeptions.InvalidHandshakeException
  -
InvalidHandshakeException(String) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidHandshakeException +
InvalidHandshakeException(String, Throwable) - +Constructor for exception org.java_websocket.exeptions.InvalidHandshakeException
  -
InvalidHandshakeException(Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.InvalidHandshakeException +
InvalidHandshakeException(String) - +Constructor for exception org.java_websocket.exeptions.InvalidHandshakeException
  -
isFin() - -Method in interface net.tootallnate.websocket.Framedata +
InvalidHandshakeException(Throwable) - +Constructor for exception org.java_websocket.exeptions.InvalidHandshakeException
  -
isFin() - -Method in class net.tootallnate.websocket.FramedataImpl1 +
isClosed() - +Method in class org.java_websocket.WebSocket
  -
isFlashEdgeCase(ByteBuffer) - -Method in class net.tootallnate.websocket.WebSocket +
isClosing() - +Method in class org.java_websocket.WebSocket
  -
iterateHttpFields() - -Method in interface net.tootallnate.websocket.Handshakedata +
isConnecting() - +Method in class org.java_websocket.WebSocket
  -
iterateHttpFields() - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
isFin() - +Method in interface org.java_websocket.framing.Framedata +
  +
isFin() - +Method in class org.java_websocket.framing.FramedataImpl1 +
  +
isFlashEdgeCase(ByteBuffer) - +Method in class org.java_websocket.WebSocket +
  +
isOpen() - +Method in class org.java_websocket.WebSocket +
  +
iterateHttpFields() - +Method in interface org.java_websocket.handshake.Handshakedata +
  +
iterateHttpFields() - +Method in class org.java_websocket.handshake.HandshakedataImpl1
 

K

-
known_drafts - -Variable in class net.tootallnate.websocket.WebSocket +
known_drafts - +Variable in class org.java_websocket.WebSocket
 

L

-
LF - -Static variable in class net.tootallnate.websocket.drafts.Draft_75 +
LF - +Static variable in class org.java_websocket.drafts.Draft_75
The byte representing LF, or Line Feed, or \n -
LimitExedeedException - Exception in net.tootallnate.websocket.exeptions
 
LimitExedeedException() - -Constructor for exception net.tootallnate.websocket.exeptions.LimitExedeedException -
  -
LimitExedeedException(String) - -Constructor for exception net.tootallnate.websocket.exeptions.LimitExedeedException +
LimitExedeedException - Exception in org.java_websocket.exeptions
 
LimitExedeedException() - +Constructor for exception org.java_websocket.exeptions.LimitExedeedException
  -
LimitExedeedException(Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.LimitExedeedException -
  -
LimitExedeedException(String, Throwable) - -Constructor for exception net.tootallnate.websocket.exeptions.LimitExedeedException +
LimitExedeedException(String) - +Constructor for exception org.java_websocket.exeptions.LimitExedeedException
 
+

+M

+
+
messageReceiveTiming(Date, Date, WebSocketListener.MessageType, int) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
messageReceiveTiming(Date, Date, WebSocketListener.MessageType, int) - +Method in interface org.java_websocket.WebSocketListener +
Informs the Listener how long it took to receive a Message. +
messageSendTiming(Date, Date, WebSocketListener.MessageType, int) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
messageSendTiming(Date, Date, WebSocketListener.MessageType, int) - +Method in interface org.java_websocket.WebSocketListener +
Informs the Listener how long it took to send a Message. +
+

N

-
net.tootallnate.websocket - package net.tootallnate.websocket
 
net.tootallnate.websocket.drafts - package net.tootallnate.websocket.drafts
 
net.tootallnate.websocket.exeptions - package net.tootallnate.websocket.exeptions
 
NO_OPTIONS - -Static variable in class net.tootallnate.websocket.Base64 +
NEVERCONNECTED - +Static variable in interface org.java_websocket.framing.CloseFrame +
The connection had never been established +
NO_OPTIONS - +Static variable in class org.java_websocket.util.Base64
No options specified. +
NO_UTF8 - +Static variable in interface org.java_websocket.framing.CloseFrame +
1007 indicates that an endpoint is terminating the connection + because it has received data within a message that was not + consistent with the type of the message (e.g., non-UTF-8 [RFC3629] + data within a text message). +
NOCODE - +Static variable in interface org.java_websocket.framing.CloseFrame +
1005 is a reserved value and MUST NOT be set as a status code in a + Close control frame by an endpoint. +
NORMAL - +Static variable in interface org.java_websocket.framing.CloseFrame +
indicates a normal closure, meaning whatever purpose the + connection was established for has been fulfilled. +
NotSendableException - Exception in org.java_websocket.exeptions
 
NotSendableException() - +Constructor for exception org.java_websocket.exeptions.NotSendableException +
  +
NotSendableException(String) - +Constructor for exception org.java_websocket.exeptions.NotSendableException +
  +
NotSendableException(Throwable) - +Constructor for exception org.java_websocket.exeptions.NotSendableException +
  +
NotSendableException(String, Throwable) - +Constructor for exception org.java_websocket.exeptions.NotSendableException +
 

O

-
onClientClose(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketServer +
onClose(int, String, boolean) - +Method in class org.java_websocket.WebSocketClient
  -
onClientMessage(WebSocket, String) - -Method in class net.tootallnate.websocket.WebSocketServer +
onClose(WebSocket, int, String, boolean) - +Method in class org.java_websocket.WebSocketServer
  -
onClientOpen(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketServer +
onError(Exception) - +Method in class org.java_websocket.WebSocketClient
  -
onClose(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketAdapter +
onError(WebSocket, Exception) - +Method in class org.java_websocket.WebSocketServer
  -
onClose(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketClient -
Calls subclass' implementation of onClose. -
onClose() - -Method in class net.tootallnate.websocket.WebSocketClient -
  -
onClose(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketServer -
  -
onError(WebSocket, Exception) - -Method in class net.tootallnate.websocket.WebSocketAdapter +
onMessage(String) - +Method in class org.java_websocket.WebSocketClient
  -
onError(WebSocket, IOException) - -Method in class net.tootallnate.websocket.WebSocketClient -
Calls subclass' implementation of onIOError. -
onError(Exception) - -Method in class net.tootallnate.websocket.WebSocketClient -
  -
onError(WebSocket, Exception) - -Method in class net.tootallnate.websocket.WebSocketServer +
onMessage(byte[]) - +Method in class org.java_websocket.WebSocketClient
  -
onHandshakeRecievedAsClient(WebSocket, Handshakedata, Handshakedata) - -Method in class net.tootallnate.websocket.WebSocketAdapter +
onMessage(WebSocket, String) - +Method in class org.java_websocket.WebSocketServer
  -
onHandshakeRecievedAsServer(WebSocket, Draft, Handshakedata) - -Method in class net.tootallnate.websocket.WebSocketAdapter +
onMessage(WebSocket, byte[]) - +Method in class org.java_websocket.WebSocketServer
  -
onMessage(WebSocket, String) - -Method in class net.tootallnate.websocket.WebSocketAdapter +
onOpen(ServerHandshake) - +Method in class org.java_websocket.WebSocketClient
  -
onMessage(WebSocket, byte[]) - -Method in class net.tootallnate.websocket.WebSocketAdapter +
onOpen(WebSocket, ClientHandshake) - +Method in class org.java_websocket.WebSocketServer
  -
onMessage(WebSocket, String) - -Method in class net.tootallnate.websocket.WebSocketClient +
onWebsocketClose(WebSocket, int, String, boolean) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
onWebsocketClose(WebSocket, int, String, boolean) - +Method in class org.java_websocket.WebSocketClient +
Calls subclass' implementation of onClose. +
onWebsocketClose(WebSocket, int, String, boolean) - +Method in interface org.java_websocket.WebSocketListener +
Called after WebSocket#close is explicity called, or when the + other end of the WebSocket connection is closed. +
onWebsocketClose(WebSocket, int, String, boolean) - +Method in class org.java_websocket.WebSocketServer +
  +
onWebsocketError(WebSocket, Exception) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
onWebsocketError(WebSocket, Exception) - +Method in class org.java_websocket.WebSocketClient +
Calls subclass' implementation of onIOError. +
onWebsocketError(WebSocket, Exception) - +Method in interface org.java_websocket.WebSocketListener +
Called if an exception worth noting occurred. +
onWebsocketError(WebSocket, Exception) - +Method in class org.java_websocket.WebSocketServer +
  +
onWebsocketHandshakeReceivedAsClient(WebSocket, ClientHandshake, ServerHandshake) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything which will cause connections to be accepted. +
onWebsocketHandshakeReceivedAsClient(WebSocket, ClientHandshake, ServerHandshake) - +Method in interface org.java_websocket.WebSocketListener +
Called on the client side when the socket connection is first established, and the WebSocket + handshake response has been received. +
onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake) - +Method in interface org.java_websocket.WebSocketListener +
Called on the server side when the socket connection is first established, and the WebSocket + handshake has been received. +
onWebsocketHandshakeSentAsClient(WebSocket, ClientHandshake) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything which will cause the connections to always progress. +
onWebsocketHandshakeSentAsClient(WebSocket, ClientHandshake) - +Method in interface org.java_websocket.WebSocketListener +
Called on the client side when the socket connection is first established, and the WebSocket + handshake has just been sent. +
onWebsocketMessage(WebSocket, String) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
onWebsocketMessage(WebSocket, byte[]) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
onWebsocketMessage(WebSocket, String) - +Method in class org.java_websocket.WebSocketClient
Calls subclass' implementation of onMessage. -
onMessage(String) - -Method in class net.tootallnate.websocket.WebSocketClient -
  -
onMessage(WebSocket, String) - -Method in class net.tootallnate.websocket.WebSocketServer -
  -
onOpen(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketAdapter -
  -
onOpen(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketClient +
onWebsocketMessage(WebSocket, byte[]) - +Method in class org.java_websocket.WebSocketClient +
  +
onWebsocketMessage(WebSocket, String) - +Method in interface org.java_websocket.WebSocketListener +
Called when an entire text frame has been received. +
onWebsocketMessage(WebSocket, byte[]) - +Method in interface org.java_websocket.WebSocketListener +
Called when an entire binary frame has been received. +
onWebsocketMessage(WebSocket, String) - +Method in class org.java_websocket.WebSocketServer +
  +
onWebsocketMessage(WebSocket, byte[]) - +Method in class org.java_websocket.WebSocketServer +
  +
onWebsocketOpen(WebSocket, Handshakedata) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
onWebsocketOpen(WebSocket, Handshakedata) - +Method in class org.java_websocket.WebSocketClient
Calls subclass' implementation of onOpen. -
onOpen() - -Method in class net.tootallnate.websocket.WebSocketClient -
  -
onOpen(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketServer -
  -
onPing(WebSocket, Framedata) - -Method in class net.tootallnate.websocket.WebSocketAdapter -
  -
onPong(WebSocket, Framedata) - -Method in class net.tootallnate.websocket.WebSocketAdapter -
  -
onWriteDemand(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketClient -
  -
onWriteDemand(WebSocket) - -Method in class net.tootallnate.websocket.WebSocketServer -
  -
ORDERED - -Static variable in class net.tootallnate.websocket.Base64 +
onWebsocketOpen(WebSocket, Handshakedata) - +Method in interface org.java_websocket.WebSocketListener +
Called after onHandshakeReceived returns true. +
onWebsocketOpen(WebSocket, Handshakedata) - +Method in class org.java_websocket.WebSocketServer +
  +
onWebsocketPing(WebSocket, Framedata) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation will send a pong in response to the received ping. +
onWebsocketPing(WebSocket, Framedata) - +Method in interface org.java_websocket.WebSocketListener +
Called a ping frame has been received. +
onWebsocketPong(WebSocket, Framedata) - +Method in class org.java_websocket.WebSocketAdapter +
This default implementation does not do anything. +
onWebsocketPong(WebSocket, Framedata) - +Method in interface org.java_websocket.WebSocketListener +
Called when a pong frame is received. +
onWriteDemand(WebSocket) - +Method in class org.java_websocket.WebSocketClient +
  +
onWriteDemand(WebSocket) - +Method in interface org.java_websocket.WebSocketListener +
This method is used to inform the selector thread that there is data queued to be written to the socket. +
onWriteDemand(WebSocket) - +Method in class org.java_websocket.WebSocketServer +
  +
optcode - +Variable in class org.java_websocket.framing.FramedataImpl1 +
  +
ORDERED - +Static variable in class org.java_websocket.util.Base64
Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html. -
+
org.java_websocket - package org.java_websocket
 
org.java_websocket.drafts - package org.java_websocket.drafts
 
org.java_websocket.exeptions - package org.java_websocket.exeptions
 
org.java_websocket.framing - package org.java_websocket.framing
 
org.java_websocket.handshake - package org.java_websocket.handshake
 
org.java_websocket.util - package org.java_websocket.util
 

P

-
postProcessHandshakeRequestAsClient(HandshakeBuilder) - -Method in class net.tootallnate.websocket.Draft +
POLICY_VALIDATION - +Static variable in interface org.java_websocket.framing.CloseFrame +
1008 indicates that an endpoint is terminating the connection + because it has received a message that violates its policy. +
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft
  -
postProcessHandshakeRequestAsClient(HandshakeBuilder) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft_10
  -
postProcessHandshakeRequestAsClient(HandshakeBuilder) - -Method in class net.tootallnate.websocket.drafts.Draft_17 +
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft_17
  -
postProcessHandshakeRequestAsClient(HandshakeBuilder) - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft_75
  -
postProcessHandshakeRequestAsClient(HandshakeBuilder) - -Method in class net.tootallnate.websocket.drafts.Draft_76 +
postProcessHandshakeRequestAsClient(ClientHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft_76
  -
postProcessHandshakeResponseAsServer(Handshakedata, HandshakeBuilder) - -Method in class net.tootallnate.websocket.Draft +
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft
  -
postProcessHandshakeResponseAsServer(Handshakedata, HandshakeBuilder) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft_10
  -
postProcessHandshakeResponseAsServer(Handshakedata, HandshakeBuilder) - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft_75
  -
postProcessHandshakeResponseAsServer(Handshakedata, HandshakeBuilder) - -Method in class net.tootallnate.websocket.drafts.Draft_76 +
postProcessHandshakeResponseAsServer(ClientHandshake, ServerHandshakeBuilder) - +Method in class org.java_websocket.drafts.Draft_76
  -
put(String, String) - -Method in interface net.tootallnate.websocket.HandshakeBuilder +
PROTOCOL_ERROR - +Static variable in interface org.java_websocket.framing.CloseFrame +
1002 indicates that an endpoint is terminating the connection due + to a protocol error. +
put(String, String) - +Method in interface org.java_websocket.handshake.HandshakeBuilder
  -
put(String, String) - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
put(String, String) - +Method in class org.java_websocket.handshake.HandshakedataImpl1
 

R

-
read() - -Method in class net.tootallnate.websocket.Base64.InputStream +
read() - +Method in class org.java_websocket.util.Base64.InputStream
Reads enough of the input stream to convert to/from Base64 and returns the next byte. -
read(byte[], int, int) - -Method in class net.tootallnate.websocket.Base64.InputStream -
Calls Base64.InputStream.read() repeatedly until the end of stream +
read(byte[], int, int) - +Method in class org.java_websocket.util.Base64.InputStream +
Calls Base64.InputStream.read() repeatedly until the end of stream is reached or len bytes are read. -
readLine(ByteBuffer) - -Static method in class net.tootallnate.websocket.Draft +
readingState - +Variable in class org.java_websocket.drafts.Draft_75
  -
readStringLine(ByteBuffer) - -Static method in class net.tootallnate.websocket.Draft +
readLine(ByteBuffer) - +Static method in class org.java_websocket.drafts.Draft
  -
readVersion(Handshakedata) - -Static method in class net.tootallnate.websocket.drafts.Draft_10 +
readStringLine(ByteBuffer) - +Static method in class org.java_websocket.drafts.Draft
  -
reset() - -Method in class net.tootallnate.websocket.Draft +
readVersion(Handshakedata) - +Static method in class org.java_websocket.drafts.Draft_10
  -
reset() - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
READY_STATE_CLOSED - +Static variable in class org.java_websocket.WebSocket
  -
reset() - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
READY_STATE_CLOSING - +Static variable in class org.java_websocket.WebSocket
  -
resumeEncoding() - -Method in class net.tootallnate.websocket.Base64.OutputStream -
Resumes encoding of the stream. -
role - -Variable in class net.tootallnate.websocket.Draft +
READY_STATE_CONNECTING - +Static variable in class org.java_websocket.WebSocket +
  +
READY_STATE_OPEN - +Static variable in class org.java_websocket.WebSocket +
  +
readyframes - +Variable in class org.java_websocket.drafts.Draft_75 +
  +
REFUSE - +Static variable in interface org.java_websocket.framing.CloseFrame +
1003 indicates that an endpoint is terminating the connection + because it has received a type of data it cannot accept (e.g. +
reset() - +Method in class org.java_websocket.drafts.Draft +
  +
reset() - +Method in class org.java_websocket.drafts.Draft_10
  -
run() - -Method in class net.tootallnate.websocket.WebSocketClient +
reset() - +Method in class org.java_websocket.drafts.Draft_75
  -
run() - -Method in class net.tootallnate.websocket.WebSocketServer +
resumeEncoding() - +Method in class org.java_websocket.util.Base64.OutputStream +
Resumes encoding of the stream. +
role - +Variable in class org.java_websocket.drafts.Draft +
In some cases the handshake will be parsed different depending on whether +
run() - +Method in class org.java_websocket.WebSocketClient +
  +
run() - +Method in class org.java_websocket.WebSocketServer
 

S

-
send(String) - -Method in class net.tootallnate.websocket.WebSocket +
send(String) - +Method in class org.java_websocket.WebSocket +
Send Text data to the other end. +
send(byte[]) - +Method in class org.java_websocket.WebSocket +
Send Binary data (plain bytes) to the other end. +
send(String) - +Method in class org.java_websocket.WebSocketClient +
Sends text to the connected WebSocket server. +
send(byte[]) - +Method in class org.java_websocket.WebSocketClient +
Sends data to the connected WebSocket server. +
sendFrame(Framedata) - +Method in class org.java_websocket.WebSocket
  -
send(byte[]) - -Method in class net.tootallnate.websocket.WebSocket +
ServerHandshake - Interface in org.java_websocket.handshake
 
ServerHandshakeBuilder - Interface in org.java_websocket.handshake
 
setAddress(InetSocketAddress) - +Method in class org.java_websocket.WebSocketServer +
Sets the address (host:port) that this WebSocketServer should listen on. +
setContent(byte[]) - +Method in interface org.java_websocket.handshake.HandshakeBuilder
  -
send(String) - -Method in class net.tootallnate.websocket.WebSocketClient -
Sends text to the connected WebSocket server. -
sendFrame(Framedata) - -Method in class net.tootallnate.websocket.WebSocket +
setContent(byte[]) - +Method in class org.java_websocket.handshake.HandshakedataImpl1 +
  +
setFin(boolean) - +Method in interface org.java_websocket.framing.FrameBuilder
  -
sendToAll(String) - -Method in class net.tootallnate.websocket.WebSocketServer -
Sends text to all currently connected WebSocket clients. -
sendToAllExcept(WebSocket, String) - -Method in class net.tootallnate.websocket.WebSocketServer -
Sends text to all currently connected WebSocket clients, - except for the specified connection. -
sendToAllExcept(Set<WebSocket>, String) - -Method in class net.tootallnate.websocket.WebSocketServer -
Sends text to all currently connected WebSocket clients, - except for those found in the Set connections. -
setAddress(InetSocketAddress) - -Method in class net.tootallnate.websocket.WebSocketServer -
Sets the port that this WebSocketServer should listen on. -
setContent(byte[]) - -Method in interface net.tootallnate.websocket.HandshakeBuilder +
setFin(boolean) - +Method in class org.java_websocket.framing.FramedataImpl1
  -
setContent(byte[]) - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
setHttpStatus(short) - +Method in class org.java_websocket.handshake.HandshakeImpl1Server
  -
setFin(boolean) - -Method in interface net.tootallnate.websocket.FrameBuilder +
setHttpStatus(short) - +Method in interface org.java_websocket.handshake.ServerHandshakeBuilder
  -
setFin(boolean) - -Method in class net.tootallnate.websocket.FramedataImpl1 +
setHttpStatusMessage(String) - +Method in class org.java_websocket.handshake.HandshakeImpl1Server
  -
setHttpStatusMessage(String) - -Method in interface net.tootallnate.websocket.HandshakeBuilder +
setHttpStatusMessage(String) - +Method in interface org.java_websocket.handshake.ServerHandshakeBuilder
  -
setHttpStatusMessage(String) - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
setOptcode(Framedata.Opcode) - +Method in interface org.java_websocket.framing.FrameBuilder
  -
setOptcode(Framedata.Opcode) - -Method in interface net.tootallnate.websocket.FrameBuilder +
setOptcode(Framedata.Opcode) - +Method in class org.java_websocket.framing.FramedataImpl1
  -
setOptcode(Framedata.Opcode) - -Method in class net.tootallnate.websocket.FramedataImpl1 +
setParseMode(WebSocket.Role) - +Method in class org.java_websocket.drafts.Draft
  -
setParseMode(WebSocket.Role) - -Method in class net.tootallnate.websocket.Draft +
setPayload(byte[]) - +Method in class org.java_websocket.framing.CloseFrameBuilder
  -
setPayload(byte[]) - -Method in interface net.tootallnate.websocket.FrameBuilder +
setPayload(byte[]) - +Method in interface org.java_websocket.framing.FrameBuilder
  -
setPayload(byte[]) - -Method in class net.tootallnate.websocket.FramedataImpl1 +
setPayload(byte[]) - +Method in class org.java_websocket.framing.FramedataImpl1
  -
setResourceDescriptor(String) - -Method in interface net.tootallnate.websocket.HandshakeBuilder +
setResourceDescriptor(String) - +Method in interface org.java_websocket.handshake.ClientHandshakeBuilder
  -
setResourceDescriptor(String) - -Method in class net.tootallnate.websocket.HandshakedataImpl1 +
setResourceDescriptor(String) - +Method in class org.java_websocket.handshake.HandshakeImpl1Client
  -
setTransferemasked(boolean) - -Method in interface net.tootallnate.websocket.FrameBuilder +
setTransferemasked(boolean) - +Method in interface org.java_websocket.framing.FrameBuilder
  -
setTransferemasked(boolean) - -Method in class net.tootallnate.websocket.FramedataImpl1 +
setTransferemasked(boolean) - +Method in class org.java_websocket.framing.FramedataImpl1
  -
start() - -Method in class net.tootallnate.websocket.WebSocketServer +
start() - +Method in class org.java_websocket.WebSocketServer
Starts the server thread that binds to the currently set port number and listeners for WebSocket connection requests. -
START_OF_FRAME - -Static variable in class net.tootallnate.websocket.drafts.Draft_75 +
START_OF_FRAME - +Static variable in class org.java_websocket.drafts.Draft_75
The byte representing the beginning of a WebSocket text frame. -
startHandshake(HandshakeBuilder) - -Method in class net.tootallnate.websocket.WebSocket -
  -
stingAscii(byte[]) - -Static method in class net.tootallnate.websocket.Charsetfunctions +
startHandshake(ClientHandshakeBuilder) - +Method in class org.java_websocket.WebSocket
  -
stingAscii(byte[], int, int) - -Static method in class net.tootallnate.websocket.Charsetfunctions -
  -
stingUtf8(byte[]) - -Static method in class net.tootallnate.websocket.Charsetfunctions -
  -
stop() - -Method in class net.tootallnate.websocket.WebSocketServer +
stop() - +Method in class org.java_websocket.WebSocketServer
Closes all connected clients sockets, then closes the underlying ServerSocketChannel, effectively killing the server socket thread and freeing the port the server was bound to. -
suspendEncoding() - -Method in class net.tootallnate.websocket.Base64.OutputStream +
stringAscii(byte[]) - +Static method in class org.java_websocket.util.Charsetfunctions +
  +
stringAscii(byte[], int, int) - +Static method in class org.java_websocket.util.Charsetfunctions +
  +
stringUtf8(byte[]) - +Static method in class org.java_websocket.util.Charsetfunctions +
  +
stringUtf8(byte[], int, int) - +Static method in class org.java_websocket.util.Charsetfunctions +
  +
suspendEncoding() - +Method in class org.java_websocket.util.Base64.OutputStream
Suspends encoding of the stream.

T

-
toString() - -Method in class net.tootallnate.websocket.FramedataImpl1 +
TOOBIG - +Static variable in interface org.java_websocket.framing.CloseFrame +
1009 indicates that an endpoint is terminating the connection + because it has received a message which is too big for it to + process. +
toString() - +Method in class org.java_websocket.framing.CloseFrameBuilder +
  +
toString() - +Method in class org.java_websocket.framing.FramedataImpl1 +
  +
toString() - +Method in class org.java_websocket.WebSocket
  -
toString() - -Method in class net.tootallnate.websocket.WebSocket +
transferemasked - +Variable in class org.java_websocket.framing.FramedataImpl1
  -
translateFrame(ByteBuffer) - -Method in class net.tootallnate.websocket.Draft +
translateFrame(ByteBuffer) - +Method in class org.java_websocket.drafts.Draft
  -
translateFrame(ByteBuffer) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
translateFrame(ByteBuffer) - +Method in class org.java_websocket.drafts.Draft_10
  -
translateFrame(ByteBuffer) - -Method in class net.tootallnate.websocket.drafts.Draft_75 +
translateFrame(ByteBuffer) - +Method in class org.java_websocket.drafts.Draft_75
  -
translateHandshake(ByteBuffer) - -Method in class net.tootallnate.websocket.Draft +
translateFrame(ByteBuffer) - +Method in class org.java_websocket.drafts.Draft_76
  -
translateHandshake(ByteBuffer) - -Method in class net.tootallnate.websocket.drafts.Draft_76 +
translateHandshake(ByteBuffer) - +Method in class org.java_websocket.drafts.Draft
  -
translateHandshakeHttp(ByteBuffer) - -Static method in class net.tootallnate.websocket.Draft +
translateHandshake(ByteBuffer) - +Method in class org.java_websocket.drafts.Draft_76
  -
translateSingleFrame(ByteBuffer) - -Method in class net.tootallnate.websocket.drafts.Draft_10 +
translateHandshakeHttp(ByteBuffer, WebSocket.Role) - +Static method in class org.java_websocket.drafts.Draft +
  +
translateRegularFrame(ByteBuffer) - +Method in class org.java_websocket.drafts.Draft_75 +
  +
translateSingleFrame(ByteBuffer) - +Method in class org.java_websocket.drafts.Draft_10
 

U

-
URL_SAFE - -Static variable in class net.tootallnate.websocket.Base64 +
URL_SAFE - +Static variable in class org.java_websocket.util.Base64
Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html. -
utf8Bytes(String) - -Static method in class net.tootallnate.websocket.Charsetfunctions +
utf8Bytes(String) - +Static method in class org.java_websocket.util.Charsetfunctions
 

V

-
valueOf(String) - -Static method in enum net.tootallnate.websocket.Draft.HandshakeState +
valueOf(String) - +Static method in enum org.java_websocket.drafts.Draft.CloseHandshakeType +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum org.java_websocket.drafts.Draft.HandshakeState
Returns the enum constant of this type with the specified name. -
valueOf(String) - -Static method in enum net.tootallnate.websocket.Framedata.Opcode +
valueOf(String) - +Static method in enum org.java_websocket.framing.Framedata.Opcode
Returns the enum constant of this type with the specified name. -
valueOf(String) - -Static method in enum net.tootallnate.websocket.WebSocket.Role +
valueOf(String) - +Static method in enum org.java_websocket.WebSocket.Role
Returns the enum constant of this type with the specified name. -
values() - -Static method in enum net.tootallnate.websocket.Draft.HandshakeState +
valueOf(String) - +Static method in enum org.java_websocket.WebSocketListener.MessageType +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum org.java_websocket.drafts.Draft.CloseHandshakeType +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum org.java_websocket.drafts.Draft.HandshakeState +
Returns an array containing the constants of this enum type, in +the order they are declared. +
values() - +Static method in enum org.java_websocket.framing.Framedata.Opcode
Returns an array containing the constants of this enum type, in the order they are declared. -
values() - -Static method in enum net.tootallnate.websocket.Framedata.Opcode +
values() - +Static method in enum org.java_websocket.WebSocket.Role
Returns an array containing the constants of this enum type, in the order they are declared. -
values() - -Static method in enum net.tootallnate.websocket.WebSocket.Role +
values() - +Static method in enum org.java_websocket.WebSocketListener.MessageType
Returns an array containing the constants of this enum type, in the order they are declared.
@@ -914,46 +1209,45 @@

W

-
WebSocket - Class in net.tootallnate.websocket
Represents one end (client or server) of a single WebSocket connection.
WebSocket(WebSocketListener, Draft, SocketChannel) - -Constructor for class net.tootallnate.websocket.WebSocket -
Used in WebSocketServer and WebSocketClient. -
WebSocket(WebSocketListener, List<Draft>, SocketChannel) - -Constructor for class net.tootallnate.websocket.WebSocket +
WebSocket - Class in org.java_websocket
Represents one end (client or server) of a single WebSocket connection.
WebSocket(WebSocketListener, Draft, SocketChannel) - +Constructor for class org.java_websocket.WebSocket +
Used in WebSocketServer and WebSocketClient. +
WebSocket(WebSocketListener, List<Draft>, SocketChannel) - +Constructor for class org.java_websocket.WebSocket
  -
WebSocket.Role - Enum in net.tootallnate.websocket
 
WebSocketAdapter - Class in net.tootallnate.websocket
 
WebSocketAdapter() - -Constructor for class net.tootallnate.websocket.WebSocketAdapter +
WebSocket.Role - Enum in org.java_websocket
 
WebSocketAdapter - Class in org.java_websocket
 
WebSocketAdapter() - +Constructor for class org.java_websocket.WebSocketAdapter
  -
WebSocketClient - Class in net.tootallnate.websocket
The WebSocketClient is an abstract class that expects a valid - "ws://" URI to connect to.
WebSocketClient(URI) - -Constructor for class net.tootallnate.websocket.WebSocketClient +
WebSocketClient - Class in org.java_websocket
The WebSocketClient is an abstract class that expects a valid + "ws://" URI to connect to.
WebSocketClient(URI) - +Constructor for class org.java_websocket.WebSocketClient
  -
WebSocketClient(URI, Draft) - -Constructor for class net.tootallnate.websocket.WebSocketClient +
WebSocketClient(URI, Draft) - +Constructor for class org.java_websocket.WebSocketClient
Constructs a WebSocketClient instance and sets it to the connect to the specified URI. -
WebSocketServer - Class in net.tootallnate.websocket
WebSocketServer is an abstract class that only takes care of the - HTTP handshake portion of WebSockets.
WebSocketServer() - -Constructor for class net.tootallnate.websocket.WebSocketServer +
WebSocketListener - Interface in org.java_websocket
Implemented by WebSocketClient and WebSocketServer.
WebSocketListener.MessageType - Enum in org.java_websocket
 
WebSocketServer - Class in org.java_websocket
WebSocketServer is an abstract class that only takes care of the + HTTP handshake portion of WebSockets.
WebSocketServer() - +Constructor for class org.java_websocket.WebSocketServer
Nullary constructor. -
WebSocketServer(InetSocketAddress) - -Constructor for class net.tootallnate.websocket.WebSocketServer -
Creates a WebSocketServer that will attempt to listen on port - port. -
WebSocketServer(InetSocketAddress, Draft) - -Constructor for class net.tootallnate.websocket.WebSocketServer -
Creates a WebSocketServer that will attempt to listen on port port, +
WebSocketServer(InetSocketAddress) - +Constructor for class org.java_websocket.WebSocketServer +
Creates a WebSocketServer that will attempt to bind/listen on the given address. +
WebSocketServer(InetSocketAddress, Draft) - +Constructor for class org.java_websocket.WebSocketServer +
Creates a WebSocketServer that will attempt to bind/listen on the given address, and comply with Draft version draft. -
write(int) - -Method in class net.tootallnate.websocket.Base64.OutputStream +
write(int) - +Method in class org.java_websocket.util.Base64.OutputStream
Writes the byte to the output stream after converting to/from Base64 notation. -
write(byte[], int, int) - -Method in class net.tootallnate.websocket.Base64.OutputStream -
Calls Base64.OutputStream.write(int) repeatedly until len +
write(byte[], int, int) - +Method in class org.java_websocket.util.Base64.OutputStream +
Calls Base64.OutputStream.write(int) repeatedly until len bytes are written.
-A B C D E F G H I K L N O P R S T U V W +A B C D E F G H I K L M N O P R S T U V W diff --git a/doc/index.html b/doc/index.html index 836934b04..612b8a651 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) diff --git a/doc/net/tootallnate/websocket/Draft.html b/doc/net/tootallnate/websocket/Draft.html deleted file mode 100644 index 16aec73ff..000000000 --- a/doc/net/tootallnate/websocket/Draft.html +++ /dev/null @@ -1,669 +0,0 @@ - - - - - - -Draft - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket -
-Class Draft

-
-java.lang.Object
-  extended by net.tootallnate.websocket.Draft
-
-
-
Direct Known Subclasses:
Draft_10, Draft_75
-
-
-
-
public abstract class Draft
extends java.lang.Object
- - -

-

- -

- - - - - - - - - - - -
-Nested Class Summary
-static classDraft.HandshakeState - -
-           
-  - - - - - - - - - - -
-Field Summary
-protected  WebSocket.Rolerole - -
-           
-  - - - - - - - - - - -
-Constructor Summary
Draft() - -
-           
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
-abstract  Draft.HandshakeStateacceptHandshakeAsClient(Handshakedata request, - Handshakedata response) - -
-           
-abstract  Draft.HandshakeStateacceptHandshakeAsServer(Handshakedata handshakedata) - -
-           
-protected  booleanbasicAccept(Handshakedata handshakedata) - -
-           
- intcheckAlloc(int bytecount) - -
-           
-abstract  java.nio.ByteBuffercreateBinaryFrame(Framedata framedata) - -
-           
-abstract  java.util.List<Framedata>createFrames(byte[] binary, - boolean mask) - -
-           
-abstract  java.util.List<Framedata>createFrames(java.lang.String text, - boolean mask) - -
-           
- java.util.List<java.nio.ByteBuffer>createHandshake(Handshakedata handshakedata, - WebSocket.Role ownrole) - -
-           
- java.util.List<java.nio.ByteBuffer>createHandshake(Handshakedata handshakedata, - WebSocket.Role ownrole, - boolean withcontent) - -
-           
-abstract  HandshakeBuilderpostProcessHandshakeRequestAsClient(HandshakeBuilder request) - -
-           
-abstract  HandshakeBuilderpostProcessHandshakeResponseAsServer(Handshakedata request, - HandshakeBuilder response) - -
-           
-static java.nio.ByteBufferreadLine(java.nio.ByteBuffer buf) - -
-           
-static java.lang.StringreadStringLine(java.nio.ByteBuffer buf) - -
-           
-abstract  voidreset() - -
-           
- voidsetParseMode(WebSocket.Role role) - -
-           
-abstract  java.util.List<Framedata>translateFrame(java.nio.ByteBuffer buffer) - -
-           
- HandshakedatatranslateHandshake(java.nio.ByteBuffer buf) - -
-           
-static HandshakeBuildertranslateHandshakeHttp(java.nio.ByteBuffer buf) - -
-           
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Field Detail
- -

-role

-
-protected WebSocket.Role role
-
-
-
-
- - - - - - - - -
-Constructor Detail
- -

-Draft

-
-public Draft()
-
-
- - - - - - - - -
-Method Detail
- -

-readLine

-
-public static java.nio.ByteBuffer readLine(java.nio.ByteBuffer buf)
-
-
-
-
-
-
- -

-readStringLine

-
-public static java.lang.String readStringLine(java.nio.ByteBuffer buf)
-
-
-
-
-
-
- -

-translateHandshakeHttp

-
-public static HandshakeBuilder translateHandshakeHttp(java.nio.ByteBuffer buf)
-                                               throws InvalidHandshakeException
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-acceptHandshakeAsClient

-
-public abstract Draft.HandshakeState acceptHandshakeAsClient(Handshakedata request,
-                                                             Handshakedata response)
-                                                      throws InvalidHandshakeException
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-acceptHandshakeAsServer

-
-public abstract Draft.HandshakeState acceptHandshakeAsServer(Handshakedata handshakedata)
-                                                      throws InvalidHandshakeException
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-basicAccept

-
-protected boolean basicAccept(Handshakedata handshakedata)
-
-
-
-
-
-
- -

-createBinaryFrame

-
-public abstract java.nio.ByteBuffer createBinaryFrame(Framedata framedata)
-
-
-
-
-
-
- -

-createFrames

-
-public abstract java.util.List<Framedata> createFrames(byte[] binary,
-                                                       boolean mask)
-
-
-
-
-
-
- -

-createFrames

-
-public abstract java.util.List<Framedata> createFrames(java.lang.String text,
-                                                       boolean mask)
-
-
-
-
-
-
- -

-reset

-
-public abstract void reset()
-
-
-
-
-
-
- -

-createHandshake

-
-public java.util.List<java.nio.ByteBuffer> createHandshake(Handshakedata handshakedata,
-                                                           WebSocket.Role ownrole)
-
-
-
-
-
-
- -

-createHandshake

-
-public java.util.List<java.nio.ByteBuffer> createHandshake(Handshakedata handshakedata,
-                                                           WebSocket.Role ownrole,
-                                                           boolean withcontent)
-
-
-
-
-
-
- -

-postProcessHandshakeRequestAsClient

-
-public abstract HandshakeBuilder postProcessHandshakeRequestAsClient(HandshakeBuilder request)
-                                                              throws InvalidHandshakeException
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-postProcessHandshakeResponseAsServer

-
-public abstract HandshakeBuilder postProcessHandshakeResponseAsServer(Handshakedata request,
-                                                                      HandshakeBuilder response)
-                                                               throws InvalidHandshakeException
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-translateFrame

-
-public abstract java.util.List<Framedata> translateFrame(java.nio.ByteBuffer buffer)
-                                                  throws InvalidDataException
-
-
- -
Throws: -
InvalidDataException
-
-
-
- -

-translateHandshake

-
-public Handshakedata translateHandshake(java.nio.ByteBuffer buf)
-                                 throws InvalidHandshakeException
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-checkAlloc

-
-public int checkAlloc(int bytecount)
-               throws LimitExedeedException,
-                      InvalidDataException
-
-
- -
Throws: -
LimitExedeedException -
InvalidDataException
-
-
-
- -

-setParseMode

-
-public void setParseMode(WebSocket.Role role)
-
-
-
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/FramedataImpl1.html b/doc/net/tootallnate/websocket/FramedataImpl1.html deleted file mode 100644 index 7956d2bb0..000000000 --- a/doc/net/tootallnate/websocket/FramedataImpl1.html +++ /dev/null @@ -1,504 +0,0 @@ - - - - - - -FramedataImpl1 - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket -
-Class FramedataImpl1

-
-java.lang.Object
-  extended by net.tootallnate.websocket.FramedataImpl1
-
-
-
All Implemented Interfaces:
FrameBuilder, Framedata
-
-
-
-
public class FramedataImpl1
extends java.lang.Object
implements FrameBuilder
- - -

-

- -

- - - - - - - -
-Nested Class Summary
-  - - - - - - - -
Nested classes/interfaces inherited from interface net.tootallnate.websocket.Framedata
Framedata.Opcode
-  - - - - - - - - - - - - - - - - - -
-Constructor Summary
FramedataImpl1() - -
-           
FramedataImpl1(Framedata.Opcode op) - -
-           
FramedataImpl1(Framedata f) - -
-           
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- voidappend(Framedata nextframe) - -
-           
- Framedata.OpcodegetOpcode() - -
-           
- byte[]getPayloadData() - -
-           
- booleangetTransfereMasked() - -
-           
- booleanisFin() - -
-           
- voidsetFin(boolean fin) - -
-           
- voidsetOptcode(Framedata.Opcode optcode) - -
-           
- voidsetPayload(byte[] payload) - -
-           
- voidsetTransferemasked(boolean transferemasked) - -
-           
- java.lang.StringtoString() - -
-           
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-FramedataImpl1

-
-public FramedataImpl1()
-
-
-
- -

-FramedataImpl1

-
-public FramedataImpl1(Framedata.Opcode op)
-
-
-
- -

-FramedataImpl1

-
-public FramedataImpl1(Framedata f)
-
-
- - - - - - - - -
-Method Detail
- -

-isFin

-
-public boolean isFin()
-
-
-
Specified by:
isFin in interface Framedata
-
-
-
-
-
-
- -

-getOpcode

-
-public Framedata.Opcode getOpcode()
-
-
-
Specified by:
getOpcode in interface Framedata
-
-
-
-
-
-
- -

-getTransfereMasked

-
-public boolean getTransfereMasked()
-
-
-
Specified by:
getTransfereMasked in interface Framedata
-
-
-
-
-
-
- -

-getPayloadData

-
-public byte[] getPayloadData()
-
-
-
Specified by:
getPayloadData in interface Framedata
-
-
-
-
-
-
- -

-setFin

-
-public void setFin(boolean fin)
-
-
-
Specified by:
setFin in interface FrameBuilder
-
-
-
-
-
-
- -

-setOptcode

-
-public void setOptcode(Framedata.Opcode optcode)
-
-
-
Specified by:
setOptcode in interface FrameBuilder
-
-
-
-
-
-
- -

-setPayload

-
-public void setPayload(byte[] payload)
-
-
-
Specified by:
setPayload in interface FrameBuilder
-
-
-
-
-
-
- -

-setTransferemasked

-
-public void setTransferemasked(boolean transferemasked)
-
-
-
Specified by:
setTransferemasked in interface FrameBuilder
-
-
-
-
-
-
- -

-append

-
-public void append(Framedata nextframe)
-            throws InvalidFrameException
-
-
-
Specified by:
append in interface Framedata
-
-
- -
Throws: -
InvalidFrameException
-
-
-
- -

-toString

-
-public java.lang.String toString()
-
-
-
Overrides:
toString in class java.lang.Object
-
-
-
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/WebSocket.html b/doc/net/tootallnate/websocket/WebSocket.html deleted file mode 100644 index a7b25d7b4..000000000 --- a/doc/net/tootallnate/websocket/WebSocket.html +++ /dev/null @@ -1,656 +0,0 @@ - - - - - - -WebSocket - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket -
-Class WebSocket

-
-java.lang.Object
-  extended by net.tootallnate.websocket.WebSocket
-
-
-
-
public final class WebSocket
extends java.lang.Object
- - -

-Represents one end (client or server) of a single WebSocket connection. - Takes care of the "handshake" phase, then allows for easy sending of - text frames, and recieving frames through an event-based model. - - This is an inner class, used by WebSocketClient and WebSocketServer, and should never need to be instantiated directly - by your code. However, instances are exposed in WebSocketServer through the onClientOpen, onClientClose, - onClientMessage callbacks. -

- -

-

-
Author:
-
Nathan Rajlich
-
-
- -

- - - - - - - - - - - -
-Nested Class Summary
-static classWebSocket.Role - -
-           
-  - - - - - - - - - - - - - - - - - - -
-Field Summary
-static booleanDEBUG - -
-           
-static intDEFAULT_PORT - -
-          The default port of WebSockets, as defined in the spec.
- java.util.List<Draft>known_drafts - -
-           
-  - - - - - - - - - - - - - -
-Constructor Summary
WebSocket(net.tootallnate.websocket.WebSocketListener listener, - Draft draft, - java.nio.channels.SocketChannel sockchannel) - -
-          Used in WebSocketServer and WebSocketClient.
WebSocket(net.tootallnate.websocket.WebSocketListener listener, - java.util.List<Draft> drafts, - java.nio.channels.SocketChannel sockchannel) - -
-           
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- voidabort() - -
-           
- voidabort(java.lang.String problemmessage) - -
-           
- voidclose() - -
-          Closes the underlying SocketChannel, and calls the listener's onClose - event handler.
- java.net.InetSocketAddressgetLocalSocketAddress() - -
-           
- java.net.InetSocketAddressgetRemoteSocketAddress() - -
-           
- voidhandleRead() - -
-          Should be called when a Selector has a key that is writable for this - WebSocket's SocketChannel connection.
- voidhandleWrite() - -
-           
- Draft.HandshakeStateisFlashEdgeCase(java.nio.ByteBuffer request) - -
-           
- voidsend(byte[] bytes) - -
-           
- voidsend(java.lang.String text) - -
-           
- voidsendFrame(Framedata framedata) - -
-           
- voidstartHandshake(HandshakeBuilder handshakedata) - -
-           
- java.lang.StringtoString() - -
-           
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-  -

- - - - - - - - -
-Field Detail
- -

-DEFAULT_PORT

-
-public static final int DEFAULT_PORT
-
-
The default port of WebSockets, as defined in the spec. If the nullary - constructor is used, DEFAULT_PORT will be the port the WebSocketServer - is binded to. Note that ports under 1024 usually require root permissions. -

-

-
See Also:
Constant Field Values
-
-
- -

-DEBUG

-
-public static boolean DEBUG
-
-
-
-
-
- -

-known_drafts

-
-public java.util.List<Draft> known_drafts
-
-
-
-
- - - - - - - - -
-Constructor Detail
- -

-WebSocket

-
-public WebSocket(net.tootallnate.websocket.WebSocketListener listener,
-                 Draft draft,
-                 java.nio.channels.SocketChannel sockchannel)
-
-
Used in WebSocketServer and WebSocketClient. -

-

-
Parameters:
socketChannel - The SocketChannel instance to read and - write to. The channel should already be registered - with a Selector before construction of this object.
listener - The WebSocketListener to notify of events when - they occur.
-
-
- -

-WebSocket

-
-public WebSocket(net.tootallnate.websocket.WebSocketListener listener,
-                 java.util.List<Draft> drafts,
-                 java.nio.channels.SocketChannel sockchannel)
-
-
- - - - - - - - -
-Method Detail
- -

-handleRead

-
-public void handleRead()
-                throws java.lang.InterruptedException,
-                       java.io.IOException
-
-
Should be called when a Selector has a key that is writable for this - WebSocket's SocketChannel connection. -

-

- -
Throws: -
java.io.IOException - When socket related I/O errors occur. -
java.lang.InterruptedException
-
-
-
- -

-abort

-
-public void abort()
-
-
-
-
-
-
- -

-abort

-
-public void abort(java.lang.String problemmessage)
-
-
-
-
-
-
- -

-close

-
-public void close()
-
-
Closes the underlying SocketChannel, and calls the listener's onClose - event handler. -

-

-
-
-
-
- -

-send

-
-public void send(java.lang.String text)
-          throws java.lang.IllegalArgumentException,
-                 java.nio.channels.NotYetConnectedException,
-                 java.lang.InterruptedException
-
-
- -
Throws: -
java.io.IOException -
java.lang.InterruptedException -
java.lang.IllegalArgumentException -
java.nio.channels.NotYetConnectedException
-
-
-
- -

-send

-
-public void send(byte[] bytes)
-          throws java.lang.IllegalArgumentException,
-                 java.nio.channels.NotYetConnectedException,
-                 java.lang.InterruptedException
-
-
- -
Throws: -
java.lang.IllegalArgumentException -
java.nio.channels.NotYetConnectedException -
java.lang.InterruptedException
-
-
-
- -

-sendFrame

-
-public void sendFrame(Framedata framedata)
-               throws java.lang.InterruptedException
-
-
- -
Throws: -
java.lang.InterruptedException
-
-
-
- -

-handleWrite

-
-public void handleWrite()
-                 throws java.io.IOException
-
-
- -
Throws: -
java.io.IOException
-
-
-
- -

-isFlashEdgeCase

-
-public Draft.HandshakeState isFlashEdgeCase(java.nio.ByteBuffer request)
-
-
-
-
-
-
- -

-startHandshake

-
-public void startHandshake(HandshakeBuilder handshakedata)
-                    throws InvalidHandshakeException,
-                           java.lang.InterruptedException
-
-
- -
Throws: -
InvalidHandshakeException -
java.lang.InterruptedException
-
-
-
- -

-getRemoteSocketAddress

-
-public java.net.InetSocketAddress getRemoteSocketAddress()
-
-
-
-
-
-
- -

-getLocalSocketAddress

-
-public java.net.InetSocketAddress getLocalSocketAddress()
-
-
-
-
-
-
- -

-toString

-
-public java.lang.String toString()
-
-
-
Overrides:
toString in class java.lang.Object
-
-
-
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/WebSocketAdapter.html b/doc/net/tootallnate/websocket/WebSocketAdapter.html deleted file mode 100644 index 2ba669cac..000000000 --- a/doc/net/tootallnate/websocket/WebSocketAdapter.html +++ /dev/null @@ -1,524 +0,0 @@ - - - - - - -WebSocketAdapter - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket -
-Class WebSocketAdapter

-
-java.lang.Object
-  extended by net.tootallnate.websocket.WebSocketAdapter
-
-
-
Direct Known Subclasses:
WebSocketClient, WebSocketServer
-
-
-
-
public abstract class WebSocketAdapter
extends java.lang.Object
- - -

-

- -

- - - - - - - - - - - -
-Constructor Summary
WebSocketAdapter() - -
-           
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- java.lang.StringgetFlashPolicy(WebSocket conn) - -
-          Gets the XML string that should be returned if a client requests a Flash - security policy.
- voidonClose(WebSocket conn) - -
-          Called after WebSocket#close is explicity called, or when the - other end of the WebSocket connection is closed.
- voidonError(WebSocket conn, - java.lang.Exception ex) - -
-           
- booleanonHandshakeRecievedAsClient(WebSocket conn, - Handshakedata request, - Handshakedata response) - -
-           
- HandshakeBuilderonHandshakeRecievedAsServer(WebSocket conn, - Draft draft, - Handshakedata request) - -
-          Called when the socket connection is first established, and the WebSocket - handshake has been recieved.
- voidonMessage(WebSocket conn, - byte[] blob) - -
-           
- voidonMessage(WebSocket conn, - java.lang.String message) - -
-          Called when an entire text frame has been recieved.
- voidonOpen(WebSocket conn) - -
-          Called after onHandshakeRecieved returns true.
- voidonPing(WebSocket conn, - Framedata f) - -
-           
- voidonPong(WebSocket conn, - Framedata f) - -
-           
- voidonWriteDemand(WebSocket conn) - -
-           
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-WebSocketAdapter

-
-public WebSocketAdapter()
-
-
- - - - - - - - -
-Method Detail
- -

-onHandshakeRecievedAsServer

-
-public HandshakeBuilder onHandshakeRecievedAsServer(WebSocket conn,
-                                                    Draft draft,
-                                                    Handshakedata request)
-                                             throws java.io.IOException
-
-
Called when the socket connection is first established, and the WebSocket - handshake has been recieved. -

-

-
-
-
- -
Throws: -
java.io.IOException
-
-
-
- -

-onHandshakeRecievedAsClient

-
-public boolean onHandshakeRecievedAsClient(WebSocket conn,
-                                           Handshakedata request,
-                                           Handshakedata response)
-                                    throws java.io.IOException
-
-
-
-
-
- -
Throws: -
java.io.IOException
-
-
-
- -

-onMessage

-
-public void onMessage(WebSocket conn,
-                      java.lang.String message)
-
-
Called when an entire text frame has been recieved. Do whatever you want - here... -

-

-
-
-
-
Parameters:
conn - The WebSocket instance this event is occuring on.
message - The UTF-8 decoded message that was recieved.
-
-
-
- -

-onOpen

-
-public void onOpen(WebSocket conn)
-
-
Called after onHandshakeRecieved returns true. - Indicates that a complete WebSocket connection has been established, - and we are ready to send/recieve data. -

-

-
-
-
-
Parameters:
conn - The WebSocket instance this event is occuring on.
-
-
-
- -

-onClose

-
-public void onClose(WebSocket conn)
-
-
Called after WebSocket#close is explicity called, or when the - other end of the WebSocket connection is closed. -

-

-
-
-
-
Parameters:
conn - The WebSocket instance this event is occuring on.
-
-
-
- -

-onMessage

-
-public void onMessage(WebSocket conn,
-                      byte[] blob)
-
-
-
-
-
-
-
-
-
- -

-onPing

-
-public void onPing(WebSocket conn,
-                   Framedata f)
-
-
-
-
-
-
-
-
-
- -

-onPong

-
-public void onPong(WebSocket conn,
-                   Framedata f)
-
-
-
-
-
-
-
-
-
- -

-getFlashPolicy

-
-public java.lang.String getFlashPolicy(WebSocket conn)
-
-
Gets the XML string that should be returned if a client requests a Flash - security policy. - - The default implementation allows access from all remote domains, but - only on the port that this WebSocketServer is listening on. - - This is specifically implemented for gitime's WebSocket client for Flash: - http://github.com/gimite/web-socket-js -

-

-
-
-
- -
Returns:
An XML String that comforms to Flash's security policy. You MUST - not include the null char at the end, it is appended automatically.
-
-
-
- -

-onError

-
-public void onError(WebSocket conn,
-                    java.lang.Exception ex)
-
-
-
-
-
-
-
-
-
- -

-onWriteDemand

-
-public void onWriteDemand(WebSocket conn)
-
-
-
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/WebSocketClient.html b/doc/net/tootallnate/websocket/WebSocketClient.html deleted file mode 100644 index 5be99e191..000000000 --- a/doc/net/tootallnate/websocket/WebSocketClient.html +++ /dev/null @@ -1,639 +0,0 @@ - - - - - - -WebSocketClient - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket -
-Class WebSocketClient

-
-java.lang.Object
-  extended by net.tootallnate.websocket.WebSocketAdapter
-      extended by net.tootallnate.websocket.WebSocketClient
-
-
-
All Implemented Interfaces:
java.lang.Runnable
-
-
-
-
public abstract class WebSocketClient
extends WebSocketAdapter
implements java.lang.Runnable
- - -

-The WebSocketClient is an abstract class that expects a valid - "ws://" URI to connect to. When connected, an instance recieves important - events related to the life of the connection. A subclass must implement - onOpen, onClose, and onMessage to be - useful. An instance can send messages to it's connected server via the - send method. -

- -

-

-
Author:
-
Nathan Rajlich
-
-
- -

- - - - - - - - - - - - - - -
-Constructor Summary
WebSocketClient(java.net.URI serverURI) - -
-           
WebSocketClient(java.net.URI serverUri, - Draft draft) - -
-          Constructs a WebSocketClient instance and sets it to the connect to the - specified URI.
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- java.lang.Threadclose() - -
-          Calls close on the underlying SocketChannel, which in turn - closes the socket connection, and ends the client socket thread.
- voidconnect() - -
-          Starts a background thread that attempts and maintains a WebSocket - connection to the URI specified in the constructor or via setURI.
- DraftgetDraft() - -
-           
- java.net.URIgetURI() - -
-          Gets the URI that this WebSocketClient is connected to.
-abstract  voidonClose() - -
-           
- voidonClose(WebSocket conn) - -
-          Calls subclass' implementation of onClose.
-abstract  voidonError(java.lang.Exception ex) - -
-           
- voidonError(WebSocket conn, - java.io.IOException ex) - -
-          Calls subclass' implementation of onIOError.
-abstract  voidonMessage(java.lang.String message) - -
-           
- voidonMessage(WebSocket conn, - java.lang.String message) - -
-          Calls subclass' implementation of onMessage.
-abstract  voidonOpen() - -
-           
- voidonOpen(WebSocket conn) - -
-          Calls subclass' implementation of onOpen.
- voidonWriteDemand(WebSocket conn) - -
-           
- voidrun() - -
-           
- voidsend(java.lang.String text) - -
-          Sends text to the connected WebSocket server.
-  - - - - - - - -
Methods inherited from class net.tootallnate.websocket.WebSocketAdapter
getFlashPolicy, onError, onHandshakeRecievedAsClient, onHandshakeRecievedAsServer, onMessage, onPing, onPong
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-WebSocketClient

-
-public WebSocketClient(java.net.URI serverURI)
-
-
-
- -

-WebSocketClient

-
-public WebSocketClient(java.net.URI serverUri,
-                       Draft draft)
-
-
Constructs a WebSocketClient instance and sets it to the connect to the - specified URI. The client does not attampt to connect automatically. You - must call connect first to initiate the socket connection. -

-

- - - - - - - - -
-Method Detail
- -

-getURI

-
-public java.net.URI getURI()
-
-
Gets the URI that this WebSocketClient is connected to. -

-

-
-
-
- -
Returns:
The URI for this WebSocketClient.
-
-
-
- -

-getDraft

-
-public Draft getDraft()
-
-
-
-
-
-
-
-
-
- -

-connect

-
-public void connect()
-
-
Starts a background thread that attempts and maintains a WebSocket - connection to the URI specified in the constructor or via setURI. - setURI. -

-

-
-
-
-
-
-
-
- -

-close

-
-public java.lang.Thread close()
-
-
Calls close on the underlying SocketChannel, which in turn - closes the socket connection, and ends the client socket thread. -

-

-
-
-
-
-
-
-
- -

-send

-
-public void send(java.lang.String text)
-          throws java.nio.channels.NotYetConnectedException,
-                 java.lang.InterruptedException
-
-
Sends text to the connected WebSocket server. -

-

-
-
-
-
Parameters:
text - The String to send to the WebSocket server. -
Throws: -
java.nio.channels.NotYetConnectedException -
java.lang.InterruptedException
-
-
-
- -

-run

-
-public void run()
-
-
-
Specified by:
run in interface java.lang.Runnable
-
-
-
-
-
-
- -

-onMessage

-
-public void onMessage(WebSocket conn,
-                      java.lang.String message)
-
-
Calls subclass' implementation of onMessage. -

-

-
Overrides:
onMessage in class WebSocketAdapter
-
-
-
Parameters:
conn -
message -
-
-
-
- -

-onOpen

-
-public void onOpen(WebSocket conn)
-
-
Calls subclass' implementation of onOpen. -

-

-
Overrides:
onOpen in class WebSocketAdapter
-
-
-
Parameters:
conn -
-
-
-
- -

-onClose

-
-public void onClose(WebSocket conn)
-
-
Calls subclass' implementation of onClose. -

-

-
Overrides:
onClose in class WebSocketAdapter
-
-
-
Parameters:
conn -
-
-
-
- -

-onError

-
-public void onError(WebSocket conn,
-                    java.io.IOException ex)
-
-
Calls subclass' implementation of onIOError. -

-

-
-
-
-
Parameters:
conn -
-
-
-
- -

-onWriteDemand

-
-public void onWriteDemand(WebSocket conn)
-
-
-
-
-
-
-
-
-
- -

-onMessage

-
-public abstract void onMessage(java.lang.String message)
-
-
-
-
-
-
-
-
-
- -

-onOpen

-
-public abstract void onOpen()
-
-
-
-
-
-
-
-
-
- -

-onClose

-
-public abstract void onClose()
-
-
-
-
-
-
-
-
-
- -

-onError

-
-public abstract void onError(java.lang.Exception ex)
-
-
-
-
-
-
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/WebSocketServer.html b/doc/net/tootallnate/websocket/WebSocketServer.html deleted file mode 100644 index c69f7f495..000000000 --- a/doc/net/tootallnate/websocket/WebSocketServer.html +++ /dev/null @@ -1,823 +0,0 @@ - - - - - - -WebSocketServer - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket -
-Class WebSocketServer

-
-java.lang.Object
-  extended by net.tootallnate.websocket.WebSocketAdapter
-      extended by net.tootallnate.websocket.WebSocketServer
-
-
-
All Implemented Interfaces:
java.lang.Runnable
-
-
-
-
public abstract class WebSocketServer
extends WebSocketAdapter
implements java.lang.Runnable
- - -

-WebSocketServer is an abstract class that only takes care of the - HTTP handshake portion of WebSockets. It's up to a subclass to add - functionality/purpose to the server. -

- -

-

-
Author:
-
Nathan Rajlich
-
-
- -

- - - - - - - - - - - - - - - - - -
-Constructor Summary
WebSocketServer() - -
-          Nullary constructor.
WebSocketServer(java.net.InetSocketAddress address) - -
-          Creates a WebSocketServer that will attempt to listen on port - port.
WebSocketServer(java.net.InetSocketAddress address, - Draft draft) - -
-          Creates a WebSocketServer that will attempt to listen on port port, - and comply with Draft version draft.
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- java.util.Set<WebSocket>connections() - -
-          Returns a WebSocket[] of currently connected clients.
- java.net.InetSocketAddressgetAddress() - -
-           
- DraftgetDraft() - -
-           
-protected  java.lang.StringgetFlashSecurityPolicy() - -
-          Gets the XML string that should be returned if a client requests a Flash - security policy.
- intgetPort() - -
-          Gets the port number that this server listens on.
-abstract  voidonClientClose(WebSocket conn) - -
-           
-abstract  voidonClientMessage(WebSocket conn, - java.lang.String message) - -
-           
-abstract  voidonClientOpen(WebSocket conn) - -
-           
- voidonClose(WebSocket conn) - -
-          Called after WebSocket#close is explicity called, or when the - other end of the WebSocket connection is closed.
-abstract  voidonError(WebSocket conn, - java.lang.Exception ex) - -
-           
- voidonMessage(WebSocket conn, - java.lang.String message) - -
-          Called when an entire text frame has been recieved.
- voidonOpen(WebSocket conn) - -
-          Called after onHandshakeRecieved returns true.
- voidonWriteDemand(WebSocket conn) - -
-           
- voidrun() - -
-           
- voidsendToAll(java.lang.String text) - -
-          Sends text to all currently connected WebSocket clients.
- voidsendToAllExcept(java.util.Set<WebSocket> connections, - java.lang.String text) - -
-          Sends text to all currently connected WebSocket clients, - except for those found in the Set connections.
- voidsendToAllExcept(WebSocket connection, - java.lang.String text) - -
-          Sends text to all currently connected WebSocket clients, - except for the specified connection.
- voidsetAddress(java.net.InetSocketAddress address) - -
-          Sets the port that this WebSocketServer should listen on.
- voidstart() - -
-          Starts the server thread that binds to the currently set port number and - listeners for WebSocket connection requests.
- voidstop() - -
-          Closes all connected clients sockets, then closes the underlying - ServerSocketChannel, effectively killing the server socket thread and - freeing the port the server was bound to.
-  - - - - - - - -
Methods inherited from class net.tootallnate.websocket.WebSocketAdapter
getFlashPolicy, onHandshakeRecievedAsClient, onHandshakeRecievedAsServer, onMessage, onPing, onPong
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-WebSocketServer

-
-public WebSocketServer()
-                throws java.net.UnknownHostException
-
-
Nullary constructor. Creates a WebSocketServer that will attempt to - listen on port WebSocket.DEFAULT_PORT. -

-

- -
Throws: -
java.net.UnknownHostException
-
-
- -

-WebSocketServer

-
-public WebSocketServer(java.net.InetSocketAddress address)
-
-
Creates a WebSocketServer that will attempt to listen on port - port. -

-

-
Parameters:
port - The port number this server should listen on.
-
-
- -

-WebSocketServer

-
-public WebSocketServer(java.net.InetSocketAddress address,
-                       Draft draft)
-
-
Creates a WebSocketServer that will attempt to listen on port port, - and comply with Draft version draft. -

-

-
Parameters:
port - The port number this server should listen on.
draft - The version of the WebSocket protocol that this server - instance should comply to.
-
- - - - - - - - -
-Method Detail
- -

-start

-
-public void start()
-
-
Starts the server thread that binds to the currently set port number and - listeners for WebSocket connection requests. -

-

-
-
-
- -
Throws: -
java.lang.IllegalStateException
-
-
-
- -

-stop

-
-public void stop()
-          throws java.io.IOException
-
-
Closes all connected clients sockets, then closes the underlying - ServerSocketChannel, effectively killing the server socket thread and - freeing the port the server was bound to. -

-

-
-
-
- -
Throws: -
java.io.IOException - When socket related I/O errors occur.
-
-
-
- -

-sendToAll

-
-public void sendToAll(java.lang.String text)
-               throws java.lang.InterruptedException
-
-
Sends text to all currently connected WebSocket clients. -

-

-
-
-
-
Parameters:
text - The String to send across the network. -
Throws: -
java.io.IOException - When socket related I/O errors occur. -
java.lang.InterruptedException
-
-
-
- -

-sendToAllExcept

-
-public void sendToAllExcept(WebSocket connection,
-                            java.lang.String text)
-                     throws java.lang.InterruptedException
-
-
Sends text to all currently connected WebSocket clients, - except for the specified connection. -

-

-
-
-
-
Parameters:
connection - The WebSocket connection to ignore.
text - The String to send to every connection except connection. -
Throws: -
java.io.IOException - When socket related I/O errors occur. -
java.lang.InterruptedException
-
-
-
- -

-sendToAllExcept

-
-public void sendToAllExcept(java.util.Set<WebSocket> connections,
-                            java.lang.String text)
-                     throws java.lang.InterruptedException
-
-
Sends text to all currently connected WebSocket clients, - except for those found in the Set connections. -

-

-
-
-
-
Parameters:
connections -
text - -
Throws: -
java.io.IOException - When socket related I/O errors occur. -
java.lang.InterruptedException
-
-
-
- -

-connections

-
-public java.util.Set<WebSocket> connections()
-
-
Returns a WebSocket[] of currently connected clients. -

-

-
-
-
- -
Returns:
The currently connected clients in a WebSocket[].
-
-
-
- -

-setAddress

-
-public void setAddress(java.net.InetSocketAddress address)
-
-
Sets the port that this WebSocketServer should listen on. -

-

-
-
-
-
Parameters:
port - The port number to listen on.
-
-
-
- -

-getAddress

-
-public java.net.InetSocketAddress getAddress()
-
-
-
-
-
-
-
-
-
- -

-getPort

-
-public int getPort()
-
-
Gets the port number that this server listens on. -

-

-
-
-
- -
Returns:
The port number.
-
-
-
- -

-getDraft

-
-public Draft getDraft()
-
-
-
-
-
-
-
-
-
- -

-run

-
-public void run()
-
-
-
Specified by:
run in interface java.lang.Runnable
-
-
-
-
-
-
- -

-getFlashSecurityPolicy

-
-protected java.lang.String getFlashSecurityPolicy()
-
-
Gets the XML string that should be returned if a client requests a Flash - security policy. - - The default implementation allows access from all remote domains, but - only on the port that this WebSocketServer is listening on. - - This is specifically implemented for gitime's WebSocket client for Flash: - http://github.com/gimite/web-socket-js -

-

-
-
-
- -
Returns:
An XML String that comforms to Flash's security policy. You MUST - not include the null char at the end, it is appended automatically.
-
-
-
- -

-onMessage

-
-public void onMessage(WebSocket conn,
-                      java.lang.String message)
-
-
Called when an entire text frame has been recieved. Do whatever you want - here... -

-

-
Overrides:
onMessage in class WebSocketAdapter
-
-
-
Parameters:
conn - The WebSocket instance this event is occuring on.
message - The UTF-8 decoded message that was recieved.
-
-
-
- -

-onOpen

-
-public void onOpen(WebSocket conn)
-
-
Called after onHandshakeRecieved returns true. - Indicates that a complete WebSocket connection has been established, - and we are ready to send/recieve data. -

-

-
Overrides:
onOpen in class WebSocketAdapter
-
-
-
Parameters:
conn - The WebSocket instance this event is occuring on.
-
-
-
- -

-onClose

-
-public void onClose(WebSocket conn)
-
-
Called after WebSocket#close is explicity called, or when the - other end of the WebSocket connection is closed. -

-

-
Overrides:
onClose in class WebSocketAdapter
-
-
-
Parameters:
conn - The WebSocket instance this event is occuring on.
-
-
-
- -

-onWriteDemand

-
-public void onWriteDemand(WebSocket conn)
-
-
-
-
-
-
-
-
-
- -

-onClientOpen

-
-public abstract void onClientOpen(WebSocket conn)
-
-
-
-
-
-
-
-
-
- -

-onClientClose

-
-public abstract void onClientClose(WebSocket conn)
-
-
-
-
-
-
-
-
-
- -

-onClientMessage

-
-public abstract void onClientMessage(WebSocket conn,
-                                     java.lang.String message)
-
-
-
-
-
-
-
-
-
- -

-onError

-
-public abstract void onError(WebSocket conn,
-                             java.lang.Exception ex)
-
-
-
Overrides:
onError in class WebSocketAdapter
-
-
-
Parameters:
conn - may be null if the error does not belong to a single connection
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/drafts/Draft_10.html b/doc/net/tootallnate/websocket/drafts/Draft_10.html deleted file mode 100644 index 35bf88003..000000000 --- a/doc/net/tootallnate/websocket/drafts/Draft_10.html +++ /dev/null @@ -1,544 +0,0 @@ - - - - - - -Draft_10 - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket.drafts -
-Class Draft_10

-
-java.lang.Object
-  extended by net.tootallnate.websocket.Draft
-      extended by net.tootallnate.websocket.drafts.Draft_10
-
-
-
Direct Known Subclasses:
Draft_17
-
-
-
-
public class Draft_10
extends Draft
- - -

-

- -

- - - - - - - -
-Nested Class Summary
-  - - - - - - - -
Nested classes/interfaces inherited from class net.tootallnate.websocket.Draft
Draft.HandshakeState
-  - - - - - - - -
-Field Summary
-  - - - - - - - -
Fields inherited from class net.tootallnate.websocket.Draft
role
-  - - - - - - - - - - -
-Constructor Summary
Draft_10() - -
-           
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- Draft.HandshakeStateacceptHandshakeAsClient(Handshakedata request, - Handshakedata response) - -
-           
- Draft.HandshakeStateacceptHandshakeAsServer(Handshakedata handshakedata) - -
-           
- java.nio.ByteBuffercreateBinaryFrame(Framedata framedata) - -
-           
- java.util.List<Framedata>createFrames(byte[] binary, - boolean mask) - -
-           
- java.util.List<Framedata>createFrames(java.lang.String text, - boolean mask) - -
-           
- HandshakeBuilderpostProcessHandshakeRequestAsClient(HandshakeBuilder request) - -
-           
- HandshakeBuilderpostProcessHandshakeResponseAsServer(Handshakedata request, - HandshakeBuilder response) - -
-           
-static intreadVersion(Handshakedata handshakedata) - -
-           
- voidreset() - -
-           
- java.util.List<Framedata>translateFrame(java.nio.ByteBuffer buffer) - -
-           
- FramedatatranslateSingleFrame(java.nio.ByteBuffer buffer) - -
-           
-  - - - - - - - -
Methods inherited from class net.tootallnate.websocket.Draft
basicAccept, checkAlloc, createHandshake, createHandshake, readLine, readStringLine, setParseMode, translateHandshake, translateHandshakeHttp
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-Draft_10

-
-public Draft_10()
-
-
- - - - - - - - -
-Method Detail
- -

-readVersion

-
-public static int readVersion(Handshakedata handshakedata)
-
-
-
-
-
-
- -

-acceptHandshakeAsClient

-
-public Draft.HandshakeState acceptHandshakeAsClient(Handshakedata request,
-                                                    Handshakedata response)
-                                             throws InvalidHandshakeException
-
-
-
Specified by:
acceptHandshakeAsClient in class Draft
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-acceptHandshakeAsServer

-
-public Draft.HandshakeState acceptHandshakeAsServer(Handshakedata handshakedata)
-                                             throws InvalidHandshakeException
-
-
-
Specified by:
acceptHandshakeAsServer in class Draft
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-createBinaryFrame

-
-public java.nio.ByteBuffer createBinaryFrame(Framedata framedata)
-
-
-
Specified by:
createBinaryFrame in class Draft
-
-
-
-
-
-
- -

-createFrames

-
-public java.util.List<Framedata> createFrames(byte[] binary,
-                                              boolean mask)
-
-
-
Specified by:
createFrames in class Draft
-
-
-
-
-
-
- -

-createFrames

-
-public java.util.List<Framedata> createFrames(java.lang.String text,
-                                              boolean mask)
-
-
-
Specified by:
createFrames in class Draft
-
-
-
-
-
-
- -

-postProcessHandshakeRequestAsClient

-
-public HandshakeBuilder postProcessHandshakeRequestAsClient(HandshakeBuilder request)
-
-
-
Specified by:
postProcessHandshakeRequestAsClient in class Draft
-
-
-
-
-
-
- -

-postProcessHandshakeResponseAsServer

-
-public HandshakeBuilder postProcessHandshakeResponseAsServer(Handshakedata request,
-                                                             HandshakeBuilder response)
-                                                      throws InvalidHandshakeException
-
-
-
Specified by:
postProcessHandshakeResponseAsServer in class Draft
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-translateFrame

-
-public java.util.List<Framedata> translateFrame(java.nio.ByteBuffer buffer)
-                                         throws LimitExedeedException,
-                                                InvalidDataException
-
-
-
Specified by:
translateFrame in class Draft
-
-
- -
Throws: -
LimitExedeedException -
InvalidDataException
-
-
-
- -

-translateSingleFrame

-
-public Framedata translateSingleFrame(java.nio.ByteBuffer buffer)
-                               throws net.tootallnate.websocket.drafts.Draft_10.IncompleteException,
-                                      InvalidDataException
-
-
- -
Throws: -
net.tootallnate.websocket.drafts.Draft_10.IncompleteException -
InvalidDataException
-
-
-
- -

-reset

-
-public void reset()
-
-
-
Specified by:
reset in class Draft
-
-
-
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/drafts/Draft_17.html b/doc/net/tootallnate/websocket/drafts/Draft_17.html deleted file mode 100644 index c89c317a8..000000000 --- a/doc/net/tootallnate/websocket/drafts/Draft_17.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - - -Draft_17 - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket.drafts -
-Class Draft_17

-
-java.lang.Object
-  extended by net.tootallnate.websocket.Draft
-      extended by net.tootallnate.websocket.drafts.Draft_10
-          extended by net.tootallnate.websocket.drafts.Draft_17
-
-
-
-
public class Draft_17
extends Draft_10
- - -

-

- -

- - - - - - - -
-Nested Class Summary
-  - - - - - - - -
Nested classes/interfaces inherited from class net.tootallnate.websocket.Draft
Draft.HandshakeState
-  - - - - - - - -
-Field Summary
-  - - - - - - - -
Fields inherited from class net.tootallnate.websocket.Draft
role
-  - - - - - - - - - - -
-Constructor Summary
Draft_17() - -
-           
-  - - - - - - - - - - - - - - - -
-Method Summary
- Draft.HandshakeStateacceptHandshakeAsServer(Handshakedata handshakedata) - -
-           
- HandshakeBuilderpostProcessHandshakeRequestAsClient(HandshakeBuilder request) - -
-           
-  - - - - - - - -
Methods inherited from class net.tootallnate.websocket.drafts.Draft_10
acceptHandshakeAsClient, createBinaryFrame, createFrames, createFrames, postProcessHandshakeResponseAsServer, readVersion, reset, translateFrame, translateSingleFrame
-  - - - - - - - -
Methods inherited from class net.tootallnate.websocket.Draft
basicAccept, checkAlloc, createHandshake, createHandshake, readLine, readStringLine, setParseMode, translateHandshake, translateHandshakeHttp
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-Draft_17

-
-public Draft_17()
-
-
- - - - - - - - -
-Method Detail
- -

-acceptHandshakeAsServer

-
-public Draft.HandshakeState acceptHandshakeAsServer(Handshakedata handshakedata)
-                                             throws InvalidHandshakeException
-
-
-
Overrides:
acceptHandshakeAsServer in class Draft_10
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-postProcessHandshakeRequestAsClient

-
-public HandshakeBuilder postProcessHandshakeRequestAsClient(HandshakeBuilder request)
-
-
-
Overrides:
postProcessHandshakeRequestAsClient in class Draft_10
-
-
-
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/drafts/Draft_75.html b/doc/net/tootallnate/websocket/drafts/Draft_75.html deleted file mode 100644 index 8bb238b3f..000000000 --- a/doc/net/tootallnate/websocket/drafts/Draft_75.html +++ /dev/null @@ -1,585 +0,0 @@ - - - - - - -Draft_75 - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket.drafts -
-Class Draft_75

-
-java.lang.Object
-  extended by net.tootallnate.websocket.Draft
-      extended by net.tootallnate.websocket.drafts.Draft_75
-
-
-
Direct Known Subclasses:
Draft_76
-
-
-
-
public class Draft_75
extends Draft
- - -

-

- -

- - - - - - - -
-Nested Class Summary
-  - - - - - - - -
Nested classes/interfaces inherited from class net.tootallnate.websocket.Draft
Draft.HandshakeState
-  - - - - - - - - - - - - - - - - - - - - - - - -
-Field Summary
-static byteCR - -
-          The byte representing CR, or Carriage Return, or \r
-static byteEND_OF_FRAME - -
-          The byte representing the end of a WebSocket text frame.
-static byteLF - -
-          The byte representing LF, or Line Feed, or \n
-static byteSTART_OF_FRAME - -
-          The byte representing the beginning of a WebSocket text frame.
-  - - - - - - - -
Fields inherited from class net.tootallnate.websocket.Draft
role
-  - - - - - - - - - - -
-Constructor Summary
Draft_75() - -
-           
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- Draft.HandshakeStateacceptHandshakeAsClient(Handshakedata request, - Handshakedata response) - -
-           
- Draft.HandshakeStateacceptHandshakeAsServer(Handshakedata handshakedata) - -
-           
- java.nio.ByteBuffercreateBinaryFrame(Framedata framedata) - -
-           
- java.util.List<Framedata>createFrames(byte[] binary, - boolean mask) - -
-           
- java.util.List<Framedata>createFrames(java.lang.String text, - boolean mask) - -
-           
- HandshakeBuilderpostProcessHandshakeRequestAsClient(HandshakeBuilder request) - -
-           
- HandshakeBuilderpostProcessHandshakeResponseAsServer(Handshakedata request, - HandshakeBuilder response) - -
-           
- voidreset() - -
-           
- java.util.List<Framedata>translateFrame(java.nio.ByteBuffer buffer) - -
-           
-  - - - - - - - -
Methods inherited from class net.tootallnate.websocket.Draft
basicAccept, checkAlloc, createHandshake, createHandshake, readLine, readStringLine, setParseMode, translateHandshake, translateHandshakeHttp
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Field Detail
- -

-CR

-
-public static final byte CR
-
-
The byte representing CR, or Carriage Return, or \r -

-

-
See Also:
Constant Field Values
-
-
- -

-LF

-
-public static final byte LF
-
-
The byte representing LF, or Line Feed, or \n -

-

-
See Also:
Constant Field Values
-
-
- -

-START_OF_FRAME

-
-public static final byte START_OF_FRAME
-
-
The byte representing the beginning of a WebSocket text frame. -

-

-
See Also:
Constant Field Values
-
-
- -

-END_OF_FRAME

-
-public static final byte END_OF_FRAME
-
-
The byte representing the end of a WebSocket text frame. -

-

-
See Also:
Constant Field Values
-
- - - - - - - - -
-Constructor Detail
- -

-Draft_75

-
-public Draft_75()
-
-
- - - - - - - - -
-Method Detail
- -

-acceptHandshakeAsClient

-
-public Draft.HandshakeState acceptHandshakeAsClient(Handshakedata request,
-                                                    Handshakedata response)
-
-
-
Specified by:
acceptHandshakeAsClient in class Draft
-
-
-
-
-
-
- -

-acceptHandshakeAsServer

-
-public Draft.HandshakeState acceptHandshakeAsServer(Handshakedata handshakedata)
-
-
-
Specified by:
acceptHandshakeAsServer in class Draft
-
-
-
-
-
-
- -

-createBinaryFrame

-
-public java.nio.ByteBuffer createBinaryFrame(Framedata framedata)
-
-
-
Specified by:
createBinaryFrame in class Draft
-
-
-
-
-
-
- -

-createFrames

-
-public java.util.List<Framedata> createFrames(byte[] binary,
-                                              boolean mask)
-
-
-
Specified by:
createFrames in class Draft
-
-
-
-
-
-
- -

-createFrames

-
-public java.util.List<Framedata> createFrames(java.lang.String text,
-                                              boolean mask)
-
-
-
Specified by:
createFrames in class Draft
-
-
-
-
-
-
- -

-postProcessHandshakeRequestAsClient

-
-public HandshakeBuilder postProcessHandshakeRequestAsClient(HandshakeBuilder request)
-                                                     throws InvalidHandshakeException
-
-
-
Specified by:
postProcessHandshakeRequestAsClient in class Draft
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-postProcessHandshakeResponseAsServer

-
-public HandshakeBuilder postProcessHandshakeResponseAsServer(Handshakedata request,
-                                                             HandshakeBuilder response)
-                                                      throws InvalidHandshakeException
-
-
-
Specified by:
postProcessHandshakeResponseAsServer in class Draft
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-translateFrame

-
-public java.util.List<Framedata> translateFrame(java.nio.ByteBuffer buffer)
-                                         throws InvalidDataException
-
-
-
Specified by:
translateFrame in class Draft
-
-
- -
Throws: -
InvalidDataException
-
-
-
- -

-reset

-
-public void reset()
-
-
-
Specified by:
reset in class Draft
-
-
-
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/drafts/Draft_76.html b/doc/net/tootallnate/websocket/drafts/Draft_76.html deleted file mode 100644 index dd0b88ef0..000000000 --- a/doc/net/tootallnate/websocket/drafts/Draft_76.html +++ /dev/null @@ -1,443 +0,0 @@ - - - - - - -Draft_76 - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- -

- -net.tootallnate.websocket.drafts -
-Class Draft_76

-
-java.lang.Object
-  extended by net.tootallnate.websocket.Draft
-      extended by net.tootallnate.websocket.drafts.Draft_75
-          extended by net.tootallnate.websocket.drafts.Draft_76
-
-
-
-
public class Draft_76
extends Draft_75
- - -

-

- -

- - - - - - - -
-Nested Class Summary
-  - - - - - - - -
Nested classes/interfaces inherited from class net.tootallnate.websocket.Draft
Draft.HandshakeState
-  - - - - - - - -
-Field Summary
-  - - - - - - - -
Fields inherited from class net.tootallnate.websocket.drafts.Draft_75
CR, END_OF_FRAME, LF, START_OF_FRAME
-  - - - - - - - -
Fields inherited from class net.tootallnate.websocket.Draft
role
-  - - - - - - - - - - -
-Constructor Summary
Draft_76() - -
-           
-  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- Draft.HandshakeStateacceptHandshakeAsClient(Handshakedata request, - Handshakedata response) - -
-           
- Draft.HandshakeStateacceptHandshakeAsServer(Handshakedata handshakedata) - -
-           
-static byte[]createChallenge(java.lang.String key1, - java.lang.String key2, - byte[] key3) - -
-           
- HandshakeBuilderpostProcessHandshakeRequestAsClient(HandshakeBuilder request) - -
-           
- HandshakeBuilderpostProcessHandshakeResponseAsServer(Handshakedata request, - HandshakeBuilder response) - -
-           
- HandshakedatatranslateHandshake(java.nio.ByteBuffer buf) - -
-           
-  - - - - - - - -
Methods inherited from class net.tootallnate.websocket.drafts.Draft_75
createBinaryFrame, createFrames, createFrames, reset, translateFrame
-  - - - - - - - -
Methods inherited from class net.tootallnate.websocket.Draft
basicAccept, checkAlloc, createHandshake, createHandshake, readLine, readStringLine, setParseMode, translateHandshakeHttp
-  - - - - - - - -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-  -

- - - - - - - - -
-Constructor Detail
- -

-Draft_76

-
-public Draft_76()
-
-
- - - - - - - - -
-Method Detail
- -

-createChallenge

-
-public static byte[] createChallenge(java.lang.String key1,
-                                     java.lang.String key2,
-                                     byte[] key3)
-                              throws InvalidHandshakeException
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-acceptHandshakeAsClient

-
-public Draft.HandshakeState acceptHandshakeAsClient(Handshakedata request,
-                                                    Handshakedata response)
-
-
-
Overrides:
acceptHandshakeAsClient in class Draft_75
-
-
-
-
-
-
- -

-acceptHandshakeAsServer

-
-public Draft.HandshakeState acceptHandshakeAsServer(Handshakedata handshakedata)
-
-
-
Overrides:
acceptHandshakeAsServer in class Draft_75
-
-
-
-
-
-
- -

-postProcessHandshakeRequestAsClient

-
-public HandshakeBuilder postProcessHandshakeRequestAsClient(HandshakeBuilder request)
-
-
-
Overrides:
postProcessHandshakeRequestAsClient in class Draft_75
-
-
-
-
-
-
- -

-postProcessHandshakeResponseAsServer

-
-public HandshakeBuilder postProcessHandshakeResponseAsServer(Handshakedata request,
-                                                             HandshakeBuilder response)
-                                                      throws InvalidHandshakeException
-
-
-
Overrides:
postProcessHandshakeResponseAsServer in class Draft_75
-
-
- -
Throws: -
InvalidHandshakeException
-
-
-
- -

-translateHandshake

-
-public Handshakedata translateHandshake(java.nio.ByteBuffer buf)
-                                 throws InvalidHandshakeException
-
-
-
Overrides:
translateHandshake in class Draft
-
-
- -
Throws: -
InvalidHandshakeException
-
-
- -
- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Overview  Package   Class  Tree  Deprecated  Index  Help 
-		 - -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- - - -
- - - diff --git a/doc/net/tootallnate/websocket/drafts/package-frame.html b/doc/net/tootallnate/websocket/drafts/package-frame.html deleted file mode 100644 index 622069242..000000000 --- a/doc/net/tootallnate/websocket/drafts/package-frame.html +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - -net.tootallnate.websocket.drafts - - - - - - - - - - - -net.tootallnate.websocket.drafts - - - - -
-Classes  - -
-Draft_10 -
-Draft_17 -
-Draft_75 -
-Draft_76
- - - - diff --git a/doc/net/tootallnate/websocket/exeptions/package-frame.html b/doc/net/tootallnate/websocket/exeptions/package-frame.html deleted file mode 100644 index ff959622a..000000000 --- a/doc/net/tootallnate/websocket/exeptions/package-frame.html +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - -net.tootallnate.websocket.exeptions - - - - - - - - - - - -net.tootallnate.websocket.exeptions - - - - -
-Exceptions  - -
-IncompleteHandshakeException -
-InvalidDataException -
-InvalidFrameException -
-InvalidHandshakeException -
-LimitExedeedException
- - - - diff --git a/doc/net/tootallnate/websocket/package-frame.html b/doc/net/tootallnate/websocket/package-frame.html deleted file mode 100644 index b3c65dc94..000000000 --- a/doc/net/tootallnate/websocket/package-frame.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - -net.tootallnate.websocket - - - - - - - - - - - -net.tootallnate.websocket - - - - -
-Interfaces  - -
-FrameBuilder -
-Framedata -
-HandshakeBuilder -
-Handshakedata
- - - - - - -
-Classes  - -
-Base64 -
-Base64.InputStream -
-Base64.OutputStream -
-Charsetfunctions -
-Draft -
-FramedataImpl1 -
-HandshakedataImpl1 -
-WebSocket -
-WebSocketAdapter -
-WebSocketClient -
-WebSocketServer
- - - - - - -
-Enums  - -
-Draft.HandshakeState -
-Framedata.Opcode -
-WebSocket.Role
- - - - diff --git a/doc/org/java_websocket/WebSocket.Role.html b/doc/org/java_websocket/WebSocket.Role.html new file mode 100644 index 000000000..08934449e --- /dev/null +++ b/doc/org/java_websocket/WebSocket.Role.html @@ -0,0 +1,323 @@ + + + + + + +WebSocket.Role + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +org.java_websocket +
+Enum WebSocket.Role

+
+java.lang.Object
+  extended by java.lang.Enum<WebSocket.Role>
+      extended by org.java_websocket.WebSocket.Role
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<WebSocket.Role>
+
+
+
Enclosing class:
WebSocket
+
+
+
+
public static enum WebSocket.Role
extends java.lang.Enum<WebSocket.Role>
+ + +

+

+ +

+ + + + + + + + + + + + + +
+Enum Constant Summary
CLIENT + +
+           
SERVER + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static WebSocket.RolevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static WebSocket.Role[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+CLIENT

+
+public static final WebSocket.Role CLIENT
+
+
+
+
+
+ +

+SERVER

+
+public static final WebSocket.Role SERVER
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static WebSocket.Role[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (WebSocket.Role c : WebSocket.Role.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static WebSocket.Role valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/WebSocket.html b/doc/org/java_websocket/WebSocket.html new file mode 100644 index 000000000..623a1a8d3 --- /dev/null +++ b/doc/org/java_websocket/WebSocket.html @@ -0,0 +1,903 @@ + + + + + + +WebSocket + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket +
+Class WebSocket

+
+java.lang.Object
+  extended by org.java_websocket.WebSocket
+
+
+
+
public final class WebSocket
extends java.lang.Object
+ + +

+Represents one end (client or server) of a single WebSocket connection. + Takes care of the "handshake" phase, then allows for easy sending of + text frames, and receiving frames through an event-based model. + + This is an inner class, used by WebSocketClient and WebSocketServer, and should never need to be instantiated directly + by your code. However, instances are exposed in WebSocketServer through the onClientOpen, onClientClose, + onClientMessage callbacks. +

+ +

+

+
Author:
+
Nathan Rajlich
+
+
+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classWebSocket.Role + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static booleanDEBUG + +
+           
+static intDEFAULT_PORT + +
+          The default port of WebSockets, as defined in the spec.
+ java.util.List<Draft>known_drafts + +
+           
+static intREADY_STATE_CLOSED + +
+           
+static intREADY_STATE_CLOSING + +
+           
+static intREADY_STATE_CONNECTING + +
+           
+static intREADY_STATE_OPEN + +
+           
+  + + + + + + + + + + + + + +
+Constructor Summary
WebSocket(WebSocketListener listener, + Draft draft, + java.nio.channels.SocketChannel socketchannel) + +
+          Used in WebSocketServer and WebSocketClient.
WebSocket(WebSocketListener listener, + java.util.List<Draft> drafts, + java.nio.channels.SocketChannel socketchannel) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose(int code) + +
+           
+ voidclose(int code, + java.lang.String message) + +
+          sends the closing handshake.
+ voidclose(InvalidDataException e) + +
+           
+ voidcloseConnection(int code, + boolean remote) + +
+           
+ voidcloseConnection(int code, + java.lang.String message, + boolean remote) + +
+          closes the socket no matter if the closing handshake completed.
+ voidcloseDirect(int code, + java.lang.String message) + +
+           
+ voidflush() + +
+          Empty the internal buffer, sending all the pending data before continuing.
+ java.net.InetSocketAddressgetLocalSocketAddress() + +
+           
+ intgetReadyState() + +
+          Retrieve the WebSocket 'readyState'.
+ java.net.InetSocketAddressgetRemoteSocketAddress() + +
+           
+ inthashCode() + +
+           
+ booleanisClosed() + +
+           
+ booleanisClosing() + +
+           
+ booleanisConnecting() + +
+           
+ Draft.HandshakeStateisFlashEdgeCase(java.nio.ByteBuffer request) + +
+           
+ booleanisOpen() + +
+           
+ voidsend(byte[] bytes) + +
+          Send Binary data (plain bytes) to the other end.
+ voidsend(java.lang.String text) + +
+          Send Text data to the other end.
+ voidsendFrame(Framedata framedata) + +
+           
+ voidstartHandshake(ClientHandshakeBuilder handshakedata) + +
+           
+ java.lang.StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+READY_STATE_CONNECTING

+
+public static final int READY_STATE_CONNECTING
+
+
+
See Also:
Constant Field Values
+
+
+ +

+READY_STATE_OPEN

+
+public static final int READY_STATE_OPEN
+
+
+
See Also:
Constant Field Values
+
+
+ +

+READY_STATE_CLOSING

+
+public static final int READY_STATE_CLOSING
+
+
+
See Also:
Constant Field Values
+
+
+ +

+READY_STATE_CLOSED

+
+public static final int READY_STATE_CLOSED
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_PORT

+
+public static final int DEFAULT_PORT
+
+
The default port of WebSockets, as defined in the spec. If the nullary + constructor is used, DEFAULT_PORT will be the port the WebSocketServer + is binded to. Note that ports under 1024 usually require root permissions. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEBUG

+
+public static boolean DEBUG
+
+
+
+
+
+ +

+known_drafts

+
+public java.util.List<Draft> known_drafts
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+WebSocket

+
+public WebSocket(WebSocketListener listener,
+                 Draft draft,
+                 java.nio.channels.SocketChannel socketchannel)
+
+
Used in WebSocketServer and WebSocketClient. +

+

+
Parameters:
socketchannel - The SocketChannel instance to read and + write to. The channel should already be registered + with a Selector before construction of this object.
listener - The WebSocketListener to notify of events when + they occur.
+
+
+ +

+WebSocket

+
+public WebSocket(WebSocketListener listener,
+                 java.util.List<Draft> drafts,
+                 java.nio.channels.SocketChannel socketchannel)
+
+
+ + + + + + + + +
+Method Detail
+ +

+close

+
+public void close(int code,
+                  java.lang.String message)
+
+
sends the closing handshake. + may be send in response to an other handshake. +

+

+
+
+
+
+ +

+closeDirect

+
+public void closeDirect(int code,
+                        java.lang.String message)
+                 throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+
+
+ +

+closeConnection

+
+public void closeConnection(int code,
+                            java.lang.String message,
+                            boolean remote)
+
+
closes the socket no matter if the closing handshake completed. + Does not send any not yet written data before closing. + Calling this method more than once will have no effect. +

+

+
Parameters:
remote - Indicates who "generated" code.
+ true means that this endpoint received the code from the other endpoint.
+ false means this endpoint decided to send the given code,
+ remote may also be true if this endpoint started the closing handshake since the other endpoint may not simply echo the code but close the connection the same time this endpoint does do but with an other code.
+
+
+
+ +

+closeConnection

+
+public void closeConnection(int code,
+                            boolean remote)
+
+
+
+
+
+
+ +

+close

+
+public void close(int code)
+
+
+
+
+
+
+ +

+close

+
+public void close(InvalidDataException e)
+
+
+
+
+
+
+ +

+send

+
+public void send(java.lang.String text)
+          throws java.lang.IllegalArgumentException,
+                 java.nio.channels.NotYetConnectedException,
+                 java.lang.InterruptedException
+
+
Send Text data to the other end. +

+

+ +
Throws: +
java.lang.IllegalArgumentException +
java.lang.InterruptedException +
java.nio.channels.NotYetConnectedException
+
+
+
+ +

+send

+
+public void send(byte[] bytes)
+          throws java.lang.IllegalArgumentException,
+                 java.nio.channels.NotYetConnectedException,
+                 java.lang.InterruptedException
+
+
Send Binary data (plain bytes) to the other end. +

+

+ +
Throws: +
java.lang.IllegalArgumentException +
java.lang.InterruptedException +
java.nio.channels.NotYetConnectedException
+
+
+
+ +

+sendFrame

+
+public void sendFrame(Framedata framedata)
+               throws java.lang.InterruptedException
+
+
+ +
Throws: +
java.lang.InterruptedException
+
+
+
+ +

+flush

+
+public void flush()
+           throws java.io.IOException
+
+
Empty the internal buffer, sending all the pending data before continuing. +

+

+ +
Throws: +
java.io.IOException
+
+
+
+ +

+isFlashEdgeCase

+
+public Draft.HandshakeState isFlashEdgeCase(java.nio.ByteBuffer request)
+
+
+
+
+
+
+ +

+startHandshake

+
+public void startHandshake(ClientHandshakeBuilder handshakedata)
+                    throws InvalidHandshakeException,
+                           java.lang.InterruptedException
+
+
+ +
Throws: +
InvalidHandshakeException +
java.lang.InterruptedException
+
+
+
+ +

+getRemoteSocketAddress

+
+public java.net.InetSocketAddress getRemoteSocketAddress()
+
+
+
+
+
+
+ +

+getLocalSocketAddress

+
+public java.net.InetSocketAddress getLocalSocketAddress()
+
+
+
+
+
+
+ +

+isConnecting

+
+public boolean isConnecting()
+
+
+
+
+
+
+ +

+isOpen

+
+public boolean isOpen()
+
+
+
+
+
+
+ +

+isClosing

+
+public boolean isClosing()
+
+
+
+
+
+
+ +

+isClosed

+
+public boolean isClosed()
+
+
+
+
+
+
+ +

+getReadyState

+
+public int getReadyState()
+
+
Retrieve the WebSocket 'readyState'. + This represents the state of the connection. + It returns a numerical value, as per W3C WebSockets specs. +

+

+ +
Returns:
Returns '0 = CONNECTING', '1 = OPEN', '2 = CLOSING' or '3 = CLOSED'
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+
+ +

+toString

+
+public java.lang.String toString()
+
+
+
Overrides:
toString in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/WebSocketAdapter.html b/doc/org/java_websocket/WebSocketAdapter.html new file mode 100644 index 000000000..ac47dfda1 --- /dev/null +++ b/doc/org/java_websocket/WebSocketAdapter.html @@ -0,0 +1,665 @@ + + + + + + +WebSocketAdapter + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket +
+Class WebSocketAdapter

+
+java.lang.Object
+  extended by org.java_websocket.WebSocketAdapter
+
+
+
All Implemented Interfaces:
WebSocketListener
+
+
+
Direct Known Subclasses:
WebSocketClient, WebSocketServer
+
+
+
+
public abstract class WebSocketAdapter
extends java.lang.Object
implements WebSocketListener
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface org.java_websocket.WebSocketListener
WebSocketListener.MessageType
+  + + + + + + + + + + + +
+Constructor Summary
WebSocketAdapter() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconnectTiming(java.util.Date startTime, + java.util.Date endTime) + +
+          This default implementation does not do anything.
+ java.lang.StringgetFlashPolicy(WebSocket conn) + +
+          Gets the XML string that should be returned if a client requests a Flash + security policy.
+ voidmessageReceiveTiming(java.util.Date startTime, + java.util.Date endTime, + WebSocketListener.MessageType type, + int bytesAmount) + +
+          This default implementation does not do anything.
+ voidmessageSendTiming(java.util.Date startTime, + java.util.Date endTime, + WebSocketListener.MessageType type, + int bytesAmount) + +
+          This default implementation does not do anything.
+ voidonWebsocketClose(WebSocket conn, + int code, + java.lang.String reason, + boolean remote) + +
+          This default implementation does not do anything.
+ voidonWebsocketError(WebSocket conn, + java.lang.Exception ex) + +
+          This default implementation does not do anything.
+ voidonWebsocketHandshakeReceivedAsClient(WebSocket conn, + ClientHandshake request, + ServerHandshake response) + +
+          This default implementation does not do anything which will cause connections to be accepted.
+ ServerHandshakeBuilderonWebsocketHandshakeReceivedAsServer(WebSocket conn, + Draft draft, + ClientHandshake request) + +
+          This default implementation does not do anything.
+ voidonWebsocketHandshakeSentAsClient(WebSocket conn, + ClientHandshake request) + +
+          This default implementation does not do anything which will cause the connections to always progress.
+ voidonWebsocketMessage(WebSocket conn, + byte[] blob) + +
+          This default implementation does not do anything.
+ voidonWebsocketMessage(WebSocket conn, + java.lang.String message) + +
+          This default implementation does not do anything.
+ voidonWebsocketOpen(WebSocket conn, + Handshakedata handshake) + +
+          This default implementation does not do anything.
+ voidonWebsocketPing(WebSocket conn, + Framedata f) + +
+          This default implementation will send a pong in response to the received ping.
+ voidonWebsocketPong(WebSocket conn, + Framedata f) + +
+          This default implementation does not do anything.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface org.java_websocket.WebSocketListener
onWriteDemand
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WebSocketAdapter

+
+public WebSocketAdapter()
+
+
+ + + + + + + + +
+Method Detail
+ +

+onWebsocketHandshakeReceivedAsServer

+
+public ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer(WebSocket conn,
+                                                                   Draft draft,
+                                                                   ClientHandshake request)
+                                                            throws InvalidDataException
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketHandshakeReceivedAsServer in interface WebSocketListener
+
+
+
Parameters:
conn - The WebSocket related to this event
draft - The protocol draft the client uses to connect
request - The opening http message send by the client. Can be used to access additional fields like cookies. +
Returns:
Returns an incomplete handshake containing all optional fields +
Throws: +
InvalidDataException - Throwing this exception will cause this handshake to be rejected
See Also:
WebSocketListener.onWebsocketHandshakeReceivedAsServer(WebSocket, Draft, ClientHandshake)
+
+
+
+ +

+onWebsocketHandshakeReceivedAsClient

+
+public void onWebsocketHandshakeReceivedAsClient(WebSocket conn,
+                                                 ClientHandshake request,
+                                                 ServerHandshake response)
+                                          throws InvalidDataException
+
+
This default implementation does not do anything which will cause connections to be accepted. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketHandshakeReceivedAsClient in interface WebSocketListener
+
+
+
Parameters:
conn - The WebSocket related to this event
request - The handshake initially send out to the server by this websocket.
response - The handshake the server sent in response to the request. +
Throws: +
InvalidDataException - Allows the client to reject the connection with the server in respect of its handshake response.
See Also:
WebSocketListener.onWebsocketHandshakeReceivedAsClient(WebSocket, ClientHandshake, ServerHandshake)
+
+
+
+ +

+onWebsocketHandshakeSentAsClient

+
+public void onWebsocketHandshakeSentAsClient(WebSocket conn,
+                                             ClientHandshake request)
+                                      throws InvalidDataException
+
+
This default implementation does not do anything which will cause the connections to always progress. +

+

+
Specified by:
onWebsocketHandshakeSentAsClient in interface WebSocketListener
+
+
+
Parameters:
conn - The WebSocket related to this event
request - The handshake sent to the server by this websocket +
Throws: +
InvalidDataException - Allows the client to stop the connection from progressing
See Also:
WebSocketListener.onWebsocketHandshakeSentAsClient(WebSocket, ClientHandshake)
+
+
+
+ +

+onWebsocketMessage

+
+public void onWebsocketMessage(WebSocket conn,
+                               java.lang.String message)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketMessage in interface WebSocketListener
+
+
+
Parameters:
conn - The WebSocket instance this event is occurring on.
message - The UTF-8 decoded message that was received.
See Also:
WebSocketListener.onWebsocketMessage(WebSocket, String)
+
+
+
+ +

+onWebsocketOpen

+
+public void onWebsocketOpen(WebSocket conn,
+                            Handshakedata handshake)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketOpen in interface WebSocketListener
+
+
+
Parameters:
conn - The WebSocket instance this event is occuring on.
See Also:
WebSocketListener.onWebsocketOpen(WebSocket, Handshakedata)
+
+
+
+ +

+onWebsocketClose

+
+public void onWebsocketClose(WebSocket conn,
+                             int code,
+                             java.lang.String reason,
+                             boolean remote)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketClose in interface WebSocketListener
+
+
+
Parameters:
conn - The WebSocket instance this event is occuring on.
See Also:
WebSocketListener.onWebsocketClose(WebSocket, int, String, boolean)
+
+
+
+ +

+onWebsocketMessage

+
+public void onWebsocketMessage(WebSocket conn,
+                               byte[] blob)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketMessage in interface WebSocketListener
+
+
+
Parameters:
conn - The WebSocket instance this event is occurring on.
blob - The binary message that was received.
See Also:
WebSocketListener.onWebsocketMessage(WebSocket, byte[])
+
+
+
+ +

+onWebsocketPing

+
+public void onWebsocketPing(WebSocket conn,
+                            Framedata f)
+
+
This default implementation will send a pong in response to the received ping. + The pong frame will have the same payload as the ping frame. +

+

+
Specified by:
onWebsocketPing in interface WebSocketListener
+
+
+
f - The ping frame. Control frames may contain payload.
See Also:
WebSocketListener.onWebsocketPing(WebSocket, Framedata)
+
+
+
+ +

+onWebsocketPong

+
+public void onWebsocketPong(WebSocket conn,
+                            Framedata f)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketPong in interface WebSocketListener
+
+
+
See Also:
WebSocketListener.onWebsocketPong(WebSocket, Framedata)
+
+
+
+ +

+getFlashPolicy

+
+public java.lang.String getFlashPolicy(WebSocket conn)
+
+
Gets the XML string that should be returned if a client requests a Flash + security policy. + + The default implementation allows access from all remote domains, but + only on the port that this WebSocketServer is listening on. + + This is specifically implemented for gitime's WebSocket client for Flash: + http://github.com/gimite/web-socket-js +

+

+
Specified by:
getFlashPolicy in interface WebSocketListener
+
+
+ +
Returns:
An XML String that comforms to Flash's security policy. You MUST + not include the null char at the end, it is appended automatically.
+
+
+
+ +

+onWebsocketError

+
+public void onWebsocketError(WebSocket conn,
+                             java.lang.Exception ex)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketError in interface WebSocketListener
+
+
+
ex - The exception that occurred.
+ Might be null if the exception is not related to any specific connection. For example if the server port could not be bound.
See Also:
WebSocketListener.onWebsocketError(WebSocket, Exception)
+
+
+
+ +

+connectTiming

+
+public void connectTiming(java.util.Date startTime,
+                          java.util.Date endTime)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
connectTiming in interface WebSocketListener
+
+
+
Parameters:
startTime - Time at which the socket started connecting
endTime - Time at which the socket connection was established
See Also:
WebSocketListener.connectTiming(Date startTime, Date endTime)
+
+
+
+ +

+messageSendTiming

+
+public void messageSendTiming(java.util.Date startTime,
+                              java.util.Date endTime,
+                              WebSocketListener.MessageType type,
+                              int bytesAmount)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
messageSendTiming in interface WebSocketListener
+
+
+
Parameters:
startTime - Time at which it started sending a message
endTime - Time at which if finished sending that message
type - Type of message sent
bytesAmount - Amount of bytes sent
See Also:
WebSocketListener.messageSendTiming(Date startTime, Date endTime, MessageType type, int bytesAmount)
+
+
+
+ +

+messageReceiveTiming

+
+public void messageReceiveTiming(java.util.Date startTime,
+                                 java.util.Date endTime,
+                                 WebSocketListener.MessageType type,
+                                 int bytesAmount)
+
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
messageReceiveTiming in interface WebSocketListener
+
+
+
Parameters:
startTime - Time at which it started receiving a message
endTime - Time at which if finished receiving that message
type - Type of message sent
bytesAmount - Amount of bytes received
See Also:
WebSocketListener.messageReceiveTiming(Date startTime, Date endTime, MessageType type, int bytesAmount)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/WebSocketClient.html b/doc/org/java_websocket/WebSocketClient.html new file mode 100644 index 000000000..6387dd5df --- /dev/null +++ b/doc/org/java_websocket/WebSocketClient.html @@ -0,0 +1,872 @@ + + + + + + +WebSocketClient + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket +
+Class WebSocketClient

+
+java.lang.Object
+  extended by org.java_websocket.WebSocketAdapter
+      extended by org.java_websocket.WebSocketClient
+
+
+
All Implemented Interfaces:
java.lang.Runnable, WebSocketListener
+
+
+
+
public abstract class WebSocketClient
extends WebSocketAdapter
implements java.lang.Runnable
+ + +

+The WebSocketClient is an abstract class that expects a valid + "ws://" URI to connect to. When connected, an instance recieves important + events related to the life of the connection. A subclass must implement + onOpen, onClose, and onMessage to be + useful. An instance can send messages to it's connected server via the + send method. +

+ +

+

+
Author:
+
Nathan Rajlich
+
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface org.java_websocket.WebSocketListener
WebSocketListener.MessageType
+  + + + + + + + + + + + + + + +
+Constructor Summary
WebSocketClient(java.net.URI serverURI) + +
+           
WebSocketClient(java.net.URI serverUri, + Draft draft) + +
+          Constructs a WebSocketClient instance and sets it to the connect to the + specified URI.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidclose() + +
+           
+ voidconnect() + +
+          Starts a background thread that attempts and maintains a WebSocket + connection to the URI specified in the constructor or via setURI.
+ voidflush() + +
+           
+ longgetBufferedAmount() + +
+          Amount of data buffered/queued but not sent yet.
+ WebSocketgetConnection() + +
+           
+ DraftgetDraft() + +
+          Returns the protocol version this client uses.
+ intgetReadyState() + +
+          Retrieve the WebSocket 'readyState'.
+ java.net.URIgetURI() + +
+          Gets the URI that this WebSocketClient is connected to.
+protected  voidinterruptableRun() + +
+           
+abstract  voidonClose(int code, + java.lang.String reason, + boolean remote) + +
+           
+abstract  voidonError(java.lang.Exception ex) + +
+           
+ voidonMessage(byte[] bytes) + +
+           
+abstract  voidonMessage(java.lang.String message) + +
+           
+abstract  voidonOpen(ServerHandshake handshakedata) + +
+           
+ voidonWebsocketClose(WebSocket conn, + int code, + java.lang.String reason, + boolean remote) + +
+          Calls subclass' implementation of onClose.
+ voidonWebsocketError(WebSocket conn, + java.lang.Exception ex) + +
+          Calls subclass' implementation of onIOError.
+ voidonWebsocketMessage(WebSocket conn, + byte[] blob) + +
+          This default implementation does not do anything.
+ voidonWebsocketMessage(WebSocket conn, + java.lang.String message) + +
+          Calls subclass' implementation of onMessage.
+ voidonWebsocketOpen(WebSocket conn, + Handshakedata handshake) + +
+          Calls subclass' implementation of onOpen.
+ voidonWriteDemand(WebSocket conn) + +
+          This method is used to inform the selector thread that there is data queued to be written to the socket.
+ voidrun() + +
+           
+ voidsend(byte[] data) + +
+          Sends data to the connected WebSocket server.
+ voidsend(java.lang.String text) + +
+          Sends text to the connected WebSocket server.
+  + + + + + + + +
Methods inherited from class org.java_websocket.WebSocketAdapter
connectTiming, getFlashPolicy, messageReceiveTiming, messageSendTiming, onWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeReceivedAsServer, onWebsocketHandshakeSentAsClient, onWebsocketPing, onWebsocketPong
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WebSocketClient

+
+public WebSocketClient(java.net.URI serverURI)
+
+
+
+ +

+WebSocketClient

+
+public WebSocketClient(java.net.URI serverUri,
+                       Draft draft)
+
+
Constructs a WebSocketClient instance and sets it to the connect to the + specified URI. The client does not attampt to connect automatically. You + must call connect first to initiate the socket connection. +

+

+ + + + + + + + +
+Method Detail
+ +

+getURI

+
+public java.net.URI getURI()
+
+
Gets the URI that this WebSocketClient is connected to. +

+

+
+
+
+ +
Returns:
The URI for this WebSocketClient.
+
+
+
+ +

+getDraft

+
+public Draft getDraft()
+
+
Returns the protocol version this client uses. +

+

+
+
+
+
+
+
+
+ +

+connect

+
+public void connect()
+
+
Starts a background thread that attempts and maintains a WebSocket + connection to the URI specified in the constructor or via setURI. + setURI. +

+

+
+
+
+
+
+
+
+ +

+close

+
+public void close()
+
+
+
+
+
+
+
+
+
+ +

+send

+
+public void send(java.lang.String text)
+          throws java.nio.channels.NotYetConnectedException,
+                 java.lang.InterruptedException
+
+
Sends text to the connected WebSocket server. +

+

+
+
+
+
Parameters:
text - The String to send to the WebSocket server. +
Throws: +
java.nio.channels.NotYetConnectedException +
java.lang.InterruptedException
+
+
+
+ +

+send

+
+public void send(byte[] data)
+          throws java.nio.channels.NotYetConnectedException,
+                 java.lang.InterruptedException
+
+
Sends data to the connected WebSocket server. +

+

+
+
+
+
Parameters:
data - The Byte-Array of data to send to the WebSocket server. +
Throws: +
java.nio.channels.NotYetConnectedException +
java.lang.InterruptedException
+
+
+
+ +

+run

+
+public void run()
+
+
+
Specified by:
run in interface java.lang.Runnable
+
+
+
+
+
+
+ +

+interruptableRun

+
+protected final void interruptableRun()
+
+
+
+
+
+
+
+
+
+ +

+flush

+
+public void flush()
+
+
+
+
+
+
+
+
+
+ +

+getReadyState

+
+public int getReadyState()
+
+
Retrieve the WebSocket 'readyState'. + This represents the state of the connection. + It returns a numerical value, as per W3C WebSockets specs. +

+

+
+
+
+ +
Returns:
Returns '0 = CONNECTING', '1 = OPEN', '2 = CLOSING' or '3 = CLOSED'
+
+
+
+ +

+getBufferedAmount

+
+public long getBufferedAmount()
+
+
Amount of data buffered/queued but not sent yet. + + In details, it returns the number of bytes of application data (UTF-8 text and binary data) + that have been queued using send() but that, as of the last time the event loop + started executing a task, had not yet been transmitted to the network. +

+

+
+
+
+ +
Returns:
Amount still buffered/queued but not sent yet.
+
+
+
+ +

+onWebsocketMessage

+
+public final void onWebsocketMessage(WebSocket conn,
+                                     java.lang.String message)
+
+
Calls subclass' implementation of onMessage. +

+

+
Specified by:
onWebsocketMessage in interface WebSocketListener
Overrides:
onWebsocketMessage in class WebSocketAdapter
+
+
+
Parameters:
conn -
message -
See Also:
WebSocketListener.onWebsocketMessage(WebSocket, String)
+
+
+
+ +

+onWebsocketMessage

+
+public final void onWebsocketMessage(WebSocket conn,
+                                     byte[] blob)
+
+
Description copied from class: WebSocketAdapter
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketMessage in interface WebSocketListener
Overrides:
onWebsocketMessage in class WebSocketAdapter
+
+
+
Parameters:
conn - The WebSocket instance this event is occurring on.
blob - The binary message that was received.
See Also:
WebSocketListener.onWebsocketMessage(WebSocket, byte[])
+
+
+
+ +

+onWebsocketOpen

+
+public final void onWebsocketOpen(WebSocket conn,
+                                  Handshakedata handshake)
+
+
Calls subclass' implementation of onOpen. +

+

+
Specified by:
onWebsocketOpen in interface WebSocketListener
Overrides:
onWebsocketOpen in class WebSocketAdapter
+
+
+
Parameters:
conn -
See Also:
WebSocketListener.onWebsocketOpen(WebSocket, Handshakedata)
+
+
+
+ +

+onWebsocketClose

+
+public final void onWebsocketClose(WebSocket conn,
+                                   int code,
+                                   java.lang.String reason,
+                                   boolean remote)
+
+
Calls subclass' implementation of onClose. +

+

+
Specified by:
onWebsocketClose in interface WebSocketListener
Overrides:
onWebsocketClose in class WebSocketAdapter
+
+
+
Parameters:
conn -
See Also:
WebSocketListener.onWebsocketClose(WebSocket, int, String, boolean)
+
+
+
+ +

+onWebsocketError

+
+public final void onWebsocketError(WebSocket conn,
+                                   java.lang.Exception ex)
+
+
Calls subclass' implementation of onIOError. +

+

+
Specified by:
onWebsocketError in interface WebSocketListener
Overrides:
onWebsocketError in class WebSocketAdapter
+
+
+
Parameters:
conn -
ex - The exception that occurred.
+ Might be null if the exception is not related to any specific connection. For example if the server port could not be bound.
See Also:
WebSocketListener.onWebsocketError(WebSocket, Exception)
+
+
+
+ +

+onWriteDemand

+
+public final void onWriteDemand(WebSocket conn)
+
+
Description copied from interface: WebSocketListener
+
This method is used to inform the selector thread that there is data queued to be written to the socket. +

+

+
Specified by:
onWriteDemand in interface WebSocketListener
+
+
+
+
+
+
+ +

+getConnection

+
+public WebSocket getConnection()
+
+
+
+
+
+
+
+
+
+ +

+onOpen

+
+public abstract void onOpen(ServerHandshake handshakedata)
+
+
+
+
+
+
+
+
+
+ +

+onMessage

+
+public abstract void onMessage(java.lang.String message)
+
+
+
+
+
+
+
+
+
+ +

+onClose

+
+public abstract void onClose(int code,
+                             java.lang.String reason,
+                             boolean remote)
+
+
+
+
+
+
+
+
+
+ +

+onError

+
+public abstract void onError(java.lang.Exception ex)
+
+
+
+
+
+
+
+
+
+ +

+onMessage

+
+public void onMessage(byte[] bytes)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/WebSocketListener.MessageType.html b/doc/org/java_websocket/WebSocketListener.MessageType.html new file mode 100644 index 000000000..534c07084 --- /dev/null +++ b/doc/org/java_websocket/WebSocketListener.MessageType.html @@ -0,0 +1,355 @@ + + + + + + +WebSocketListener.MessageType + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +org.java_websocket +
+Enum WebSocketListener.MessageType

+
+java.lang.Object
+  extended by java.lang.Enum<WebSocketListener.MessageType>
+      extended by org.java_websocket.WebSocketListener.MessageType
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<WebSocketListener.MessageType>
+
+
+
Enclosing interface:
WebSocketListener
+
+
+
+
public static enum WebSocketListener.MessageType
extends java.lang.Enum<WebSocketListener.MessageType>
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
BINARY + +
+           
CLOSE + +
+           
HANDSHAKE + +
+           
TEXT + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static WebSocketListener.MessageTypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static WebSocketListener.MessageType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+HANDSHAKE

+
+public static final WebSocketListener.MessageType HANDSHAKE
+
+
+
+
+
+ +

+CLOSE

+
+public static final WebSocketListener.MessageType CLOSE
+
+
+
+
+
+ +

+TEXT

+
+public static final WebSocketListener.MessageType TEXT
+
+
+
+
+
+ +

+BINARY

+
+public static final WebSocketListener.MessageType BINARY
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static WebSocketListener.MessageType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (WebSocketListener.MessageType c : WebSocketListener.MessageType.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static WebSocketListener.MessageType valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name +
java.lang.NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/WebSocketListener.html b/doc/org/java_websocket/WebSocketListener.html new file mode 100644 index 000000000..ecb5799f5 --- /dev/null +++ b/doc/org/java_websocket/WebSocketListener.html @@ -0,0 +1,598 @@ + + + + + + +WebSocketListener + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket +
+Interface WebSocketListener

+
+
All Known Implementing Classes:
WebSocketAdapter, WebSocketClient, WebSocketServer
+
+
+
+
public interface WebSocketListener
+ + +

+Implemented by WebSocketClient and WebSocketServer. + The methods within are called by WebSocket. + Almost every method takes a first parameter conn which represents the source of the respective event. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classWebSocketListener.MessageType + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidconnectTiming(java.util.Date startTime, + java.util.Date endTime) + +
+          Informs the Listener how long it took to open a socket connection
+ java.lang.StringgetFlashPolicy(WebSocket conn) + +
+          Gets the XML string that should be returned if a client requests a Flash + security policy.
+ voidmessageReceiveTiming(java.util.Date startTime, + java.util.Date endTime, + WebSocketListener.MessageType type, + int bytesAmount) + +
+          Informs the Listener how long it took to receive a Message.
+ voidmessageSendTiming(java.util.Date startTime, + java.util.Date endTime, + WebSocketListener.MessageType type, + int bytesAmount) + +
+          Informs the Listener how long it took to send a Message.
+ voidonWebsocketClose(WebSocket conn, + int code, + java.lang.String reason, + boolean remote) + +
+          Called after WebSocket#close is explicity called, or when the + other end of the WebSocket connection is closed.
+ voidonWebsocketError(WebSocket conn, + java.lang.Exception ex) + +
+          Called if an exception worth noting occurred.
+ voidonWebsocketHandshakeReceivedAsClient(WebSocket conn, + ClientHandshake request, + ServerHandshake response) + +
+          Called on the client side when the socket connection is first established, and the WebSocket + handshake response has been received.
+ ServerHandshakeBuilderonWebsocketHandshakeReceivedAsServer(WebSocket conn, + Draft draft, + ClientHandshake request) + +
+          Called on the server side when the socket connection is first established, and the WebSocket + handshake has been received.
+ voidonWebsocketHandshakeSentAsClient(WebSocket conn, + ClientHandshake request) + +
+          Called on the client side when the socket connection is first established, and the WebSocket + handshake has just been sent.
+ voidonWebsocketMessage(WebSocket conn, + byte[] blob) + +
+          Called when an entire binary frame has been received.
+ voidonWebsocketMessage(WebSocket conn, + java.lang.String message) + +
+          Called when an entire text frame has been received.
+ voidonWebsocketOpen(WebSocket conn, + Handshakedata d) + +
+          Called after onHandshakeReceived returns true.
+ voidonWebsocketPing(WebSocket conn, + Framedata f) + +
+          Called a ping frame has been received.
+ voidonWebsocketPong(WebSocket conn, + Framedata f) + +
+          Called when a pong frame is received.
+ voidonWriteDemand(WebSocket conn) + +
+          This method is used to inform the selector thread that there is data queued to be written to the socket.
+  +

+ + + + + + + + +
+Method Detail
+ +

+onWebsocketHandshakeReceivedAsServer

+
+ServerHandshakeBuilder onWebsocketHandshakeReceivedAsServer(WebSocket conn,
+                                                            Draft draft,
+                                                            ClientHandshake request)
+                                                            throws InvalidDataException
+
+
Called on the server side when the socket connection is first established, and the WebSocket + handshake has been received. +

+

+
Parameters:
conn - The WebSocket related to this event
draft - The protocol draft the client uses to connect
request - The opening http message send by the client. Can be used to access additional fields like cookies. +
Returns:
Returns an incomplete handshake containing all optional fields +
Throws: +
InvalidDataException - Throwing this exception will cause this handshake to be rejected
+
+
+
+ +

+onWebsocketHandshakeReceivedAsClient

+
+void onWebsocketHandshakeReceivedAsClient(WebSocket conn,
+                                          ClientHandshake request,
+                                          ServerHandshake response)
+                                          throws InvalidDataException
+
+
Called on the client side when the socket connection is first established, and the WebSocket + handshake response has been received. +

+

+
Parameters:
conn - The WebSocket related to this event
request - The handshake initially send out to the server by this websocket.
response - The handshake the server sent in response to the request. +
Throws: +
InvalidDataException - Allows the client to reject the connection with the server in respect of its handshake response.
+
+
+
+ +

+onWebsocketHandshakeSentAsClient

+
+void onWebsocketHandshakeSentAsClient(WebSocket conn,
+                                      ClientHandshake request)
+                                      throws InvalidDataException
+
+
Called on the client side when the socket connection is first established, and the WebSocket + handshake has just been sent. +

+

+
Parameters:
conn - The WebSocket related to this event
request - The handshake sent to the server by this websocket +
Throws: +
InvalidDataException - Allows the client to stop the connection from progressing
+
+
+
+ +

+onWebsocketMessage

+
+void onWebsocketMessage(WebSocket conn,
+                        java.lang.String message)
+
+
Called when an entire text frame has been received. Do whatever you want + here... +

+

+
Parameters:
conn - The WebSocket instance this event is occurring on.
message - The UTF-8 decoded message that was received.
+
+
+
+ +

+onWebsocketMessage

+
+void onWebsocketMessage(WebSocket conn,
+                        byte[] blob)
+
+
Called when an entire binary frame has been received. Do whatever you want + here... +

+

+
Parameters:
conn - The WebSocket instance this event is occurring on.
blob - The binary message that was received.
+
+
+
+ +

+onWebsocketOpen

+
+void onWebsocketOpen(WebSocket conn,
+                     Handshakedata d)
+
+
Called after onHandshakeReceived returns true. + Indicates that a complete WebSocket connection has been established, + and we are ready to send/receive data. +

+

+
Parameters:
conn - The WebSocket instance this event is occuring on.
+
+
+
+ +

+onWebsocketClose

+
+void onWebsocketClose(WebSocket conn,
+                      int code,
+                      java.lang.String reason,
+                      boolean remote)
+
+
Called after WebSocket#close is explicity called, or when the + other end of the WebSocket connection is closed. +

+

+
Parameters:
conn - The WebSocket instance this event is occuring on.
+
+
+
+ +

+onWebsocketError

+
+void onWebsocketError(WebSocket conn,
+                      java.lang.Exception ex)
+
+
Called if an exception worth noting occurred. + If an error causes the connection to fail onClose will be called additionally afterwards. +

+

+
Parameters:
ex - The exception that occurred.
+ Might be null if the exception is not related to any specific connection. For example if the server port could not be bound.
+
+
+
+ +

+onWebsocketPing

+
+void onWebsocketPing(WebSocket conn,
+                     Framedata f)
+
+
Called a ping frame has been received. + This method must send a corresponding pong by itself. +

+

+
Parameters:
f - The ping frame. Control frames may contain payload.
+
+
+
+ +

+onWebsocketPong

+
+void onWebsocketPong(WebSocket conn,
+                     Framedata f)
+
+
Called when a pong frame is received. +

+

+
+
+
+
+ +

+getFlashPolicy

+
+java.lang.String getFlashPolicy(WebSocket conn)
+
+
Gets the XML string that should be returned if a client requests a Flash + security policy. +

+

+
+
+
+
+ +

+onWriteDemand

+
+void onWriteDemand(WebSocket conn)
+
+
This method is used to inform the selector thread that there is data queued to be written to the socket. +

+

+
+
+
+
+ +

+connectTiming

+
+void connectTiming(java.util.Date startTime,
+                   java.util.Date endTime)
+
+
Informs the Listener how long it took to open a socket connection +

+

+
Parameters:
startTime - Time at which the socket started connecting
endTime - Time at which the socket connection was established
+
+
+
+ +

+messageSendTiming

+
+void messageSendTiming(java.util.Date startTime,
+                       java.util.Date endTime,
+                       WebSocketListener.MessageType type,
+                       int bytesAmount)
+
+
Informs the Listener how long it took to send a Message. + This will also inform about how long it took to send the initial WebSocket HTTP Handshake. +

+

+
Parameters:
startTime - Time at which it started sending a message
endTime - Time at which if finished sending that message
type - Type of message sent
bytesAmount - Amount of bytes sent
+
+
+
+ +

+messageReceiveTiming

+
+void messageReceiveTiming(java.util.Date startTime,
+                          java.util.Date endTime,
+                          WebSocketListener.MessageType type,
+                          int bytesAmount)
+
+
Informs the Listener how long it took to receive a Message. + This will also inform about how long it took to receive the initial WebSocket HTTP Handshake. + Time is measured from when data are ready/waiting to be read on the socket. +

+

+
Parameters:
startTime - Time at which it started receiving a message
endTime - Time at which if finished receiving that message
type - Type of message sent
bytesAmount - Amount of bytes received
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/WebSocketServer.html b/doc/org/java_websocket/WebSocketServer.html new file mode 100644 index 000000000..8cf86b1d2 --- /dev/null +++ b/doc/org/java_websocket/WebSocketServer.html @@ -0,0 +1,842 @@ + + + + + + +WebSocketServer + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket +
+Class WebSocketServer

+
+java.lang.Object
+  extended by org.java_websocket.WebSocketAdapter
+      extended by org.java_websocket.WebSocketServer
+
+
+
All Implemented Interfaces:
java.lang.Runnable, WebSocketListener
+
+
+
+
public abstract class WebSocketServer
extends WebSocketAdapter
implements java.lang.Runnable
+ + +

+WebSocketServer is an abstract class that only takes care of the + HTTP handshake portion of WebSockets. It's up to a subclass to add + functionality/purpose to the server. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface org.java_websocket.WebSocketListener
WebSocketListener.MessageType
+  + + + + + + + + + + + + + + + + + +
+Constructor Summary
WebSocketServer() + +
+          Nullary constructor.
WebSocketServer(java.net.InetSocketAddress address) + +
+          Creates a WebSocketServer that will attempt to bind/listen on the given address.
WebSocketServer(java.net.InetSocketAddress address, + Draft draft) + +
+          Creates a WebSocketServer that will attempt to bind/listen on the given address, + and comply with Draft version draft.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.Set<WebSocket>connections() + +
+          Returns a WebSocket[] of currently connected clients.
+ java.net.InetSocketAddressgetAddress() + +
+           
+ DraftgetDraft() + +
+           
+protected  java.lang.StringgetFlashSecurityPolicy() + +
+          Gets the XML string that should be returned if a client requests a Flash + security policy.
+ intgetPort() + +
+          Gets the port number that this server listens on.
+abstract  voidonClose(WebSocket conn, + int code, + java.lang.String reason, + boolean remote) + +
+           
+abstract  voidonError(WebSocket conn, + java.lang.Exception ex) + +
+           
+ voidonMessage(WebSocket conn, + byte[] message) + +
+           
+abstract  voidonMessage(WebSocket conn, + java.lang.String message) + +
+           
+abstract  voidonOpen(WebSocket conn, + ClientHandshake handshake) + +
+           
+ voidonWebsocketClose(WebSocket conn, + int code, + java.lang.String reason, + boolean remote) + +
+          This default implementation does not do anything.
+ voidonWebsocketError(WebSocket conn, + java.lang.Exception ex) + +
+          This default implementation does not do anything.
+ voidonWebsocketMessage(WebSocket conn, + byte[] blob) + +
+          This default implementation does not do anything.
+ voidonWebsocketMessage(WebSocket conn, + java.lang.String message) + +
+          This default implementation does not do anything.
+ voidonWebsocketOpen(WebSocket conn, + Handshakedata handshake) + +
+          This default implementation does not do anything.
+ voidonWriteDemand(WebSocket conn) + +
+          This method is used to inform the selector thread that there is data queued to be written to the socket.
+ voidrun() + +
+           
+ voidsetAddress(java.net.InetSocketAddress address) + +
+          Sets the address (host:port) that this WebSocketServer should listen on.
+ voidstart() + +
+          Starts the server thread that binds to the currently set port number and + listeners for WebSocket connection requests.
+ voidstop() + +
+          Closes all connected clients sockets, then closes the underlying + ServerSocketChannel, effectively killing the server socket thread and + freeing the port the server was bound to.
+  + + + + + + + +
Methods inherited from class org.java_websocket.WebSocketAdapter
connectTiming, getFlashPolicy, messageReceiveTiming, messageSendTiming, onWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeReceivedAsServer, onWebsocketHandshakeSentAsClient, onWebsocketPing, onWebsocketPong
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WebSocketServer

+
+public WebSocketServer()
+                throws java.net.UnknownHostException
+
+
Nullary constructor. Creates a WebSocketServer that will attempt to + listen on port WebSocket.DEFAULT_PORT. +

+

+ +
Throws: +
java.net.UnknownHostException
+
+
+ +

+WebSocketServer

+
+public WebSocketServer(java.net.InetSocketAddress address)
+
+
Creates a WebSocketServer that will attempt to bind/listen on the given address. +

+

+
Parameters:
address - The address (host:port) this server should listen on.
+
+
+ +

+WebSocketServer

+
+public WebSocketServer(java.net.InetSocketAddress address,
+                       Draft draft)
+
+
Creates a WebSocketServer that will attempt to bind/listen on the given address, + and comply with Draft version draft. +

+

+
Parameters:
address - The address (host:port) this server should listen on.
draft - The version of the WebSocket protocol that this server + instance should comply to.
+
+ + + + + + + + +
+Method Detail
+ +

+start

+
+public void start()
+
+
Starts the server thread that binds to the currently set port number and + listeners for WebSocket connection requests. +

+

+
+
+
+ +
Throws: +
java.lang.IllegalStateException
+
+
+
+ +

+stop

+
+public void stop()
+          throws java.io.IOException
+
+
Closes all connected clients sockets, then closes the underlying + ServerSocketChannel, effectively killing the server socket thread and + freeing the port the server was bound to. +

+

+
+
+
+ +
Throws: +
java.io.IOException - When socket related I/O errors occur.
+
+
+
+ +

+connections

+
+public java.util.Set<WebSocket> connections()
+
+
Returns a WebSocket[] of currently connected clients. + Its iterators will be failfast and its not judicious + to modify it. +

+

+
+
+
+ +
Returns:
The currently connected clients.
+
+
+
+ +

+setAddress

+
+public void setAddress(java.net.InetSocketAddress address)
+
+
Sets the address (host:port) that this WebSocketServer should listen on. +

+

+
+
+
+
Parameters:
address - The address (host:port) to listen on.
+
+
+
+ +

+getAddress

+
+public java.net.InetSocketAddress getAddress()
+
+
+
+
+
+
+
+
+
+ +

+getPort

+
+public int getPort()
+
+
Gets the port number that this server listens on. +

+

+
+
+
+ +
Returns:
The port number.
+
+
+
+ +

+getDraft

+
+public Draft getDraft()
+
+
+
+
+
+
+
+
+
+ +

+run

+
+public void run()
+
+
+
Specified by:
run in interface java.lang.Runnable
+
+
+
+
+
+
+ +

+getFlashSecurityPolicy

+
+protected java.lang.String getFlashSecurityPolicy()
+
+
Gets the XML string that should be returned if a client requests a Flash + security policy. + + The default implementation allows access from all remote domains, but + only on the port that this WebSocketServer is listening on. + + This is specifically implemented for gitime's WebSocket client for Flash: + http://github.com/gimite/web-socket-js +

+

+
+
+
+ +
Returns:
An XML String that comforms to Flash's security policy. You MUST + not include the null char at the end, it is appended automatically.
+
+
+
+ +

+onWebsocketMessage

+
+public final void onWebsocketMessage(WebSocket conn,
+                                     java.lang.String message)
+
+
Description copied from class: WebSocketAdapter
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketMessage in interface WebSocketListener
Overrides:
onWebsocketMessage in class WebSocketAdapter
+
+
+
Parameters:
conn - The WebSocket instance this event is occurring on.
message - The UTF-8 decoded message that was received.
See Also:
WebSocketListener.onWebsocketMessage(WebSocket, String)
+
+
+
+ +

+onWebsocketMessage

+
+public final void onWebsocketMessage(WebSocket conn,
+                                     byte[] blob)
+
+
Description copied from class: WebSocketAdapter
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketMessage in interface WebSocketListener
Overrides:
onWebsocketMessage in class WebSocketAdapter
+
+
+
Parameters:
conn - The WebSocket instance this event is occurring on.
blob - The binary message that was received.
See Also:
WebSocketListener.onWebsocketMessage(WebSocket, byte[])
+
+
+
+ +

+onWebsocketOpen

+
+public final void onWebsocketOpen(WebSocket conn,
+                                  Handshakedata handshake)
+
+
Description copied from class: WebSocketAdapter
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketOpen in interface WebSocketListener
Overrides:
onWebsocketOpen in class WebSocketAdapter
+
+
+
Parameters:
conn - The WebSocket instance this event is occuring on.
See Also:
WebSocketListener.onWebsocketOpen(WebSocket, Handshakedata)
+
+
+
+ +

+onWebsocketClose

+
+public final void onWebsocketClose(WebSocket conn,
+                                   int code,
+                                   java.lang.String reason,
+                                   boolean remote)
+
+
Description copied from class: WebSocketAdapter
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketClose in interface WebSocketListener
Overrides:
onWebsocketClose in class WebSocketAdapter
+
+
+
Parameters:
conn - The WebSocket instance this event is occuring on.
See Also:
WebSocketListener.onWebsocketClose(WebSocket, int, String, boolean)
+
+
+
+ +

+onWebsocketError

+
+public final void onWebsocketError(WebSocket conn,
+                                   java.lang.Exception ex)
+
+
Description copied from class: WebSocketAdapter
+
This default implementation does not do anything. Go ahead and overwrite it. +

+

+
Specified by:
onWebsocketError in interface WebSocketListener
Overrides:
onWebsocketError in class WebSocketAdapter
+
+
+
Parameters:
conn - may be null if the error does not belong to a single connection
ex - The exception that occurred.
+ Might be null if the exception is not related to any specific connection. For example if the server port could not be bound.
See Also:
WebSocketListener.onWebsocketError(WebSocket, Exception)
+
+
+
+ +

+onWriteDemand

+
+public final void onWriteDemand(WebSocket conn)
+
+
Description copied from interface: WebSocketListener
+
This method is used to inform the selector thread that there is data queued to be written to the socket. +

+

+
Specified by:
onWriteDemand in interface WebSocketListener
+
+
+
+
+
+
+ +

+onOpen

+
+public abstract void onOpen(WebSocket conn,
+                            ClientHandshake handshake)
+
+
+
+
+
+
+
+
+
+ +

+onClose

+
+public abstract void onClose(WebSocket conn,
+                             int code,
+                             java.lang.String reason,
+                             boolean remote)
+
+
+
+
+
+
+
+
+
+ +

+onMessage

+
+public abstract void onMessage(WebSocket conn,
+                               java.lang.String message)
+
+
+
+
+
+
+
+
+
+ +

+onError

+
+public abstract void onError(WebSocket conn,
+                             java.lang.Exception ex)
+
+
+
+
+
+
+
+
+
+ +

+onMessage

+
+public void onMessage(WebSocket conn,
+                      byte[] message)
+
+
+
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/net/tootallnate/websocket/WebSocket.Role.html b/doc/org/java_websocket/drafts/Draft.CloseHandshakeType.html similarity index 69% rename from doc/net/tootallnate/websocket/WebSocket.Role.html rename to doc/org/java_websocket/drafts/Draft.CloseHandshakeType.html index 18294d0b2..78e44559a 100644 --- a/doc/net/tootallnate/websocket/WebSocket.Role.html +++ b/doc/org/java_websocket/drafts/Draft.CloseHandshakeType.html @@ -2,12 +2,12 @@ - + -WebSocket.Role +Draft.CloseHandshakeType - + @@ -15,7 +15,7 @@ function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="WebSocket.Role"; + parent.document.title="Draft.CloseHandshakeType"; } } @@ -54,11 +54,11 @@ - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS - FRAMES   - NO FRAMES   + FRAMES   + NO FRAMES     + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket.drafts +
+Class Draft

+
+java.lang.Object
+  extended by org.java_websocket.drafts.Draft
+
+
+
Direct Known Subclasses:
Draft_10, Draft_75
+
+
+
+
public abstract class Draft
extends java.lang.Object
+ + +

+Base class for everything of a websocket specification which is not common such as the way the handshake is read or frames are transfered. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Nested Class Summary
+static classDraft.CloseHandshakeType + +
+           
+static classDraft.HandshakeState + +
+           
+  + + + + + + + + + + + + + + +
+Field Summary
+static byte[]FLASH_POLICY_REQUEST + +
+           
+protected  WebSocket.Rolerole + +
+          In some cases the handshake will be parsed different depending on whether
+  + + + + + + + + + + +
+Constructor Summary
Draft() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+abstract  Draft.HandshakeStateacceptHandshakeAsClient(ClientHandshake request, + ServerHandshake response) + +
+           
+abstract  Draft.HandshakeStateacceptHandshakeAsServer(ClientHandshake handshakedata) + +
+           
+protected  booleanbasicAccept(Handshakedata handshakedata) + +
+           
+ intcheckAlloc(int bytecount) + +
+           
+abstract  java.nio.ByteBuffercreateBinaryFrame(Framedata framedata) + +
+           
+abstract  java.util.List<Framedata>createFrames(byte[] binary, + boolean mask) + +
+           
+abstract  java.util.List<Framedata>createFrames(java.lang.String text, + boolean mask) + +
+           
+ java.util.List<java.nio.ByteBuffer>createHandshake(Handshakedata handshakedata, + WebSocket.Role ownrole) + +
+           
+ java.util.List<java.nio.ByteBuffer>createHandshake(Handshakedata handshakedata, + WebSocket.Role ownrole, + boolean withcontent) + +
+           
+abstract  Draft.CloseHandshakeTypegetCloseHandshakeType() + +
+           
+abstract  ClientHandshakeBuilderpostProcessHandshakeRequestAsClient(ClientHandshakeBuilder request) + +
+           
+abstract  HandshakeBuilderpostProcessHandshakeResponseAsServer(ClientHandshake request, + ServerHandshakeBuilder response) + +
+           
+static java.nio.ByteBufferreadLine(java.nio.ByteBuffer buf) + +
+           
+static java.lang.StringreadStringLine(java.nio.ByteBuffer buf) + +
+           
+abstract  voidreset() + +
+           
+ voidsetParseMode(WebSocket.Role role) + +
+           
+abstract  java.util.List<Framedata>translateFrame(java.nio.ByteBuffer buffer) + +
+           
+ HandshakedatatranslateHandshake(java.nio.ByteBuffer buf) + +
+           
+static HandshakeBuildertranslateHandshakeHttp(java.nio.ByteBuffer buf, + WebSocket.Role role) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+FLASH_POLICY_REQUEST

+
+public static final byte[] FLASH_POLICY_REQUEST
+
+
+
+
+
+ +

+role

+
+protected WebSocket.Role role
+
+
In some cases the handshake will be parsed different depending on whether +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Draft

+
+public Draft()
+
+
+ + + + + + + + +
+Method Detail
+ +

+readLine

+
+public static java.nio.ByteBuffer readLine(java.nio.ByteBuffer buf)
+
+
+
+
+
+
+ +

+readStringLine

+
+public static java.lang.String readStringLine(java.nio.ByteBuffer buf)
+
+
+
+
+
+
+ +

+translateHandshakeHttp

+
+public static HandshakeBuilder translateHandshakeHttp(java.nio.ByteBuffer buf,
+                                                      WebSocket.Role role)
+                                               throws InvalidHandshakeException
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+acceptHandshakeAsClient

+
+public abstract Draft.HandshakeState acceptHandshakeAsClient(ClientHandshake request,
+                                                             ServerHandshake response)
+                                                      throws InvalidHandshakeException
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+acceptHandshakeAsServer

+
+public abstract Draft.HandshakeState acceptHandshakeAsServer(ClientHandshake handshakedata)
+                                                      throws InvalidHandshakeException
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+basicAccept

+
+protected boolean basicAccept(Handshakedata handshakedata)
+
+
+
+
+
+
+ +

+createBinaryFrame

+
+public abstract java.nio.ByteBuffer createBinaryFrame(Framedata framedata)
+
+
+
+
+
+
+ +

+createFrames

+
+public abstract java.util.List<Framedata> createFrames(byte[] binary,
+                                                       boolean mask)
+
+
+
+
+
+
+ +

+createFrames

+
+public abstract java.util.List<Framedata> createFrames(java.lang.String text,
+                                                       boolean mask)
+
+
+
+
+
+
+ +

+reset

+
+public abstract void reset()
+
+
+
+
+
+
+ +

+createHandshake

+
+public java.util.List<java.nio.ByteBuffer> createHandshake(Handshakedata handshakedata,
+                                                           WebSocket.Role ownrole)
+
+
+
+
+
+
+ +

+createHandshake

+
+public java.util.List<java.nio.ByteBuffer> createHandshake(Handshakedata handshakedata,
+                                                           WebSocket.Role ownrole,
+                                                           boolean withcontent)
+
+
+
+
+
+
+ +

+postProcessHandshakeRequestAsClient

+
+public abstract ClientHandshakeBuilder postProcessHandshakeRequestAsClient(ClientHandshakeBuilder request)
+                                                                    throws InvalidHandshakeException
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+postProcessHandshakeResponseAsServer

+
+public abstract HandshakeBuilder postProcessHandshakeResponseAsServer(ClientHandshake request,
+                                                                      ServerHandshakeBuilder response)
+                                                               throws InvalidHandshakeException
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+translateFrame

+
+public abstract java.util.List<Framedata> translateFrame(java.nio.ByteBuffer buffer)
+                                                  throws InvalidDataException
+
+
+ +
Throws: +
InvalidDataException
+
+
+
+ +

+translateHandshake

+
+public Handshakedata translateHandshake(java.nio.ByteBuffer buf)
+                                 throws InvalidHandshakeException
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+checkAlloc

+
+public int checkAlloc(int bytecount)
+               throws LimitExedeedException,
+                      InvalidDataException
+
+
+ +
Throws: +
LimitExedeedException +
InvalidDataException
+
+
+
+ +

+setParseMode

+
+public void setParseMode(WebSocket.Role role)
+
+
+
+
+
+
+ +

+getCloseHandshakeType

+
+public abstract Draft.CloseHandshakeType getCloseHandshakeType()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/drafts/Draft_10.html b/doc/org/java_websocket/drafts/Draft_10.html new file mode 100644 index 000000000..599f1d858 --- /dev/null +++ b/doc/org/java_websocket/drafts/Draft_10.html @@ -0,0 +1,566 @@ + + + + + + +Draft_10 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket.drafts +
+Class Draft_10

+
+java.lang.Object
+  extended by org.java_websocket.drafts.Draft
+      extended by org.java_websocket.drafts.Draft_10
+
+
+
Direct Known Subclasses:
Draft_17
+
+
+
+
public class Draft_10
extends Draft
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class org.java_websocket.drafts.Draft
Draft.CloseHandshakeType, Draft.HandshakeState
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.java_websocket.drafts.Draft
FLASH_POLICY_REQUEST, role
+  + + + + + + + + + + +
+Constructor Summary
Draft_10() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Draft.HandshakeStateacceptHandshakeAsClient(ClientHandshake request, + ServerHandshake response) + +
+           
+ Draft.HandshakeStateacceptHandshakeAsServer(ClientHandshake handshakedata) + +
+           
+ java.nio.ByteBuffercreateBinaryFrame(Framedata framedata) + +
+           
+ java.util.List<Framedata>createFrames(byte[] binary, + boolean mask) + +
+           
+ java.util.List<Framedata>createFrames(java.lang.String text, + boolean mask) + +
+           
+ Draft.CloseHandshakeTypegetCloseHandshakeType() + +
+           
+ ClientHandshakeBuilderpostProcessHandshakeRequestAsClient(ClientHandshakeBuilder request) + +
+           
+ HandshakeBuilderpostProcessHandshakeResponseAsServer(ClientHandshake request, + ServerHandshakeBuilder response) + +
+           
+static intreadVersion(Handshakedata handshakedata) + +
+           
+ voidreset() + +
+           
+ java.util.List<Framedata>translateFrame(java.nio.ByteBuffer buffer) + +
+           
+ FramedatatranslateSingleFrame(java.nio.ByteBuffer buffer) + +
+           
+  + + + + + + + +
Methods inherited from class org.java_websocket.drafts.Draft
basicAccept, checkAlloc, createHandshake, createHandshake, readLine, readStringLine, setParseMode, translateHandshake, translateHandshakeHttp
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Draft_10

+
+public Draft_10()
+
+
+ + + + + + + + +
+Method Detail
+ +

+readVersion

+
+public static int readVersion(Handshakedata handshakedata)
+
+
+
+
+
+
+ +

+acceptHandshakeAsClient

+
+public Draft.HandshakeState acceptHandshakeAsClient(ClientHandshake request,
+                                                    ServerHandshake response)
+                                             throws InvalidHandshakeException
+
+
+
Specified by:
acceptHandshakeAsClient in class Draft
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+acceptHandshakeAsServer

+
+public Draft.HandshakeState acceptHandshakeAsServer(ClientHandshake handshakedata)
+                                             throws InvalidHandshakeException
+
+
+
Specified by:
acceptHandshakeAsServer in class Draft
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+createBinaryFrame

+
+public java.nio.ByteBuffer createBinaryFrame(Framedata framedata)
+
+
+
Specified by:
createBinaryFrame in class Draft
+
+
+
+
+
+
+ +

+createFrames

+
+public java.util.List<Framedata> createFrames(byte[] binary,
+                                              boolean mask)
+
+
+
Specified by:
createFrames in class Draft
+
+
+
+
+
+
+ +

+createFrames

+
+public java.util.List<Framedata> createFrames(java.lang.String text,
+                                              boolean mask)
+
+
+
Specified by:
createFrames in class Draft
+
+
+
+
+
+
+ +

+postProcessHandshakeRequestAsClient

+
+public ClientHandshakeBuilder postProcessHandshakeRequestAsClient(ClientHandshakeBuilder request)
+
+
+
Specified by:
postProcessHandshakeRequestAsClient in class Draft
+
+
+
+
+
+
+ +

+postProcessHandshakeResponseAsServer

+
+public HandshakeBuilder postProcessHandshakeResponseAsServer(ClientHandshake request,
+                                                             ServerHandshakeBuilder response)
+                                                      throws InvalidHandshakeException
+
+
+
Specified by:
postProcessHandshakeResponseAsServer in class Draft
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+translateFrame

+
+public java.util.List<Framedata> translateFrame(java.nio.ByteBuffer buffer)
+                                         throws LimitExedeedException,
+                                                InvalidDataException
+
+
+
Specified by:
translateFrame in class Draft
+
+
+ +
Throws: +
LimitExedeedException +
InvalidDataException
+
+
+
+ +

+translateSingleFrame

+
+public Framedata translateSingleFrame(java.nio.ByteBuffer buffer)
+                               throws org.java_websocket.drafts.Draft_10.IncompleteException,
+                                      InvalidDataException
+
+
+ +
Throws: +
org.java_websocket.drafts.Draft_10.IncompleteException +
InvalidDataException
+
+
+
+ +

+reset

+
+public void reset()
+
+
+
Specified by:
reset in class Draft
+
+
+
+
+
+
+ +

+getCloseHandshakeType

+
+public Draft.CloseHandshakeType getCloseHandshakeType()
+
+
+
Specified by:
getCloseHandshakeType in class Draft
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/drafts/Draft_17.html b/doc/org/java_websocket/drafts/Draft_17.html new file mode 100644 index 000000000..3181169fc --- /dev/null +++ b/doc/org/java_websocket/drafts/Draft_17.html @@ -0,0 +1,335 @@ + + + + + + +Draft_17 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket.drafts +
+Class Draft_17

+
+java.lang.Object
+  extended by org.java_websocket.drafts.Draft
+      extended by org.java_websocket.drafts.Draft_10
+          extended by org.java_websocket.drafts.Draft_17
+
+
+
+
public class Draft_17
extends Draft_10
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class org.java_websocket.drafts.Draft
Draft.CloseHandshakeType, Draft.HandshakeState
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.java_websocket.drafts.Draft
FLASH_POLICY_REQUEST, role
+  + + + + + + + + + + +
+Constructor Summary
Draft_17() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ Draft.HandshakeStateacceptHandshakeAsServer(ClientHandshake handshakedata) + +
+           
+ ClientHandshakeBuilderpostProcessHandshakeRequestAsClient(ClientHandshakeBuilder request) + +
+           
+  + + + + + + + +
Methods inherited from class org.java_websocket.drafts.Draft_10
acceptHandshakeAsClient, createBinaryFrame, createFrames, createFrames, getCloseHandshakeType, postProcessHandshakeResponseAsServer, readVersion, reset, translateFrame, translateSingleFrame
+  + + + + + + + +
Methods inherited from class org.java_websocket.drafts.Draft
basicAccept, checkAlloc, createHandshake, createHandshake, readLine, readStringLine, setParseMode, translateHandshake, translateHandshakeHttp
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Draft_17

+
+public Draft_17()
+
+
+ + + + + + + + +
+Method Detail
+ +

+acceptHandshakeAsServer

+
+public Draft.HandshakeState acceptHandshakeAsServer(ClientHandshake handshakedata)
+                                             throws InvalidHandshakeException
+
+
+
Overrides:
acceptHandshakeAsServer in class Draft_10
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+postProcessHandshakeRequestAsClient

+
+public ClientHandshakeBuilder postProcessHandshakeRequestAsClient(ClientHandshakeBuilder request)
+
+
+
Overrides:
postProcessHandshakeRequestAsClient in class Draft_10
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/drafts/Draft_75.html b/doc/org/java_websocket/drafts/Draft_75.html new file mode 100644 index 000000000..58e83d4b1 --- /dev/null +++ b/doc/org/java_websocket/drafts/Draft_75.html @@ -0,0 +1,683 @@ + + + + + + +Draft_75 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket.drafts +
+Class Draft_75

+
+java.lang.Object
+  extended by org.java_websocket.drafts.Draft
+      extended by org.java_websocket.drafts.Draft_75
+
+
+
Direct Known Subclasses:
Draft_76
+
+
+
+
public class Draft_75
extends Draft
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class org.java_websocket.drafts.Draft
Draft.CloseHandshakeType, Draft.HandshakeState
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static byteCR + +
+          The byte representing CR, or Carriage Return, or \r
+protected  java.nio.ByteBuffercurrentFrame + +
+           
+static byteEND_OF_FRAME + +
+          The byte representing the end of a WebSocket text frame.
+static byteLF + +
+          The byte representing LF, or Line Feed, or \n
+protected  booleanreadingState + +
+           
+protected  java.util.List<Framedata>readyframes + +
+           
+static byteSTART_OF_FRAME + +
+          The byte representing the beginning of a WebSocket text frame.
+  + + + + + + + +
Fields inherited from class org.java_websocket.drafts.Draft
FLASH_POLICY_REQUEST, role
+  + + + + + + + + + + +
+Constructor Summary
Draft_75() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Draft.HandshakeStateacceptHandshakeAsClient(ClientHandshake request, + ServerHandshake response) + +
+           
+ Draft.HandshakeStateacceptHandshakeAsServer(ClientHandshake handshakedata) + +
+           
+ java.nio.ByteBuffercreateBinaryFrame(Framedata framedata) + +
+           
+ java.util.List<Framedata>createFrames(byte[] binary, + boolean mask) + +
+           
+ java.util.List<Framedata>createFrames(java.lang.String text, + boolean mask) + +
+           
+ Draft.CloseHandshakeTypegetCloseHandshakeType() + +
+           
+ ClientHandshakeBuilderpostProcessHandshakeRequestAsClient(ClientHandshakeBuilder request) + +
+           
+ HandshakeBuilderpostProcessHandshakeResponseAsServer(ClientHandshake request, + ServerHandshakeBuilder response) + +
+           
+ voidreset() + +
+           
+ java.util.List<Framedata>translateFrame(java.nio.ByteBuffer buffer) + +
+           
+protected  java.util.List<Framedata>translateRegularFrame(java.nio.ByteBuffer buffer) + +
+           
+  + + + + + + + +
Methods inherited from class org.java_websocket.drafts.Draft
basicAccept, checkAlloc, createHandshake, createHandshake, readLine, readStringLine, setParseMode, translateHandshake, translateHandshakeHttp
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+CR

+
+public static final byte CR
+
+
The byte representing CR, or Carriage Return, or \r +

+

+
See Also:
Constant Field Values
+
+
+ +

+LF

+
+public static final byte LF
+
+
The byte representing LF, or Line Feed, or \n +

+

+
See Also:
Constant Field Values
+
+
+ +

+START_OF_FRAME

+
+public static final byte START_OF_FRAME
+
+
The byte representing the beginning of a WebSocket text frame. +

+

+
See Also:
Constant Field Values
+
+
+ +

+END_OF_FRAME

+
+public static final byte END_OF_FRAME
+
+
The byte representing the end of a WebSocket text frame. +

+

+
See Also:
Constant Field Values
+
+
+ +

+readingState

+
+protected boolean readingState
+
+
+
+
+
+ +

+readyframes

+
+protected java.util.List<Framedata> readyframes
+
+
+
+
+
+ +

+currentFrame

+
+protected java.nio.ByteBuffer currentFrame
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Draft_75

+
+public Draft_75()
+
+
+ + + + + + + + +
+Method Detail
+ +

+acceptHandshakeAsClient

+
+public Draft.HandshakeState acceptHandshakeAsClient(ClientHandshake request,
+                                                    ServerHandshake response)
+
+
+
Specified by:
acceptHandshakeAsClient in class Draft
+
+
+
+
+
+
+ +

+acceptHandshakeAsServer

+
+public Draft.HandshakeState acceptHandshakeAsServer(ClientHandshake handshakedata)
+
+
+
Specified by:
acceptHandshakeAsServer in class Draft
+
+
+
+
+
+
+ +

+createBinaryFrame

+
+public java.nio.ByteBuffer createBinaryFrame(Framedata framedata)
+
+
+
Specified by:
createBinaryFrame in class Draft
+
+
+
+
+
+
+ +

+createFrames

+
+public java.util.List<Framedata> createFrames(byte[] binary,
+                                              boolean mask)
+
+
+
Specified by:
createFrames in class Draft
+
+
+
+
+
+
+ +

+createFrames

+
+public java.util.List<Framedata> createFrames(java.lang.String text,
+                                              boolean mask)
+
+
+
Specified by:
createFrames in class Draft
+
+
+
+
+
+
+ +

+postProcessHandshakeRequestAsClient

+
+public ClientHandshakeBuilder postProcessHandshakeRequestAsClient(ClientHandshakeBuilder request)
+                                                           throws InvalidHandshakeException
+
+
+
Specified by:
postProcessHandshakeRequestAsClient in class Draft
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+postProcessHandshakeResponseAsServer

+
+public HandshakeBuilder postProcessHandshakeResponseAsServer(ClientHandshake request,
+                                                             ServerHandshakeBuilder response)
+                                                      throws InvalidHandshakeException
+
+
+
Specified by:
postProcessHandshakeResponseAsServer in class Draft
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+translateRegularFrame

+
+protected java.util.List<Framedata> translateRegularFrame(java.nio.ByteBuffer buffer)
+                                                   throws InvalidDataException
+
+
+ +
Throws: +
InvalidDataException
+
+
+
+ +

+translateFrame

+
+public java.util.List<Framedata> translateFrame(java.nio.ByteBuffer buffer)
+                                         throws InvalidDataException
+
+
+
Specified by:
translateFrame in class Draft
+
+
+ +
Throws: +
InvalidDataException
+
+
+
+ +

+reset

+
+public void reset()
+
+
+
Specified by:
reset in class Draft
+
+
+
+
+
+
+ +

+getCloseHandshakeType

+
+public Draft.CloseHandshakeType getCloseHandshakeType()
+
+
+
Specified by:
getCloseHandshakeType in class Draft
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/drafts/Draft_76.html b/doc/org/java_websocket/drafts/Draft_76.html new file mode 100644 index 000000000..f109f47c5 --- /dev/null +++ b/doc/org/java_websocket/drafts/Draft_76.html @@ -0,0 +1,512 @@ + + + + + + +Draft_76 + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket.drafts +
+Class Draft_76

+
+java.lang.Object
+  extended by org.java_websocket.drafts.Draft
+      extended by org.java_websocket.drafts.Draft_75
+          extended by org.java_websocket.drafts.Draft_76
+
+
+
+
public class Draft_76
extends Draft_75
+ + +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class org.java_websocket.drafts.Draft
Draft.CloseHandshakeType, Draft.HandshakeState
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.java_websocket.drafts.Draft_75
CR, currentFrame, END_OF_FRAME, LF, readingState, readyframes, START_OF_FRAME
+  + + + + + + + +
Fields inherited from class org.java_websocket.drafts.Draft
FLASH_POLICY_REQUEST, role
+  + + + + + + + + + + +
+Constructor Summary
Draft_76() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Draft.HandshakeStateacceptHandshakeAsClient(ClientHandshake request, + ServerHandshake response) + +
+           
+ Draft.HandshakeStateacceptHandshakeAsServer(ClientHandshake handshakedata) + +
+           
+ java.nio.ByteBuffercreateBinaryFrame(Framedata framedata) + +
+           
+static byte[]createChallenge(java.lang.String key1, + java.lang.String key2, + byte[] key3) + +
+           
+ Draft.CloseHandshakeTypegetCloseHandshakeType() + +
+           
+ ClientHandshakeBuilderpostProcessHandshakeRequestAsClient(ClientHandshakeBuilder request) + +
+           
+ HandshakeBuilderpostProcessHandshakeResponseAsServer(ClientHandshake request, + ServerHandshakeBuilder response) + +
+           
+ java.util.List<Framedata>translateFrame(java.nio.ByteBuffer buffer) + +
+           
+ HandshakedatatranslateHandshake(java.nio.ByteBuffer buf) + +
+           
+  + + + + + + + +
Methods inherited from class org.java_websocket.drafts.Draft_75
createFrames, createFrames, reset, translateRegularFrame
+  + + + + + + + +
Methods inherited from class org.java_websocket.drafts.Draft
basicAccept, checkAlloc, createHandshake, createHandshake, readLine, readStringLine, setParseMode, translateHandshakeHttp
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Draft_76

+
+public Draft_76()
+
+
+ + + + + + + + +
+Method Detail
+ +

+createChallenge

+
+public static byte[] createChallenge(java.lang.String key1,
+                                     java.lang.String key2,
+                                     byte[] key3)
+                              throws InvalidHandshakeException
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+acceptHandshakeAsClient

+
+public Draft.HandshakeState acceptHandshakeAsClient(ClientHandshake request,
+                                                    ServerHandshake response)
+
+
+
Overrides:
acceptHandshakeAsClient in class Draft_75
+
+
+
+
+
+
+ +

+acceptHandshakeAsServer

+
+public Draft.HandshakeState acceptHandshakeAsServer(ClientHandshake handshakedata)
+
+
+
Overrides:
acceptHandshakeAsServer in class Draft_75
+
+
+
+
+
+
+ +

+postProcessHandshakeRequestAsClient

+
+public ClientHandshakeBuilder postProcessHandshakeRequestAsClient(ClientHandshakeBuilder request)
+
+
+
Overrides:
postProcessHandshakeRequestAsClient in class Draft_75
+
+
+
+
+
+
+ +

+postProcessHandshakeResponseAsServer

+
+public HandshakeBuilder postProcessHandshakeResponseAsServer(ClientHandshake request,
+                                                             ServerHandshakeBuilder response)
+                                                      throws InvalidHandshakeException
+
+
+
Overrides:
postProcessHandshakeResponseAsServer in class Draft_75
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+translateHandshake

+
+public Handshakedata translateHandshake(java.nio.ByteBuffer buf)
+                                 throws InvalidHandshakeException
+
+
+
Overrides:
translateHandshake in class Draft
+
+
+ +
Throws: +
InvalidHandshakeException
+
+
+
+ +

+translateFrame

+
+public java.util.List<Framedata> translateFrame(java.nio.ByteBuffer buffer)
+                                         throws InvalidDataException
+
+
+
Overrides:
translateFrame in class Draft_75
+
+
+ +
Throws: +
InvalidDataException
+
+
+
+ +

+createBinaryFrame

+
+public java.nio.ByteBuffer createBinaryFrame(Framedata framedata)
+
+
+
Overrides:
createBinaryFrame in class Draft_75
+
+
+
+
+
+
+ +

+getCloseHandshakeType

+
+public Draft.CloseHandshakeType getCloseHandshakeType()
+
+
+
Overrides:
getCloseHandshakeType in class Draft_75
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/org/java_websocket/drafts/package-frame.html b/doc/org/java_websocket/drafts/package-frame.html new file mode 100644 index 000000000..db6ae3381 --- /dev/null +++ b/doc/org/java_websocket/drafts/package-frame.html @@ -0,0 +1,53 @@ + + + + + + +org.java_websocket.drafts + + + + + + + + + + + +org.java_websocket.drafts + + + + +
+Classes  + +
+Draft +
+Draft_10 +
+Draft_17 +
+Draft_75 +
+Draft_76
+ + + + + + +
+Enums  + +
+Draft.CloseHandshakeType +
+Draft.HandshakeState
+ + + + diff --git a/doc/org/java_websocket/drafts/package-summary.html b/doc/org/java_websocket/drafts/package-summary.html new file mode 100644 index 000000000..cdc88a857 --- /dev/null +++ b/doc/org/java_websocket/drafts/package-summary.html @@ -0,0 +1,189 @@ + + + + + + +org.java_websocket.drafts + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.java_websocket.drafts +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DraftBase class for everything of a websocket specification which is not common such as the way the handshake is read or frames are transfered.
Draft_10 
Draft_17 
Draft_75 
Draft_76 
+  + +

+ + + + + + + + + + + + + +
+Enum Summary
Draft.CloseHandshakeType 
Draft.HandshakeState 
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/net/tootallnate/websocket/package-tree.html b/doc/org/java_websocket/drafts/package-tree.html similarity index 52% rename from doc/net/tootallnate/websocket/package-tree.html rename to doc/org/java_websocket/drafts/package-tree.html index 138e36c98..bf3abd7a5 100644 --- a/doc/net/tootallnate/websocket/package-tree.html +++ b/doc/org/java_websocket/drafts/package-tree.html @@ -2,12 +2,12 @@ - + -net.tootallnate.websocket Class Hierarchy +org.java_websocket.drafts Class Hierarchy - + @@ -15,7 +15,7 @@ function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="net.tootallnate.websocket Class Hierarchy"; + parent.document.title="org.java_websocket.drafts Class Hierarchy"; } } @@ -54,10 +54,10 @@ - PREV  - NEXT + PREV  + NEXT - FRAMES   + FRAMES    NO FRAMES     @@ -87,15 +87,15 @@

-net.tootallnate.websocket.exeptions +org.java_websocket.exeptions
Class IncompleteHandshakeException

 java.lang.Object
-  extended by java.lang.Throwable
-      extended by java.lang.Exception
-          extended by java.lang.RuntimeException
-              extended by net.tootallnate.websocket.exeptions.IncompleteHandshakeException
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.java_websocket.exeptions.IncompleteHandshakeException
All Implemented Interfaces:
java.io.Serializable
@@ -107,7 +107,7 @@

-
See Also:
Serialized Form
+
See Also:
Serialized Form

@@ -121,26 +121,26 @@

Constructor Summary -IncompleteHandshakeException() +IncompleteHandshakeException()
            -IncompleteHandshakeException(java.lang.String message) +IncompleteHandshakeException(java.lang.String message)
            -IncompleteHandshakeException(java.lang.String message, +IncompleteHandshakeException(java.lang.String message, java.lang.Throwable cause)
            -IncompleteHandshakeException(java.lang.Throwable cause) +IncompleteHandshakeException(java.lang.Throwable cause)
            @@ -231,13 +231,13 @@

- + - - - + + +
Overview  Overview  Package   Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -249,19 +249,19 @@

 PREV CLASS  - NEXT CLASS + NEXT CLASS - FRAMES   + FRAMES    NO FRAMES     diff --git a/doc/org/java_websocket/exeptions/InvalidDataException.html b/doc/org/java_websocket/exeptions/InvalidDataException.html new file mode 100644 index 000000000..bff605c0d --- /dev/null +++ b/doc/org/java_websocket/exeptions/InvalidDataException.html @@ -0,0 +1,319 @@ + + + + + + +InvalidDataException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.java_websocket.exeptions +
+Class InvalidDataException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.java_websocket.exeptions.InvalidDataException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
Direct Known Subclasses:
InvalidFrameException, InvalidHandshakeException, LimitExedeedException
+
+
+
+
public class InvalidDataException
extends java.lang.Exception
+ + +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
InvalidDataException(int closecode) + +
+           
InvalidDataException(int closecode, + java.lang.String s) + +
+           
InvalidDataException(int closecode, + java.lang.String s, + java.lang.Throwable t) + +
+           
InvalidDataException(int closecode, + java.lang.Throwable t) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ intgetCloseCode() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+InvalidDataException

+
+public InvalidDataException(int closecode)
+
+
+
+ +

+InvalidDataException

+
+public InvalidDataException(int closecode,
+                            java.lang.String s)
+
+
+
+ +

+InvalidDataException

+
+public InvalidDataException(int closecode,
+                            java.lang.Throwable t)
+
+
+
+ +

+InvalidDataException

+
+public InvalidDataException(int closecode,
+                            java.lang.String s,
+                            java.lang.Throwable t)
+
+
+ + + + + + + + +
+Method Detail
+ +

+getCloseCode

+
+public int getCloseCode()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/net/tootallnate/websocket/exeptions/InvalidFrameException.html b/doc/org/java_websocket/exeptions/InvalidFrameException.html similarity index 63% rename from doc/net/tootallnate/websocket/exeptions/InvalidFrameException.html rename to doc/org/java_websocket/exeptions/InvalidFrameException.html index d2c5ff4a4..23e7a6aaa 100644 --- a/doc/net/tootallnate/websocket/exeptions/InvalidFrameException.html +++ b/doc/org/java_websocket/exeptions/InvalidFrameException.html @@ -2,14 +2,14 @@ - + InvalidFrameException - + - + @@ -75,7 +75,7 @@ - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD @@ -87,27 +87,27 @@

-net.tootallnate.websocket.exeptions +org.java_websocket.exeptions
Class InvalidFrameException

 java.lang.Object
-  extended by java.lang.Throwable
-      extended by java.lang.Exception
-          extended by net.tootallnate.websocket.exeptions.InvalidDataException
-              extended by net.tootallnate.websocket.exeptions.InvalidFrameException
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.java_websocket.exeptions.InvalidDataException
+              extended by org.java_websocket.exeptions.InvalidFrameException
All Implemented Interfaces:
java.io.Serializable
-
public class InvalidFrameException
extends InvalidDataException
+
public class InvalidFrameException
extends InvalidDataException

-
See Also:
Serialized Form
+
See Also:
Serialized Form

@@ -121,26 +121,26 @@

Constructor Summary -InvalidFrameException() +InvalidFrameException()
            -InvalidFrameException(java.lang.String arg0) +InvalidFrameException(java.lang.String arg0)
            -InvalidFrameException(java.lang.String arg0, +InvalidFrameException(java.lang.String arg0, java.lang.Throwable arg1)
            -InvalidFrameException(java.lang.Throwable arg0) +InvalidFrameException(java.lang.Throwable arg0)
            @@ -156,6 +156,15 @@

Method Summary +  + + + + + + + +
Methods inherited from class org.java_websocket.exeptions.InvalidDataException
getCloseCode
  @@ -231,13 +240,13 @@

- + - - - + + +
Overview  Overview  Package   Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -248,20 +257,20 @@

- PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS - FRAMES   + FRAMES    NO FRAMES     @@ -269,7 +278,7 @@

- SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/net/tootallnate/websocket/exeptions/InvalidHandshakeException.html b/doc/org/java_websocket/exeptions/InvalidHandshakeException.html similarity index 63% rename from doc/net/tootallnate/websocket/exeptions/InvalidHandshakeException.html rename to doc/org/java_websocket/exeptions/InvalidHandshakeException.html index 2863461ad..c5f784327 100644 --- a/doc/net/tootallnate/websocket/exeptions/InvalidHandshakeException.html +++ b/doc/org/java_websocket/exeptions/InvalidHandshakeException.html @@ -2,14 +2,14 @@ - + InvalidHandshakeException - + - + @@ -75,7 +75,7 @@ - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD @@ -87,27 +87,27 @@

-net.tootallnate.websocket.exeptions +org.java_websocket.exeptions
Class InvalidHandshakeException

 java.lang.Object
-  extended by java.lang.Throwable
-      extended by java.lang.Exception
-          extended by net.tootallnate.websocket.exeptions.InvalidDataException
-              extended by net.tootallnate.websocket.exeptions.InvalidHandshakeException
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.java_websocket.exeptions.InvalidDataException
+              extended by org.java_websocket.exeptions.InvalidHandshakeException
All Implemented Interfaces:
java.io.Serializable
-
public class InvalidHandshakeException
extends InvalidDataException
+
public class InvalidHandshakeException
extends InvalidDataException

-
See Also:
Serialized Form
+
See Also:
Serialized Form

@@ -121,26 +121,26 @@

Constructor Summary -InvalidHandshakeException() +InvalidHandshakeException()
            -InvalidHandshakeException(java.lang.String arg0) +InvalidHandshakeException(java.lang.String arg0)
            -InvalidHandshakeException(java.lang.String arg0, +InvalidHandshakeException(java.lang.String arg0, java.lang.Throwable arg1)
            -InvalidHandshakeException(java.lang.Throwable arg0) +InvalidHandshakeException(java.lang.Throwable arg0)
            @@ -156,6 +156,15 @@

Method Summary +  + + + + + + + +
Methods inherited from class org.java_websocket.exeptions.InvalidDataException
getCloseCode
  @@ -231,13 +240,13 @@

- + - - - + + +
Overview  Overview  Package   Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -248,20 +257,20 @@

- PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS - FRAMES   + FRAMES    NO FRAMES     @@ -269,7 +278,7 @@

- SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/net/tootallnate/websocket/exeptions/LimitExedeedException.html b/doc/org/java_websocket/exeptions/LimitExedeedException.html similarity index 61% rename from doc/net/tootallnate/websocket/exeptions/LimitExedeedException.html rename to doc/org/java_websocket/exeptions/LimitExedeedException.html index 8ae6b31da..e0b574832 100644 --- a/doc/net/tootallnate/websocket/exeptions/LimitExedeedException.html +++ b/doc/org/java_websocket/exeptions/LimitExedeedException.html @@ -2,14 +2,14 @@ - + LimitExedeedException - + - + @@ -75,7 +75,7 @@ - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD @@ -87,27 +87,27 @@

-net.tootallnate.websocket.exeptions +org.java_websocket.exeptions
Class LimitExedeedException

 java.lang.Object
-  extended by java.lang.Throwable
-      extended by java.lang.Exception
-          extended by net.tootallnate.websocket.exeptions.InvalidDataException
-              extended by net.tootallnate.websocket.exeptions.LimitExedeedException
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.java_websocket.exeptions.InvalidDataException
+              extended by org.java_websocket.exeptions.LimitExedeedException
All Implemented Interfaces:
java.io.Serializable
-
public class LimitExedeedException
extends InvalidDataException
+
public class LimitExedeedException
extends InvalidDataException

-
See Also:
Serialized Form
+
See Also:
Serialized Form

@@ -121,26 +121,13 @@

Constructor Summary -LimitExedeedException() +LimitExedeedException()
            -LimitExedeedException(java.lang.String s) - -
-            - - -LimitExedeedException(java.lang.String s, - java.lang.Throwable t) - -
-            - - -LimitExedeedException(java.lang.Throwable t) +LimitExedeedException(java.lang.String s)
            @@ -156,6 +143,15 @@

Method Summary +  + + + + + + + +
Methods inherited from class org.java_websocket.exeptions.InvalidDataException
getCloseCode
  @@ -201,23 +197,6 @@

public LimitExedeedException(java.lang.String s)
-
- -

-LimitExedeedException

-
-public LimitExedeedException(java.lang.Throwable t)
-
-
-
- -

-LimitExedeedException

-
-public LimitExedeedException(java.lang.String s,
-                             java.lang.Throwable t)
-
-
@@ -231,13 +210,13 @@

- + - - - + + +
Overview  Overview  Package   Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -248,20 +227,20 @@

- PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS - FRAMES   + FRAMES    NO FRAMES     @@ -269,7 +248,7 @@

- SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/net/tootallnate/websocket/exeptions/InvalidDataException.html b/doc/org/java_websocket/exeptions/NotSendableException.html similarity index 58% rename from doc/net/tootallnate/websocket/exeptions/InvalidDataException.html rename to doc/org/java_websocket/exeptions/NotSendableException.html index 9e24474f4..1697943d4 100644 --- a/doc/net/tootallnate/websocket/exeptions/InvalidDataException.html +++ b/doc/org/java_websocket/exeptions/NotSendableException.html @@ -2,20 +2,20 @@ - + -InvalidDataException +NotSendableException - + - + @@ -37,13 +37,13 @@ - + - - - + + +
Overview  Overview  Package   Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -54,20 +54,20 @@ - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS - FRAMES   - NO FRAMES   + FRAMES   + NO FRAMES     @@ -87,29 +87,27 @@

-net.tootallnate.websocket.exeptions +org.java_websocket.exeptions
-Class InvalidDataException

+Class NotSendableException

 java.lang.Object
-  extended by java.lang.Throwable
-      extended by java.lang.Exception
-          extended by net.tootallnate.websocket.exeptions.InvalidDataException
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.java_websocket.exeptions.NotSendableException
All Implemented Interfaces:
java.io.Serializable
-
-
Direct Known Subclasses:
InvalidFrameException, InvalidHandshakeException, LimitExedeedException
-
-
public class InvalidDataException
extends java.lang.Exception
+
public class NotSendableException
extends java.lang.RuntimeException

-
See Also:
Serialized Form
+
See Also:
Serialized Form

@@ -123,26 +121,26 @@

Constructor Summary -InvalidDataException() +NotSendableException()
            -InvalidDataException(java.lang.String arg0) +NotSendableException(java.lang.String message)
            -InvalidDataException(java.lang.String arg0, - java.lang.Throwable arg1) +NotSendableException(java.lang.String message, + java.lang.Throwable cause)
            -InvalidDataException(java.lang.Throwable arg0) +NotSendableException(java.lang.Throwable cause)
            @@ -189,35 +187,35 @@

-

-InvalidDataException

+

+NotSendableException

-public InvalidDataException()
+public NotSendableException()
-

-InvalidDataException

+

+NotSendableException

-public InvalidDataException(java.lang.String arg0)
+public NotSendableException(java.lang.String message)
-

-InvalidDataException

+

+NotSendableException

-public InvalidDataException(java.lang.Throwable arg0)
+public NotSendableException(java.lang.Throwable cause)
-

-InvalidDataException

+

+NotSendableException

-public InvalidDataException(java.lang.String arg0,
-                            java.lang.Throwable arg1)
+public NotSendableException(java.lang.String message, + java.lang.Throwable cause)
@@ -233,13 +231,13 @@

- + - - - + + +
Overview  Overview  Package   Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -250,20 +248,20 @@

- PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS - FRAMES   - NO FRAMES   + FRAMES   + NO FRAMES     diff --git a/doc/org/java_websocket/exeptions/package-frame.html b/doc/org/java_websocket/exeptions/package-frame.html new file mode 100644 index 000000000..4579f1ee9 --- /dev/null +++ b/doc/org/java_websocket/exeptions/package-frame.html @@ -0,0 +1,42 @@ + + + + + + +org.java_websocket.exeptions + + + + + + + + + + + +org.java_websocket.exeptions + + + + +
+Exceptions  + +
+IncompleteHandshakeException +
+InvalidDataException +
+InvalidFrameException +
+InvalidHandshakeException +
+LimitExedeedException +
+NotSendableException
+ + + + diff --git a/doc/net/tootallnate/websocket/exeptions/package-summary.html b/doc/org/java_websocket/exeptions/package-summary.html similarity index 56% rename from doc/net/tootallnate/websocket/exeptions/package-summary.html rename to doc/org/java_websocket/exeptions/package-summary.html index a45380165..515631f51 100644 --- a/doc/net/tootallnate/websocket/exeptions/package-summary.html +++ b/doc/org/java_websocket/exeptions/package-summary.html @@ -2,20 +2,20 @@ - + -net.tootallnate.websocket.exeptions +org.java_websocket.exeptions - + - + @@ -37,13 +37,13 @@ - + - - - + + +
Overview  Overview   Package  Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -54,20 +54,20 @@ - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE - FRAMES   + FRAMES    NO FRAMES     @@ -79,7 +79,7 @@

-Package net.tootallnate.websocket.exeptions +Package org.java_websocket.exeptions

@@ -88,23 +88,27 @@

Exception Summary

- + - + - + - + - + + + + +
IncompleteHandshakeExceptionIncompleteHandshakeException  
InvalidDataExceptionInvalidDataException  
InvalidFrameExceptionInvalidFrameException  
InvalidHandshakeExceptionInvalidHandshakeException  
LimitExedeedExceptionLimitExedeedException 
NotSendableException  
@@ -125,13 +129,13 @@

- + - - - + + +
Overview  Overview   Package  Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -142,20 +146,20 @@

- PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE - FRAMES   + FRAMES    NO FRAMES     diff --git a/doc/net/tootallnate/websocket/exeptions/package-tree.html b/doc/org/java_websocket/exeptions/package-tree.html similarity index 53% rename from doc/net/tootallnate/websocket/exeptions/package-tree.html rename to doc/org/java_websocket/exeptions/package-tree.html index 2aa85f80c..b1568dee7 100644 --- a/doc/net/tootallnate/websocket/exeptions/package-tree.html +++ b/doc/org/java_websocket/exeptions/package-tree.html @@ -2,20 +2,20 @@ - + -net.tootallnate.websocket.exeptions Class Hierarchy +org.java_websocket.exeptions Class Hierarchy - + - + @@ -37,13 +37,13 @@ - + - - - + + +
Overview  Overview  Package  Class   Tree  Deprecated  Index  Help  Deprecated  Index  Help 
@@ -54,20 +54,20 @@ - PREV  - NEXT + PREV  + NEXT - FRAMES   + FRAMES    NO FRAMES     @@ -80,11 +80,11 @@

-Hierarchy For Package net.tootallnate.websocket.exeptions +Hierarchy For Package org.java_websocket.exeptions

-
Package Hierarchies:
All Packages
+
Package Hierarchies:
All Packages

Class Hierarchy @@ -94,10 +94,10 @@

  • java.lang.Throwable (implements java.io.Serializable) @@ -114,13 +114,13 @@

    - + - - - + + +
    Overview  Overview  Package  Class   Tree  Deprecated  Index  Help  Deprecated  Index  Help 
    @@ -131,20 +131,20 @@

    - PREV  - NEXT + PREV  + NEXT - FRAMES   + FRAMES    NO FRAMES     diff --git a/doc/org/java_websocket/framing/CloseFrame.html b/doc/org/java_websocket/framing/CloseFrame.html new file mode 100644 index 000000000..72b8b0667 --- /dev/null +++ b/doc/org/java_websocket/framing/CloseFrame.html @@ -0,0 +1,586 @@ + + + + + + +CloseFrame + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.framing +
    +Interface CloseFrame

    +
    +
    All Superinterfaces:
    Framedata
    +
    +
    +
    All Known Implementing Classes:
    CloseFrameBuilder
    +
    +
    +
    +
    public interface CloseFrame
    extends Framedata
    + + +

    +

    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from interface org.java_websocket.framing.Framedata
    Framedata.Opcode
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +static intABNROMAL_CLOSE + +
    +          1006 is a reserved value and MUST NOT be set as a status code in a + Close control frame by an endpoint.
    +static intBUGGYCLOSE + +
    +           
    +static intEXTENSION + +
    +          1010 indicates that an endpoint (client) is terminating the + connection because it has expected the server to negotiate one or + more extension, but the server didn't return them in the response + message of the WebSocket handshake.
    +static intFLASHPOLICY + +
    +           
    +static intGOING_AWAY + +
    +          1001 indicates that an endpoint is "going away", such as a server + going down, or a browser having navigated away from a page.
    +static intNEVERCONNECTED + +
    +          The connection had never been established
    +static intNO_UTF8 + +
    +          1007 indicates that an endpoint is terminating the connection + because it has received data within a message that was not + consistent with the type of the message (e.g., non-UTF-8 [RFC3629] + data within a text message).
    +static intNOCODE + +
    +          1005 is a reserved value and MUST NOT be set as a status code in a + Close control frame by an endpoint.
    +static intNORMAL + +
    +          indicates a normal closure, meaning whatever purpose the + connection was established for has been fulfilled.
    +static intPOLICY_VALIDATION + +
    +          1008 indicates that an endpoint is terminating the connection + because it has received a message that violates its policy.
    +static intPROTOCOL_ERROR + +
    +          1002 indicates that an endpoint is terminating the connection due + to a protocol error.
    +static intREFUSE + +
    +          1003 indicates that an endpoint is terminating the connection + because it has received a type of data it cannot accept (e.g.
    +static intTOOBIG + +
    +          1009 indicates that an endpoint is terminating the connection + because it has received a message which is too big for it to + process.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + intgetCloseCode() + +
    +           
    + java.lang.StringgetMessage() + +
    +           
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.framing.Framedata
    append, getOpcode, getPayloadData, getTransfereMasked, isFin
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +NORMAL

    +
    +static final int NORMAL
    +
    +
    indicates a normal closure, meaning whatever purpose the + connection was established for has been fulfilled. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +GOING_AWAY

    +
    +static final int GOING_AWAY
    +
    +
    1001 indicates that an endpoint is "going away", such as a server + going down, or a browser having navigated away from a page. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +PROTOCOL_ERROR

    +
    +static final int PROTOCOL_ERROR
    +
    +
    1002 indicates that an endpoint is terminating the connection due + to a protocol error. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +REFUSE

    +
    +static final int REFUSE
    +
    +
    1003 indicates that an endpoint is terminating the connection + because it has received a type of data it cannot accept (e.g. an + endpoint that understands only text data MAY send this if it + receives a binary message). +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +NOCODE

    +
    +static final int NOCODE
    +
    +
    1005 is a reserved value and MUST NOT be set as a status code in a + Close control frame by an endpoint. It is designated for use in + applications expecting a status code to indicate that no status + code was actually present. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +ABNROMAL_CLOSE

    +
    +static final int ABNROMAL_CLOSE
    +
    +
    1006 is a reserved value and MUST NOT be set as a status code in a + Close control frame by an endpoint. It is designated for use in + applications expecting a status code to indicate that the + connection was closed abnormally, e.g. without sending or + receiving a Close control frame. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +NO_UTF8

    +
    +static final int NO_UTF8
    +
    +
    1007 indicates that an endpoint is terminating the connection + because it has received data within a message that was not + consistent with the type of the message (e.g., non-UTF-8 [RFC3629] + data within a text message). +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +POLICY_VALIDATION

    +
    +static final int POLICY_VALIDATION
    +
    +
    1008 indicates that an endpoint is terminating the connection + because it has received a message that violates its policy. This + is a generic status code that can be returned when there is no + other more suitable status code (e.g. 1003 or 1009), or if there + is a need to hide specific details about the policy. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +TOOBIG

    +
    +static final int TOOBIG
    +
    +
    1009 indicates that an endpoint is terminating the connection + because it has received a message which is too big for it to + process. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +EXTENSION

    +
    +static final int EXTENSION
    +
    +
    1010 indicates that an endpoint (client) is terminating the + connection because it has expected the server to negotiate one or + more extension, but the server didn't return them in the response + message of the WebSocket handshake. The list of extensions which + are needed SHOULD appear in the /reason/ part of the Close frame. + Note that this status code is not used by the server, because it + can fail the WebSocket handshake instead. +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +NEVERCONNECTED

    +
    +static final int NEVERCONNECTED
    +
    +
    The connection had never been established +

    +

    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +BUGGYCLOSE

    +
    +static final int BUGGYCLOSE
    +
    +
    +
    See Also:
    Constant Field Values
    +
    +
    + +

    +FLASHPOLICY

    +
    +static final int FLASHPOLICY
    +
    +
    +
    See Also:
    Constant Field Values
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getCloseCode

    +
    +int getCloseCode()
+                 throws InvalidFrameException
    +
    +
    +
    +
    +
    + +
    Throws: +
    InvalidFrameException
    +
    +
    +
    + +

    +getMessage

    +
    +java.lang.String getMessage()
+                            throws InvalidDataException
    +
    +
    +
    +
    +
    + +
    Throws: +
    InvalidDataException
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/org/java_websocket/framing/CloseFrameBuilder.html b/doc/org/java_websocket/framing/CloseFrameBuilder.html new file mode 100644 index 000000000..359e7e189 --- /dev/null +++ b/doc/org/java_websocket/framing/CloseFrameBuilder.html @@ -0,0 +1,452 @@ + + + + + + +CloseFrameBuilder + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.framing +
    +Class CloseFrameBuilder

    +
    +java.lang.Object
+  extended by org.java_websocket.framing.FramedataImpl1
+      extended by org.java_websocket.framing.CloseFrameBuilder
+
    +
    +
    All Implemented Interfaces:
    CloseFrame, FrameBuilder, Framedata
    +
    +
    +
    +
    public class CloseFrameBuilder
    extends FramedataImpl1
    implements CloseFrame
    + + +

    +

    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from interface org.java_websocket.framing.Framedata
    Framedata.Opcode
    +  + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from class org.java_websocket.framing.FramedataImpl1
    emptyarray, fin, optcode, transferemasked
    +  + + + + + + + +
    Fields inherited from interface org.java_websocket.framing.CloseFrame
    ABNROMAL_CLOSE, BUGGYCLOSE, EXTENSION, FLASHPOLICY, GOING_AWAY, NEVERCONNECTED, NO_UTF8, NOCODE, NORMAL, POLICY_VALIDATION, PROTOCOL_ERROR, REFUSE, TOOBIG
    +  + + + + + + + + + + + + + + + + +
    +Constructor Summary
    CloseFrameBuilder() + +
    +           
    CloseFrameBuilder(int code) + +
    +           
    CloseFrameBuilder(int code, + java.lang.String m) + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + intgetCloseCode() + +
    +           
    + java.lang.StringgetMessage() + +
    +           
    + byte[]getPayloadData() + +
    +           
    + voidsetPayload(byte[] payload) + +
    +           
    + java.lang.StringtoString() + +
    +           
    +  + + + + + + + +
    Methods inherited from class org.java_websocket.framing.FramedataImpl1
    append, getOpcode, getTransfereMasked, isFin, setFin, setOptcode, setTransferemasked
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.framing.Framedata
    append, getOpcode, getTransfereMasked, isFin
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +CloseFrameBuilder

    +
    +public CloseFrameBuilder()
    +
    +
    +
    + +

    +CloseFrameBuilder

    +
    +public CloseFrameBuilder(int code)
+                  throws InvalidDataException
    +
    +
    + +
    Throws: +
    InvalidDataException
    +
    +
    + +

    +CloseFrameBuilder

    +
    +public CloseFrameBuilder(int code,
+                         java.lang.String m)
+                  throws InvalidDataException
    +
    +
    + +
    Throws: +
    InvalidDataException
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getCloseCode

    +
    +public int getCloseCode()
    +
    +
    +
    Specified by:
    getCloseCode in interface CloseFrame
    +
    +
    +
    +
    +
    +
    + +

    +getMessage

    +
    +public java.lang.String getMessage()
    +
    +
    +
    Specified by:
    getMessage in interface CloseFrame
    +
    +
    +
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    +
    Overrides:
    toString in class FramedataImpl1
    +
    +
    +
    +
    +
    +
    + +

    +setPayload

    +
    +public void setPayload(byte[] payload)
+                throws InvalidDataException
    +
    +
    +
    Specified by:
    setPayload in interface FrameBuilder
    Overrides:
    setPayload in class FramedataImpl1
    +
    +
    + +
    Throws: +
    InvalidDataException
    +
    +
    +
    + +

    +getPayloadData

    +
    +public byte[] getPayloadData()
    +
    +
    +
    Specified by:
    getPayloadData in interface Framedata
    Overrides:
    getPayloadData in class FramedataImpl1
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/net/tootallnate/websocket/FrameBuilder.html b/doc/org/java_websocket/framing/FrameBuilder.html similarity index 67% rename from doc/net/tootallnate/websocket/FrameBuilder.html rename to doc/org/java_websocket/framing/FrameBuilder.html index c67c670d6..742abc76a 100644 --- a/doc/net/tootallnate/websocket/FrameBuilder.html +++ b/doc/org/java_websocket/framing/FrameBuilder.html @@ -2,12 +2,12 @@ - + FrameBuilder - + @@ -54,10 +54,10 @@ - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS     - FRAMES   + FRAMES    NO FRAMES     + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.framing +
    +Class FramedataImpl1

    +
    +java.lang.Object
+  extended by org.java_websocket.framing.FramedataImpl1
+
    +
    +
    All Implemented Interfaces:
    FrameBuilder, Framedata
    +
    +
    +
    Direct Known Subclasses:
    CloseFrameBuilder
    +
    +
    +
    +
    public class FramedataImpl1
    extends java.lang.Object
    implements FrameBuilder
    + + +

    +

    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + + + + + + +
    Nested classes/interfaces inherited from interface org.java_websocket.framing.Framedata
    Framedata.Opcode
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Field Summary
    +protected static byte[]emptyarray + +
    +           
    +protected  booleanfin + +
    +           
    +protected  Framedata.Opcodeoptcode + +
    +           
    +protected  booleantransferemasked + +
    +           
    +  + + + + + + + + + + + + + + + + +
    +Constructor Summary
    FramedataImpl1() + +
    +           
    FramedataImpl1(Framedata.Opcode op) + +
    +           
    FramedataImpl1(Framedata f) + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidappend(Framedata nextframe) + +
    +           
    + Framedata.OpcodegetOpcode() + +
    +           
    + byte[]getPayloadData() + +
    +           
    + booleangetTransfereMasked() + +
    +           
    + booleanisFin() + +
    +           
    + voidsetFin(boolean fin) + +
    +           
    + voidsetOptcode(Framedata.Opcode optcode) + +
    +           
    + voidsetPayload(byte[] payload) + +
    +           
    + voidsetTransferemasked(boolean transferemasked) + +
    +           
    + java.lang.StringtoString() + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +emptyarray

    +
    +protected static byte[] emptyarray
    +
    +
    +
    +
    +
    + +

    +fin

    +
    +protected boolean fin
    +
    +
    +
    +
    +
    + +

    +optcode

    +
    +protected Framedata.Opcode optcode
    +
    +
    +
    +
    +
    + +

    +transferemasked

    +
    +protected boolean transferemasked
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +FramedataImpl1

    +
    +public FramedataImpl1()
    +
    +
    +
    + +

    +FramedataImpl1

    +
    +public FramedataImpl1(Framedata.Opcode op)
    +
    +
    +
    + +

    +FramedataImpl1

    +
    +public FramedataImpl1(Framedata f)
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +isFin

    +
    +public boolean isFin()
    +
    +
    +
    Specified by:
    isFin in interface Framedata
    +
    +
    +
    +
    +
    +
    + +

    +getOpcode

    +
    +public Framedata.Opcode getOpcode()
    +
    +
    +
    Specified by:
    getOpcode in interface Framedata
    +
    +
    +
    +
    +
    +
    + +

    +getTransfereMasked

    +
    +public boolean getTransfereMasked()
    +
    +
    +
    Specified by:
    getTransfereMasked in interface Framedata
    +
    +
    +
    +
    +
    +
    + +

    +getPayloadData

    +
    +public byte[] getPayloadData()
    +
    +
    +
    Specified by:
    getPayloadData in interface Framedata
    +
    +
    +
    +
    +
    +
    + +

    +setFin

    +
    +public void setFin(boolean fin)
    +
    +
    +
    Specified by:
    setFin in interface FrameBuilder
    +
    +
    +
    +
    +
    +
    + +

    +setOptcode

    +
    +public void setOptcode(Framedata.Opcode optcode)
    +
    +
    +
    Specified by:
    setOptcode in interface FrameBuilder
    +
    +
    +
    +
    +
    +
    + +

    +setPayload

    +
    +public void setPayload(byte[] payload)
+                throws InvalidDataException
    +
    +
    +
    Specified by:
    setPayload in interface FrameBuilder
    +
    +
    + +
    Throws: +
    InvalidDataException
    +
    +
    +
    + +

    +setTransferemasked

    +
    +public void setTransferemasked(boolean transferemasked)
    +
    +
    +
    Specified by:
    setTransferemasked in interface FrameBuilder
    +
    +
    +
    +
    +
    +
    + +

    +append

    +
    +public void append(Framedata nextframe)
+            throws InvalidFrameException
    +
    +
    +
    Specified by:
    append in interface Framedata
    +
    +
    + +
    Throws: +
    InvalidFrameException
    +
    +
    +
    + +

    +toString

    +
    +public java.lang.String toString()
    +
    +
    +
    Overrides:
    toString in class java.lang.Object
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/org/java_websocket/framing/package-frame.html b/doc/org/java_websocket/framing/package-frame.html new file mode 100644 index 000000000..bb58127f3 --- /dev/null +++ b/doc/org/java_websocket/framing/package-frame.html @@ -0,0 +1,60 @@ + + + + + + +org.java_websocket.framing + + + + + + + + + + + +org.java_websocket.framing + + + + +
    +Interfaces  + +
    +CloseFrame +
    +FrameBuilder +
    +Framedata
    + + + + + + +
    +Classes  + +
    +CloseFrameBuilder +
    +FramedataImpl1
    + + + + + + +
    +Enums  + +
    +Framedata.Opcode
    + + + + diff --git a/doc/net/tootallnate/websocket/package-summary.html b/doc/org/java_websocket/framing/package-summary.html similarity index 52% rename from doc/net/tootallnate/websocket/package-summary.html rename to doc/org/java_websocket/framing/package-summary.html index 7b38f064e..6cc26fba6 100644 --- a/doc/net/tootallnate/websocket/package-summary.html +++ b/doc/org/java_websocket/framing/package-summary.html @@ -2,12 +2,12 @@ - + -net.tootallnate.websocket +org.java_websocket.framing - + @@ -15,7 +15,7 @@ function windowTitle() { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="net.tootallnate.websocket"; + parent.document.title="org.java_websocket.framing"; } } @@ -54,10 +54,10 @@ - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE     - FRAMES   + FRAMES    NO FRAMES     + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.java_websocket.framing +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +

    +Enum Hierarchy +

    +
      +
    • java.lang.Object
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
      +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/org/java_websocket/handshake/ClientHandshake.html b/doc/org/java_websocket/handshake/ClientHandshake.html new file mode 100644 index 000000000..dc4a99b46 --- /dev/null +++ b/doc/org/java_websocket/handshake/ClientHandshake.html @@ -0,0 +1,225 @@ + + + + + + +ClientHandshake + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.handshake +
    +Interface ClientHandshake

    +
    +
    All Superinterfaces:
    Handshakedata
    +
    +
    +
    All Known Subinterfaces:
    ClientHandshakeBuilder
    +
    +
    +
    All Known Implementing Classes:
    HandshakeImpl1Client
    +
    +
    +
    +
    public interface ClientHandshake
    extends Handshakedata
    + + +

    +

    + +

    + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetResourceDescriptor() + +
    +           
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.Handshakedata
    getContent, getFieldValue, hasFieldValue, iterateHttpFields
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getResourceDescriptor

    +
    +java.lang.String getResourceDescriptor()
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/org/java_websocket/handshake/ClientHandshakeBuilder.html b/doc/org/java_websocket/handshake/ClientHandshakeBuilder.html new file mode 100644 index 000000000..bff60d482 --- /dev/null +++ b/doc/org/java_websocket/handshake/ClientHandshakeBuilder.html @@ -0,0 +1,240 @@ + + + + + + +ClientHandshakeBuilder + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.handshake +
    +Interface ClientHandshakeBuilder

    +
    +
    All Superinterfaces:
    ClientHandshake, HandshakeBuilder, Handshakedata
    +
    +
    +
    All Known Implementing Classes:
    HandshakeImpl1Client
    +
    +
    +
    +
    public interface ClientHandshakeBuilder
    extends HandshakeBuilder, ClientHandshake
    + + +

    +

    + +

    + + + + + + + + + + + + +
    +Method Summary
    + voidsetResourceDescriptor(java.lang.String resourcedescriptor) + +
    +           
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.HandshakeBuilder
    put, setContent
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.ClientHandshake
    getResourceDescriptor
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.Handshakedata
    getContent, getFieldValue, hasFieldValue, iterateHttpFields
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setResourceDescriptor

    +
    +void setResourceDescriptor(java.lang.String resourcedescriptor)
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/net/tootallnate/websocket/HandshakeBuilder.html b/doc/org/java_websocket/handshake/HandshakeBuilder.html similarity index 65% rename from doc/net/tootallnate/websocket/HandshakeBuilder.html rename to doc/org/java_websocket/handshake/HandshakeBuilder.html index 8dd31f7f6..09f0e0f41 100644 --- a/doc/net/tootallnate/websocket/HandshakeBuilder.html +++ b/doc/org/java_websocket/handshake/HandshakeBuilder.html @@ -2,12 +2,12 @@ - + HandshakeBuilder - + @@ -54,10 +54,10 @@ - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS     - FRAMES   + FRAMES    NO FRAMES     + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.handshake +
    +Class HandshakeImpl1Client

    +
    +java.lang.Object
+  extended by org.java_websocket.handshake.HandshakedataImpl1
+      extended by org.java_websocket.handshake.HandshakeImpl1Client
+
    +
    +
    All Implemented Interfaces:
    ClientHandshake, ClientHandshakeBuilder, HandshakeBuilder, Handshakedata
    +
    +
    +
    +
    public class HandshakeImpl1Client
    extends HandshakedataImpl1
    implements ClientHandshakeBuilder
    + + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    HandshakeImpl1Client() + +
    +           
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + java.lang.StringgetResourceDescriptor() + +
    +           
    + voidsetResourceDescriptor(java.lang.String resourcedescriptor) + +
    +           
    +  + + + + + + + +
    Methods inherited from class org.java_websocket.handshake.HandshakedataImpl1
    getContent, getFieldValue, hasFieldValue, iterateHttpFields, put, setContent
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.HandshakeBuilder
    put, setContent
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.Handshakedata
    getContent, getFieldValue, hasFieldValue, iterateHttpFields
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +HandshakeImpl1Client

    +
    +public HandshakeImpl1Client()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setResourceDescriptor

    +
    +public void setResourceDescriptor(java.lang.String resourcedescriptor)
+                           throws java.lang.IllegalArgumentException
    +
    +
    +
    Specified by:
    setResourceDescriptor in interface ClientHandshakeBuilder
    +
    +
    + +
    Throws: +
    java.lang.IllegalArgumentException
    +
    +
    +
    + +

    +getResourceDescriptor

    +
    +public java.lang.String getResourceDescriptor()
    +
    +
    +
    Specified by:
    getResourceDescriptor in interface ClientHandshake
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/org/java_websocket/handshake/HandshakeImpl1Server.html b/doc/org/java_websocket/handshake/HandshakeImpl1Server.html new file mode 100644 index 000000000..61bcb68c0 --- /dev/null +++ b/doc/org/java_websocket/handshake/HandshakeImpl1Server.html @@ -0,0 +1,350 @@ + + + + + + +HandshakeImpl1Server + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.handshake +
    +Class HandshakeImpl1Server

    +
    +java.lang.Object
+  extended by org.java_websocket.handshake.HandshakedataImpl1
+      extended by org.java_websocket.handshake.HandshakeImpl1Server
+
    +
    +
    All Implemented Interfaces:
    HandshakeBuilder, Handshakedata, ServerHandshake, ServerHandshakeBuilder
    +
    +
    +
    +
    public class HandshakeImpl1Server
    extends HandshakedataImpl1
    implements ServerHandshakeBuilder
    + + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    HandshakeImpl1Server() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + shortgetHttpStatus() + +
    +           
    + java.lang.StringgetHttpStatusMessage() + +
    +           
    + voidsetHttpStatus(short status) + +
    +           
    + voidsetHttpStatusMessage(java.lang.String message) + +
    +           
    +  + + + + + + + +
    Methods inherited from class org.java_websocket.handshake.HandshakedataImpl1
    getContent, getFieldValue, hasFieldValue, iterateHttpFields, put, setContent
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.HandshakeBuilder
    put, setContent
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.Handshakedata
    getContent, getFieldValue, hasFieldValue, iterateHttpFields
    +  +

    + + + + + + + + +
    +Constructor Detail
    + +

    +HandshakeImpl1Server

    +
    +public HandshakeImpl1Server()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getHttpStatusMessage

    +
    +public java.lang.String getHttpStatusMessage()
    +
    +
    +
    Specified by:
    getHttpStatusMessage in interface ServerHandshake
    +
    +
    +
    +
    +
    +
    + +

    +getHttpStatus

    +
    +public short getHttpStatus()
    +
    +
    +
    Specified by:
    getHttpStatus in interface ServerHandshake
    +
    +
    +
    +
    +
    +
    + +

    +setHttpStatusMessage

    +
    +public void setHttpStatusMessage(java.lang.String message)
    +
    +
    +
    Specified by:
    setHttpStatusMessage in interface ServerHandshakeBuilder
    +
    +
    +
    +
    +
    +
    + +

    +setHttpStatus

    +
    +public void setHttpStatus(short status)
    +
    +
    +
    Specified by:
    setHttpStatus in interface ServerHandshakeBuilder
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/net/tootallnate/websocket/Handshakedata.html b/doc/org/java_websocket/handshake/Handshakedata.html similarity index 72% rename from doc/net/tootallnate/websocket/Handshakedata.html rename to doc/org/java_websocket/handshake/Handshakedata.html index ee8a70c94..21e2ef544 100644 --- a/doc/net/tootallnate/websocket/Handshakedata.html +++ b/doc/org/java_websocket/handshake/Handshakedata.html @@ -2,12 +2,12 @@ - + Handshakedata - + @@ -54,10 +54,10 @@ - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS     - FRAMES   + FRAMES    NO FRAMES     + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.handshake +
    +Interface ServerHandshake

    +
    +
    All Superinterfaces:
    Handshakedata
    +
    +
    +
    All Known Subinterfaces:
    ServerHandshakeBuilder
    +
    +
    +
    All Known Implementing Classes:
    HandshakeImpl1Server
    +
    +
    +
    +
    public interface ServerHandshake
    extends Handshakedata
    + + +

    +

    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + shortgetHttpStatus() + +
    +           
    + java.lang.StringgetHttpStatusMessage() + +
    +           
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.Handshakedata
    getContent, getFieldValue, hasFieldValue, iterateHttpFields
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getHttpStatus

    +
    +short getHttpStatus()
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + +

    +getHttpStatusMessage

    +
    +java.lang.String getHttpStatusMessage()
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/org/java_websocket/handshake/ServerHandshakeBuilder.html b/doc/org/java_websocket/handshake/ServerHandshakeBuilder.html new file mode 100644 index 000000000..93d5462aa --- /dev/null +++ b/doc/org/java_websocket/handshake/ServerHandshakeBuilder.html @@ -0,0 +1,262 @@ + + + + + + +ServerHandshakeBuilder + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.java_websocket.handshake +
    +Interface ServerHandshakeBuilder

    +
    +
    All Superinterfaces:
    HandshakeBuilder, Handshakedata, ServerHandshake
    +
    +
    +
    All Known Implementing Classes:
    HandshakeImpl1Server
    +
    +
    +
    +
    public interface ServerHandshakeBuilder
    extends HandshakeBuilder, ServerHandshake
    + + +

    +

    + +

    + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidsetHttpStatus(short status) + +
    +           
    + voidsetHttpStatusMessage(java.lang.String message) + +
    +           
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.HandshakeBuilder
    put, setContent
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.ServerHandshake
    getHttpStatus, getHttpStatusMessage
    +  + + + + + + + +
    Methods inherited from interface org.java_websocket.handshake.Handshakedata
    getContent, getFieldValue, hasFieldValue, iterateHttpFields
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +setHttpStatus

    +
    +void setHttpStatus(short status)
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + +

    +setHttpStatusMessage

    +
    +void setHttpStatusMessage(java.lang.String message)
    +
    +
    +
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package   Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + + + diff --git a/doc/org/java_websocket/handshake/package-frame.html b/doc/org/java_websocket/handshake/package-frame.html new file mode 100644 index 000000000..f0d1864a7 --- /dev/null +++ b/doc/org/java_websocket/handshake/package-frame.html @@ -0,0 +1,57 @@ + + + + + + +org.java_websocket.handshake + + + + + + + + + + + +org.java_websocket.handshake + + + + +
    +Interfaces  + +
    +ClientHandshake +
    +ClientHandshakeBuilder +
    +HandshakeBuilder +
    +Handshakedata +
    +ServerHandshake +
    +ServerHandshakeBuilder
    + + + + + + +
    +Classes  + +
    +HandshakedataImpl1 +
    +HandshakeImpl1Client +
    +HandshakeImpl1Server
    + + + + diff --git a/doc/org/java_websocket/handshake/package-summary.html b/doc/org/java_websocket/handshake/package-summary.html new file mode 100644 index 000000000..e3c83992d --- /dev/null +++ b/doc/org/java_websocket/handshake/package-summary.html @@ -0,0 +1,197 @@ + + + + + + +org.java_websocket.handshake + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.java_websocket.handshake +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Interface Summary
    ClientHandshake 
    ClientHandshakeBuilder 
    HandshakeBuilder 
    Handshakedata 
    ServerHandshake 
    ServerHandshakeBuilder 
    +  + +

    + + + + + + + + + + + + + + + + + +
    +Class Summary
    HandshakedataImpl1 
    HandshakeImpl1Client 
    HandshakeImpl1Server 
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/org/java_websocket/handshake/package-tree.html b/doc/org/java_websocket/handshake/package-tree.html new file mode 100644 index 000000000..73cddad0b --- /dev/null +++ b/doc/org/java_websocket/handshake/package-tree.html @@ -0,0 +1,173 @@ + + + + + + +org.java_websocket.handshake Class Hierarchy + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.java_websocket.handshake +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/org/java_websocket/package-frame.html b/doc/org/java_websocket/package-frame.html new file mode 100644 index 000000000..143727b1a --- /dev/null +++ b/doc/org/java_websocket/package-frame.html @@ -0,0 +1,62 @@ + + + + + + +org.java_websocket + + + + + + + + + + + +org.java_websocket + + + + +
    +Interfaces  + +
    +WebSocketListener
    + + + + + + +
    +Classes  + +
    +WebSocket +
    +WebSocketAdapter +
    +WebSocketClient +
    +WebSocketServer
    + + + + + + +
    +Enums  + +
    +WebSocket.Role +
    +WebSocketListener.MessageType
    + + + + diff --git a/doc/org/java_websocket/package-summary.html b/doc/org/java_websocket/package-summary.html new file mode 100644 index 000000000..24dc0425c --- /dev/null +++ b/doc/org/java_websocket/package-summary.html @@ -0,0 +1,201 @@ + + + + + + +org.java_websocket + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.java_websocket +

    + + + + + + + + + +
    +Interface Summary
    WebSocketListenerImplemented by WebSocketClient and WebSocketServer.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    WebSocketRepresents one end (client or server) of a single WebSocket connection.
    WebSocketAdapter 
    WebSocketClientThe WebSocketClient is an abstract class that expects a valid + "ws://" URI to connect to.
    WebSocketServerWebSocketServer is an abstract class that only takes care of the + HTTP handshake portion of WebSockets.
    +  + +

    + + + + + + + + + + + + + +
    +Enum Summary
    WebSocket.Role 
    WebSocketListener.MessageType 
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview   Package  Class  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/org/java_websocket/package-tree.html b/doc/org/java_websocket/package-tree.html new file mode 100644 index 000000000..b761a7c15 --- /dev/null +++ b/doc/org/java_websocket/package-tree.html @@ -0,0 +1,171 @@ + + + + + + +org.java_websocket Class Hierarchy + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.java_websocket +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +

    +Interface Hierarchy +

    + +

    +Enum Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Overview  Package  Class   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    + + + diff --git a/doc/net/tootallnate/websocket/Base64.InputStream.html b/doc/org/java_websocket/util/Base64.InputStream.html similarity index 78% rename from doc/net/tootallnate/websocket/Base64.InputStream.html rename to doc/org/java_websocket/util/Base64.InputStream.html index bbbae659b..3ee125976 100644 --- a/doc/net/tootallnate/websocket/Base64.InputStream.html +++ b/doc/org/java_websocket/util/Base64.InputStream.html @@ -2,12 +2,12 @@ - + Base64.InputStream - + @@ -54,10 +54,10 @@ - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS     - FRAMES   + FRAMES    NO FRAMES     @@ -37,13 +37,13 @@ - + - - - + + +
    Overview  Overview   Package  Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
    @@ -54,20 +54,20 @@ - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE     - FRAMES   + FRAMES    NO FRAMES     @@ -79,7 +79,7 @@

    -Package net.tootallnate.websocket.drafts +Package org.java_websocket.util

    @@ -88,19 +88,23 @@

    Class Summary

    - - + + - - + + - - + + - +
    Draft_10 Base64Encodes and decodes to and from Base64 notation.
    Draft_17 Base64.InputStreamA Base64.InputStream will read data from another + java.io.InputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly.
    Draft_75 Base64.OutputStreamA Base64.OutputStream will write data to another + java.io.OutputStream, given in the constructor, + and encode/decode to/from Base64 notation on the fly.
    Draft_76Charsetfunctions  
    @@ -121,13 +125,13 @@

    - + - - - + + +
    Overview  Overview   Package  Class  Tree  Deprecated  Index  Help  Deprecated  Index  Help 
    @@ -138,20 +142,20 @@

    - PREV PACKAGE  - NEXT PACKAGE + PREV PACKAGE  + NEXT PACKAGE - FRAMES   + FRAMES    NO FRAMES     diff --git a/doc/net/tootallnate/websocket/drafts/package-tree.html b/doc/org/java_websocket/util/package-tree.html similarity index 54% rename from doc/net/tootallnate/websocket/drafts/package-tree.html rename to doc/org/java_websocket/util/package-tree.html index 07aca3ebb..1c88dac65 100644 --- a/doc/net/tootallnate/websocket/drafts/package-tree.html +++ b/doc/org/java_websocket/util/package-tree.html @@ -2,20 +2,20 @@ - + -net.tootallnate.websocket.drafts Class Hierarchy +org.java_websocket.util Class Hierarchy - + - + @@ -37,13 +37,13 @@ - + - - - + + +
    Overview  Overview  Package  Class   Tree  Deprecated  Index  Help  Deprecated  Index  Help 
    @@ -54,20 +54,20 @@ - PREV  - NEXT + PREV  + NEXT     - FRAMES   + FRAMES    NO FRAMES     @@ -80,22 +80,26 @@

    -Hierarchy For Package net.tootallnate.websocket.drafts +Hierarchy For Package org.java_websocket.util

    -
    Package Hierarchies:
    All Packages
    +
    Package Hierarchies:
    All Packages

    Class Hierarchy

    -
  • net.tootallnate.websocket.WebSocket
  • net.tootallnate.websocket.WebSocketAdapter @@ -127,11 +135,23 @@

    Interface Hierarchy

    Enum Hierarchy

    @@ -139,7 +159,7 @@

  • java.lang.Object
    diff --git a/doc/package-list b/doc/package-list index 3ca4d5e90..c3b7bb5b3 100644 --- a/doc/package-list +++ b/doc/package-list @@ -1,3 +1,6 @@ -net.tootallnate.websocket -net.tootallnate.websocket.drafts -net.tootallnate.websocket.exeptions +org.java_websocket +org.java_websocket.drafts +org.java_websocket.exeptions +org.java_websocket.framing +org.java_websocket.handshake +org.java_websocket.util diff --git a/doc/serialized-form.html b/doc/serialized-form.html index 0a4831cfa..96073865f 100644 --- a/doc/serialized-form.html +++ b/doc/serialized-form.html @@ -2,12 +2,12 @@ - + Serialized Form - + @@ -87,60 +87,87 @@

    +Packageorg.java_websocket.exeptions
    -Package net.tootallnate.websocket.exeptions

    - + +Class org.java_websocket.exeptions.IncompleteHandshakeException extends java.lang.RuntimeException implements Serializable
    -Class net.tootallnate.websocket.exeptions.IncompleteHandshakeException extends java.lang.RuntimeException implements Serializable

    - + +Class org.java_websocket.exeptions.InvalidDataException extends java.lang.Exception implements Serializable + +
    -Class net.tootallnate.websocket.exeptions.InvalidDataException extends java.lang.Exception implements Serializable
    + +

    + + + + + +
    +Serialized Fields
    + +

    +closecode

    +
    +int closecode
    +
    +
    +
    +
    + +

    + + + +
    +Class org.java_websocket.exeptions.InvalidFrameException extends InvalidDataException implements Serializable

    - + +Class org.java_websocket.exeptions.InvalidHandshakeException extends InvalidDataException implements Serializable
    -Class net.tootallnate.websocket.exeptions.InvalidFrameException extends InvalidDataException implements Serializable

    - + +Class org.java_websocket.exeptions.LimitExedeedException extends InvalidDataException implements Serializable
    -Class net.tootallnate.websocket.exeptions.InvalidHandshakeException extends InvalidDataException implements Serializable

    - + +Class org.java_websocket.exeptions.NotSendableException extends java.lang.RuntimeException implements Serializable
    -Class net.tootallnate.websocket.exeptions.LimitExedeedException extends InvalidDataException implements Serializable
    diff --git a/src/org/java_websocket/WebSocket.java b/src/org/java_websocket/WebSocket.java index e93a204dc..1b69b51fa 100644 --- a/src/org/java_websocket/WebSocket.java +++ b/src/org/java_websocket/WebSocket.java @@ -7,6 +7,7 @@ import java.nio.channels.SocketChannel; import java.util.ArrayList; import java.util.Collection; +import java.util.Date; import java.util.List; import java.util.concurrent.BlockingQueue; import java.util.concurrent.LinkedBlockingQueue; @@ -33,6 +34,7 @@ import org.java_websocket.handshake.ServerHandshake; import org.java_websocket.handshake.ServerHandshakeBuilder; import org.java_websocket.util.Charsetfunctions; +import org.java_websocket.WebSocketListener.MessageType; /** * Represents one end (client or server) of a single WebSocket connection. @@ -161,6 +163,8 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket * @throws InterruptedException */ /*package public*/void handleRead() throws IOException { + Date receiveThenSendStartTime = new Date(); + if( !socketBuffer.hasRemaining() ) { socketBuffer.rewind(); socketBuffer.limit( socketBuffer.capacity() ); @@ -197,6 +201,7 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket return; } } + HandshakeState handshakestate = null; socketBuffer.mark(); try { @@ -214,6 +219,9 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket ClientHandshake handshake = (ClientHandshake) tmphandshake; handshakestate = d.acceptHandshakeAsServer( handshake ); if( handshakestate == HandshakeState.MATCHED ) { + // timing callback + wsl.messageReceiveTiming( receiveThenSendStartTime, new Date(), MessageType.HANDSHAKE, socketBuffer.limit() ); + ServerHandshakeBuilder response; try { response = wsl.onWebsocketHandshakeReceivedAsServer( this, d, handshake ); @@ -221,7 +229,16 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket closeConnection( e.getCloseCode(), e.getMessage(), false ); return; } - writeDirect( d.createHandshake( d.postProcessHandshakeResponseAsServer( handshake, response ), role ) ); + // Reset timer for sending the handshake response back + receiveThenSendStartTime = new Date(); + + // Send Handshake Response back + Handshakedata handshakeResponse = d.postProcessHandshakeResponseAsServer(handshake, response); + writeDirect( d.createHandshake( handshakeResponse, role ) ); + + // timing callback + wsl.messageSendTiming( receiveThenSendStartTime, new Date(), MessageType.HANDSHAKE, handshakeResponse.getContent() != null ? handshakeResponse.getContent().length : 0 ); + draft = d; open( handshake ); handleRead(); @@ -259,10 +276,13 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket handshakestate = draft.acceptHandshakeAsServer( handshake ); if( handshakestate == HandshakeState.MATCHED ) { + // timing callback + wsl.messageReceiveTiming( receiveThenSendStartTime, new Date(), MessageType.HANDSHAKE, socketBuffer.limit() ); + open( handshake ); handleRead(); } else if( handshakestate != HandshakeState.MATCHING ) { - close( CloseFrame.PROTOCOL_ERROR, "the handshake did finaly not match" ); + close( CloseFrame.PROTOCOL_ERROR, "the handshake did finally not match" ); } return; } @@ -270,12 +290,15 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket draft.setParseMode( role ); Handshakedata tmphandshake = draft.translateHandshake( socketBuffer ); if( tmphandshake instanceof ServerHandshake == false ) { - closeConnection( CloseFrame.PROTOCOL_ERROR, "Wwrong http function", false ); + closeConnection( CloseFrame.PROTOCOL_ERROR, "Wrong http function", false ); return; } ServerHandshake handshake = (ServerHandshake) tmphandshake; handshakestate = draft.acceptHandshakeAsClient( handshakerequest, handshake ); if( handshakestate == HandshakeState.MATCHED ) { + // timing callback + wsl.messageReceiveTiming( receiveThenSendStartTime, new Date(), MessageType.HANDSHAKE, socketBuffer.limit() ); + try { wsl.onWebsocketHandshakeReceivedAsClient( this, handshakerequest, handshake ); } catch ( InvalidDataException e ) { @@ -310,6 +333,9 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket code = cf.getCloseCode(); reason = cf.getMessage(); } + // timing callback + wsl.messageReceiveTiming( receiveThenSendStartTime, new Date(), MessageType.CLOSE, socketBuffer.limit() ); + if( closeHandshakeSent ) { // complete the close handshake by disconnecting closeConnection( code, reason, true ); @@ -332,6 +358,9 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket if( f.getOpcode() == Opcode.CONTINIOUS ) { throw new InvalidFrameException( "unexpected continious frame" ); } else if( f.isFin() ) { + // timing callback + wsl.messageReceiveTiming( receiveThenSendStartTime, new Date(), f.getOpcode() == Opcode.BINARY ? MessageType.BINARY : MessageType.TEXT, socketBuffer.limit() ); + // receive normal onframe message deliverMessage( f ); } else { @@ -341,6 +370,9 @@ private void init( WebSocketListener listener, Draft draft, SocketChannel socket } else if( f.getOpcode() == Opcode.CONTINIOUS ) { currentframe.append( f ); if( f.isFin() ) { + // timing callback + wsl.messageReceiveTiming( receiveThenSendStartTime, new Date(), f.getOpcode() == Opcode.BINARY ? MessageType.BINARY : MessageType.TEXT, socketBuffer.limit() ); + deliverMessage( currentframe ); currentframe = null; } @@ -375,19 +407,28 @@ public void close( int code, String message ) { public void closeDirect( int code, String message ) throws IOException { if( !closeHandshakeSent ) { if( handshakeComplete ) { + Date closeMessageSendStartTime = new Date(); + if( code == CloseFrame.ABNROMAL_CLOSE ) { closeConnection( code, true ); closeHandshakeSent = true; return; } flush(); + if( draft.getCloseHandshakeType() != CloseHandshakeType.NONE ) { + Framedata frameData = null; + int frameDataPayloadSize = 0; try { - sendFrameDirect( new CloseFrameBuilder( code, message ) ); + frameData = new CloseFrameBuilder( code, message ); + frameDataPayloadSize = frameData.getPayloadData().remaining(); + sendFrameDirect(frameData); } catch ( InvalidDataException e ) { wsl.onWebsocketError( this, e ); closeConnection( CloseFrame.ABNROMAL_CLOSE, "generated frame is invalid", false ); } + // timing callback + wsl.messageSendTiming( closeMessageSendStartTime, new Date(), MessageType.CLOSE, frameDataPayloadSize ); } else { closeConnection( code, false ); } @@ -510,16 +551,27 @@ long bufferedDataAmount() { * Empty the internal buffer, sending all the pending data before continuing. */ public void flush() throws IOException { + Date sentStartTime = new Date(); ByteBuffer buffer = this.bufferQueue.peek(); + while ( buffer != null ) { int written = sockchannel.write( buffer ); if( buffer.remaining() > 0 ) { + // there is still stuff to send for this buffer continue; } else { // subtract this amount of data from the total queued (synchronized over this object) bufferQueueTotalAmount.addAndGet( -written ); - this.bufferQueue.poll(); // Buffer finished. Remove it. + // timing callback + if ( isConnecting() ) { + wsl.messageSendTiming( sentStartTime, new Date(), MessageType.HANDSHAKE, buffer.limit() ); + } else if ( isOpen() ) { + // TODO - We don't have yet a way to know if we are sending "text" or "binary" at this point + wsl.messageSendTiming( sentStartTime, new Date(), MessageType.TEXT, buffer.limit() ); + } //< the "close()" message is handled slightly differently because of it's nature + + this.bufferQueue.poll(); //< Buffer finished. Remove it. buffer = this.bufferQueue.peek(); } } @@ -558,8 +610,7 @@ public void startHandshake( ClientHandshakeBuilder handshakedata ) throws Invali throw new InvalidHandshakeException( "Handshake data rejected by client." ); } - // Send - channelWrite( draft.createHandshake( this.handshakerequest, role ) ); + channelWrite( draft.createHandshake( this.handshakerequest, role ) ); //< queue to be sent } private void channelWrite( ByteBuffer buf ) throws InterruptedException { diff --git a/src/org/java_websocket/WebSocketAdapter.java b/src/org/java_websocket/WebSocketAdapter.java index a23834b2e..403cbc6e7 100644 --- a/src/org/java_websocket/WebSocketAdapter.java +++ b/src/org/java_websocket/WebSocketAdapter.java @@ -13,6 +13,8 @@ import org.java_websocket.handshake.ServerHandshake; import org.java_websocket.handshake.ServerHandshakeBuilder; +import java.util.Date; + public abstract class WebSocketAdapter implements WebSocketListener { /** @@ -55,7 +57,7 @@ public void onWebsocketMessage( WebSocket conn, String message ) { /** * This default implementation does not do anything. Go ahead and overwrite it. * - * @see @see org.java_websocket.WebSocketListener#onWebsocketOpen(WebSocket, Handshakedata) + * @see org.java_websocket.WebSocketListener#onWebsocketOpen(WebSocket, Handshakedata) */ @Override public void onWebsocketOpen( WebSocket conn, Handshakedata handshake ) { @@ -64,7 +66,7 @@ public void onWebsocketOpen( WebSocket conn, Handshakedata handshake ) { /** * This default implementation does not do anything. Go ahead and overwrite it. * - * @see @see org.java_websocket.WebSocketListener#onWebsocketClose(WebSocket, int, String, boolean) + * @see org.java_websocket.WebSocketListener#onWebsocketClose(WebSocket, int, String, boolean) */ @Override public void onWebsocketClose( WebSocket conn, int code, String reason, boolean remote ) { @@ -73,7 +75,7 @@ public void onWebsocketClose( WebSocket conn, int code, String reason, boolean r /** * This default implementation does not do anything. Go ahead and overwrite it. * - * @see @see org.java_websocket.WebSocketListener#onWebsocketMessage(WebSocket, byte[]) + * @see org.java_websocket.WebSocketListener#onWebsocketMessage(WebSocket, byte[]) */ @Override public void onWebsocketMessage( WebSocket conn, ByteBuffer blob ) { @@ -83,7 +85,7 @@ public void onWebsocketMessage( WebSocket conn, ByteBuffer blob ) { * This default implementation will send a pong in response to the received ping. * The pong frame will have the same payload as the ping frame. * - * @see @see org.java_websocket.WebSocketListener#onWebsocketPing(WebSocket, Framedata) + * @see org.java_websocket.WebSocketListener#onWebsocketPing(WebSocket, Framedata) */ @Override public void onWebsocketPing( WebSocket conn, Framedata f ) { @@ -99,7 +101,7 @@ public void onWebsocketPing( WebSocket conn, Framedata f ) { /** * This default implementation does not do anything. Go ahead and overwrite it. * - * @see @see org.java_websocket.WebSocketListener#onWebsocketPong(WebSocket, Framedata) + * @see org.java_websocket.WebSocketListener#onWebsocketPong(WebSocket, Framedata) */ @Override public void onWebsocketPong( WebSocket conn, Framedata f ) { @@ -126,10 +128,34 @@ public String getFlashPolicy( WebSocket conn ) { /** * This default implementation does not do anything. Go ahead and overwrite it. * - * @see @see org.java_websocket.WebSocketListener#onWebsocketError(WebSocket, Exception) + * @see org.java_websocket.WebSocketListener#onWebsocketError(WebSocket, Exception) */ @Override public void onWebsocketError( WebSocket conn, Exception ex ) { } + /** This default implementation does not do anything. Go ahead and overwrite it. + * + * @see org.java_websocket.WebSocketListener#connectTiming(Date startTime, Date endTime) + */ + @Override + public void connectTiming( Date startTime, Date endTime ) { + } + + /** This default implementation does not do anything. Go ahead and overwrite it. + * + * @see org.java_websocket.WebSocketListener#messageSendTiming(Date startTime, Date endTime, MessageType type, int bytesAmount) + */ + @Override + public void messageSendTiming( Date startTime, Date endTime, MessageType type, int bytesAmount ) { + } + + /** This default implementation does not do anything. Go ahead and overwrite it. + * + * @see org.java_websocket.WebSocketListener#messageReceiveTiming(Date startTime, Date endTime, MessageType type, int bytesAmount) + */ + @Override + public void messageReceiveTiming( Date startTime, Date endTime, MessageType type, int bytesAmount ) { + } + } diff --git a/src/org/java_websocket/WebSocketClient.java b/src/org/java_websocket/WebSocketClient.java index 0d3af1210..b20333eb9 100644 --- a/src/org/java_websocket/WebSocketClient.java +++ b/src/org/java_websocket/WebSocketClient.java @@ -10,6 +10,7 @@ import java.nio.channels.Selector; import java.nio.channels.SocketChannel; import java.nio.channels.UnresolvedAddressException; +import java.util.Date; import java.util.Iterator; import java.util.Set; import java.util.concurrent.locks.Lock; @@ -115,7 +116,6 @@ public void close() { closelock.unlock(); } } - } /** @@ -159,6 +159,8 @@ public void run() { } protected final void interruptableRun() { + Date connectStartTime = new Date(); + try { tryToConnect( new InetSocketAddress( uri.getHost(), getPort() ) ); } catch ( ClosedByInterruptException e ) { @@ -174,6 +176,8 @@ protected final void interruptableRun() { onWebsocketError( conn, e ); return; } + connectTiming(connectStartTime, new Date()); //< timing callback + conn = new WebSocket( this, draft, client ); try/*IO*/{ while ( !conn.isClosed() ) { diff --git a/src/org/java_websocket/WebSocketListener.java b/src/org/java_websocket/WebSocketListener.java index eac78f33b..b8f9a5b18 100644 --- a/src/org/java_websocket/WebSocketListener.java +++ b/src/org/java_websocket/WebSocketListener.java @@ -10,6 +10,8 @@ import org.java_websocket.handshake.ServerHandshake; import org.java_websocket.handshake.ServerHandshakeBuilder; +import java.util.Date; + /** * Implemented by WebSocketClient and WebSocketServer. * The methods within are called by WebSocket. @@ -17,6 +19,8 @@ */ public interface WebSocketListener { + enum MessageType { HANDSHAKE, CLOSE, TEXT, BINARY } + /** * Called on the server side when the socket connection is first established, and the WebSocket * handshake has been received. @@ -134,4 +138,50 @@ public interface WebSocketListener { /** This method is used to inform the selector thread that there is data queued to be written to the socket. */ public void onWriteDemand( WebSocket conn ); + + /** Informs the Listener how long it took to open a socket connection + * + * @param startTime + * Time at which the socket started connecting + * + * @param endTime + * Time at which the socket connection was established + */ + public void connectTiming( Date startTime, Date endTime ); + + /** Informs the Listener how long it took to send a Message. + * This will also inform about how long it took to send the initial WebSocket HTTP Handshake. + * + * @param startTime + * Time at which it started sending a message + * + * @param endTime + * Time at which if finished sending that message + * + * @param type + * Type of message sent + * + * @param bytesAmount + * Amount of bytes sent + */ + public void messageSendTiming( Date startTime, Date endTime, MessageType type, int bytesAmount ); + + /** Informs the Listener how long it took to receive a Message. + * This will also inform about how long it took to receive the initial WebSocket HTTP Handshake. + * Time is measured from when data are ready/waiting to be read on the socket. + * + * @param startTime + * Time at which it started receiving a message + * + * @param endTime + * Time at which if finished receiving that message + * + * @param type + * Type of message sent + * + * @param bytesAmount + * Amount of bytes received + */ + public void messageReceiveTiming( Date startTime, Date endTime, MessageType type, int bytesAmount ); + }