WebSocketImpl (Java-WebSocket API)

java.lang.Object
- com.pusher.java_websocket.WebSocketImpl

All Implemented Interfaces:

WebSocket
```
public class WebSocketImpl
extends java.lang.Object
implements WebSocket
```
Represents one end (client or server) of a single WebSocketImpl connection. Takes care of the "handshake" phase, then allows for easy sending of text frames, and receiving frames through an event-based model.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.pusher.java_websocket.WebSocket
  WebSocket.READYSTATE, WebSocket.Role

Field Summary

Fields
Modifier and Type	Field and Description
`java.nio.channels.ByteChannel`	`channel` the possibly wrapped channel object whose selection is controlled by `key`
`static boolean`	`DEBUG`
`static java.util.List<Draft>`	`defaultdraftlist`
`java.util.concurrent.BlockingQueue<java.nio.ByteBuffer>`	`inQueue` Queue of buffers that need to be processed
`java.nio.channels.SelectionKey`	`key`
`java.util.concurrent.BlockingQueue<java.nio.ByteBuffer>`	`outQueue` Queue of buffers that need to be sent to the client.
`static int`	`RCVBUF`
`WebSocketServer.WebSocketWorker`	`workerThread` Helper variable meant to store the thread which ( exclusively ) triggers this objects decode method.

Fields inherited from interface com.pusher.java_websocket.WebSocket
DEFAULT_PORT, DEFAULT_WSS_PORT

Constructor Summary

Constructors
Constructor and Description
`WebSocketImpl(WebSocketListener listener, Draft draft)` crates a websocket with client role
`WebSocketImpl(WebSocketListener listener, Draft draft, java.net.Socket socket)` Deprecated.
`WebSocketImpl(WebSocketListener listener, java.util.List<Draft> drafts)` crates a websocket with server role
`WebSocketImpl(WebSocketListener listener, java.util.List<Draft> drafts, java.net.Socket socket)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Convenience function which behaves like close(CloseFrame.NORMAL)
`void`	`close(int code)`
`void`	`close(int code, java.lang.String message)` sends the closing handshake.
`void`	`close(InvalidDataException e)`
`void`	`closeConnection()`
`protected void`	`closeConnection(int code, boolean remote)`
`void`	`closeConnection(int code, java.lang.String message)` This will close the connection immediately without a proper close handshake.
`protected void`	`closeConnection(int code, java.lang.String message, boolean remote)`
`void`	`decode(java.nio.ByteBuffer socketBuffer)`
`void`	`eot()`
`protected void`	`flushAndClose(int code, java.lang.String message, boolean remote)`
`Draft`	`getDraft()`
`java.net.InetSocketAddress`	`getLocalSocketAddress()`
`WebSocket.READYSTATE`	`getReadyState()` Retrieve the WebSocket 'readyState'.
`java.net.InetSocketAddress`	`getRemoteSocketAddress()`
`java.lang.String`	`getResourceDescriptor()` Returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2 If the opening handshake has not yet happened it will return null.
`boolean`	`hasBufferedData()`
`int`	`hashCode()`
`boolean`	`isClosed()` Returns whether the close handshake has been completed and the socket is closed.
`boolean`	`isClosing()`
`boolean`	`isConnecting()`
`boolean`	`isFlushAndClose()` Returns true when no further frames may be submitted This happens before the socket connection is closed.
`boolean`	`isOpen()`
`void`	`send(byte[] bytes)`
`void`	`send(java.nio.ByteBuffer bytes)` Send Binary data (plain bytes) to the other end.
`void`	`send(java.lang.String text)` Send Text data to the other end.
`void`	`sendFragmentedFrame(Framedata.Opcode op, java.nio.ByteBuffer buffer, boolean fin)` Allows to send continuous/fragmented frames conveniently.
`void`	`sendFrame(Framedata framedata)`
`void`	`startHandshake(ClientHandshakeBuilder handshakedata)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - RCVBUF
```
public static int RCVBUF
```
  - DEBUG
```
public static boolean DEBUG
```
  - defaultdraftlist
```
public static final java.util.List<Draft> defaultdraftlist
```
  - key
```
public java.nio.channels.SelectionKey key
```
  - channel
```
public java.nio.channels.ByteChannel channel
```
    the possibly wrapped channel object whose selection is controlled by key
  - outQueue
```
public final java.util.concurrent.BlockingQueue<java.nio.ByteBuffer> outQueue
```
    Queue of buffers that need to be sent to the client.
  - inQueue
```
public final java.util.concurrent.BlockingQueue<java.nio.ByteBuffer> inQueue
```
    Queue of buffers that need to be processed
  - workerThread
```
public volatile WebSocketServer.WebSocketWorker workerThread
```
    Helper variable meant to store the thread which ( exclusively ) triggers this objects decode method.
- Constructor Detail
  - WebSocketImpl
```
public WebSocketImpl(WebSocketListener listener,
                     java.util.List<Draft> drafts)
```
    crates a websocket with server role
  - WebSocketImpl
```
public WebSocketImpl(WebSocketListener listener,
                     Draft draft)
```
    crates a websocket with client role
    
    Parameters:
    
    listener - may be unbound
  - WebSocketImpl
```
@Deprecated
public WebSocketImpl(WebSocketListener listener,
                                 Draft draft,
                                 java.net.Socket socket)
```
    Deprecated.
  - WebSocketImpl
```
@Deprecated
public WebSocketImpl(WebSocketListener listener,
                                 java.util.List<Draft> drafts,
                                 java.net.Socket socket)
```
    Deprecated.
- Method Detail
  - decode
```
public void decode(java.nio.ByteBuffer socketBuffer)
```
  - close
```
public void close(int code,
                  java.lang.String message)
```
    Description copied from interface: WebSocket
    
    sends the closing handshake. may be send in response to an other handshake.
    
    Specified by:
    
    close in interface WebSocket
  - closeConnection
```
protected void closeConnection(int code,
                               java.lang.String message,
                               boolean remote)
```
    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
```
protected void closeConnection(int code,
                               boolean remote)
```
  - closeConnection
```
public void closeConnection()
```
  - closeConnection
```
public void closeConnection(int code,
                            java.lang.String message)
```
    Description copied from interface: WebSocket
    
    This will close the connection immediately without a proper close handshake. The code and the message therefore won't be transfered over the wire also they will be forwarded to onClose/onWebsocketClose.
    
    Specified by:
    
    closeConnection in interface WebSocket
  - flushAndClose
```
protected void flushAndClose(int code,
                             java.lang.String message,
                             boolean remote)
```
  - eot
```
public void eot()
```
  - close
```
public void close(int code)
```
    Specified by:
    
    close in interface WebSocket
  - close
```
public void close(InvalidDataException e)
```
  - send
```
public void send(java.lang.String text)
          throws WebsocketNotConnectedException
```
    Send Text data to the other end.
    
    Specified by:
    
    send in interface WebSocket
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.nio.channels.NotYetConnectedException
    
    WebsocketNotConnectedException
  - send
```
public void send(java.nio.ByteBuffer bytes)
          throws java.lang.IllegalArgumentException,
                 WebsocketNotConnectedException
```
    Send Binary data (plain bytes) to the other end.
    
    Specified by:
    
    send in interface WebSocket
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    java.nio.channels.NotYetConnectedException
    
    WebsocketNotConnectedException
  - send
```
public void send(byte[] bytes)
          throws java.lang.IllegalArgumentException,
                 WebsocketNotConnectedException
```
    Specified by:
    
    send in interface WebSocket
    
    Throws:
    
    java.lang.IllegalArgumentException
    
    WebsocketNotConnectedException
  - sendFragmentedFrame
```
public void sendFragmentedFrame(Framedata.Opcode op,
                                java.nio.ByteBuffer buffer,
                                boolean fin)
```
    Description copied from interface: WebSocket
    
    Allows to send continuous/fragmented frames conveniently.
    For more into on this frame type see http://tools.ietf.org/html/rfc6455#section-5.4
    If the first frame you send is also the last then it is not a fragmented frame and will received via onMessage instead of onFragmented even though it was send by this method.
    
    Specified by:
    
    sendFragmentedFrame in interface WebSocket
    
    Parameters:
    
    op - This is only important for the first frame in the sequence. Opcode.TEXT, Opcode.BINARY are allowed.
    
    buffer - The buffer which contains the payload. It may have no bytes remaining.
    
    fin - true means the current frame is the last in the sequence.
  - sendFrame
```
public void sendFrame(Framedata framedata)
```
    Specified by:
    
    sendFrame in interface WebSocket
  - hasBufferedData
```
public boolean hasBufferedData()
```
    Specified by:
    
    hasBufferedData in interface WebSocket
  - startHandshake
```
public void startHandshake(ClientHandshakeBuilder handshakedata)
                    throws InvalidHandshakeException
```
    Throws:
    
    InvalidHandshakeException
  - isConnecting
```
public boolean isConnecting()
```
    Specified by:
    
    isConnecting in interface WebSocket
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface WebSocket
  - isClosing
```
public boolean isClosing()
```
    Specified by:
    
    isClosing in interface WebSocket
  - isFlushAndClose
```
public boolean isFlushAndClose()
```
    Description copied from interface: WebSocket
    
    Returns true when no further frames may be submitted
    This happens before the socket connection is closed.
    
    Specified by:
    
    isFlushAndClose in interface WebSocket
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: WebSocket
    
    Returns whether the close handshake has been completed and the socket is closed.
    
    Specified by:
    
    isClosed in interface WebSocket
  - getReadyState
```
public WebSocket.READYSTATE getReadyState()
```
    Description copied from interface: WebSocket
    
    Retrieve the WebSocket 'readyState'. This represents the state of the connection. It returns a numerical value, as per W3C WebSockets specs.
    
    Specified by:
    
    getReadyState in interface WebSocket
    
    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
  - getRemoteSocketAddress
```
public java.net.InetSocketAddress getRemoteSocketAddress()
```
    Specified by:
    
    getRemoteSocketAddress in interface WebSocket
    
    Returns:
    
    never returns null
  - getLocalSocketAddress
```
public java.net.InetSocketAddress getLocalSocketAddress()
```
    Specified by:
    
    getLocalSocketAddress in interface WebSocket
    
    Returns:
    
    never returns null
  - getDraft
```
public Draft getDraft()
```
    Specified by:
    
    getDraft in interface WebSocket
  - close
```
public void close()
```
    Description copied from interface: WebSocket
    
    Convenience function which behaves like close(CloseFrame.NORMAL)
    
    Specified by:
    
    close in interface WebSocket
  - getResourceDescriptor
```
public java.lang.String getResourceDescriptor()
```
    Description copied from interface: WebSocket
    
    Returns the HTTP Request-URI as defined by http://tools.ietf.org/html/rfc2616#section-5.1.2
    If the opening handshake has not yet happened it will return null.
    
    Specified by:
    
    getResourceDescriptor in interface WebSocket

Class WebSocketImpl

Nested Class Summary

Nested classes/interfaces inherited from interface com.pusher.java_websocket.WebSocket

Field Summary

Fields inherited from interface com.pusher.java_websocket.WebSocket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RCVBUF

DEBUG

defaultdraftlist

key

channel

outQueue

inQueue

workerThread

Constructor Detail

WebSocketImpl

WebSocketImpl

WebSocketImpl

WebSocketImpl

Method Detail

decode

close

closeConnection

closeConnection

closeConnection

closeConnection

flushAndClose

eot

close

close

send

send

send

sendFragmentedFrame

sendFrame

hasBufferedData

startHandshake

isConnecting

isOpen

isClosing

isFlushAndClose

isClosed

getReadyState

hashCode

toString

getRemoteSocketAddress

getLocalSocketAddress

getDraft

close

getResourceDescriptor