WebSocketContext (Resin 4.0.s170329)

All Known Implementing Classes:

WebSocketBareClient, WebSocketClient, WebSocketContextStreamImpl
```
public interface WebSocketContext
```
Bidirectional TCP connection based on a HTTP upgrade, e.g. WebSocket. The context and its values are not thread safe. The DuplexListener thread normally is the only thread reading from the input stream.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` gracefully close the connection, waiting for unread messages.
`void`	`close(int code, java.lang.String message)` gracefully close the connection, waiting for unread messages.
`<T> java.util.concurrent.BlockingQueue<T>`	`createOutputQueue(WebSocketEncoder<T> encoder)` Creates a thread-safe queue, which applications can send objects to be marshaled.
`void`	`disconnect()` Disconnect the connection.
`void`	`flush()` flushes the output stream
`long`	`getTimeout()` Gets the read timeout.
`boolean`	`isAutoFlush()` returns the current flush mode.
`void`	`onClose(int closeCode, java.lang.String closeMessage)`
`void`	`pong(byte[] value)` sends a pong message
`void`	`setAutoFlush(boolean isAutoFlush)` auto-flush after each message is sent.
`void`	`setTimeout(long timeout)` Sets the read timeout.
`java.io.OutputStream`	`startBinaryMessage()` Returns the output stream for a binary message.
`java.io.PrintWriter`	`startTextMessage()` Returns the output stream for a binary message.

- Method Detail
  - createOutputQueue
```
<T> java.util.concurrent.BlockingQueue<T> createOutputQueue(WebSocketEncoder<T> encoder)
```
    Creates a thread-safe queue, which applications can send objects to be marshaled.
  - startBinaryMessage
```
java.io.OutputStream startBinaryMessage()
                                 throws java.io.IOException
```
    Returns the output stream for a binary message. The message will complete when the OutputStream is closed.
    
    Throws:
    
    java.io.IOException
  - startTextMessage
```
java.io.PrintWriter startTextMessage()
                              throws java.io.IOException
```
    Returns the output stream for a binary message. The message will complete when the Writer is closed.
    
    Throws:
    
    java.io.IOException
  - setTimeout
```
void setTimeout(long timeout)
```
    Sets the read timeout.
  - getTimeout
```
long getTimeout()
```
    Gets the read timeout.
  - setAutoFlush
```
void setAutoFlush(boolean isAutoFlush)
```
    auto-flush after each message is sent.
  - isAutoFlush
```
boolean isAutoFlush()
```
    returns the current flush mode.
  - flush
```
void flush()
    throws java.io.IOException
```
    flushes the output stream
    
    Throws:
    
    java.io.IOException
  - close
```
void close()
```
    gracefully close the connection, waiting for unread messages.
  - close
```
void close(int code,
           java.lang.String message)
```
    gracefully close the connection, waiting for unread messages.
  - pong
```
void pong(byte[] value)
   throws java.io.IOException
```
    sends a pong message
    
    Throws:
    
    java.io.IOException
  - disconnect
```
void disconnect()
```
    Disconnect the connection.
  - onClose
```
void onClose(int closeCode,
             java.lang.String closeMessage)
```
    Parameters:
    
    closeCode -
    
    closeMessage -

Interface WebSocketContext

Method Summary

Method Detail

createOutputQueue

startBinaryMessage

startTextMessage

setTimeout

getTimeout

setAutoFlush

isAutoFlush

flush

close

close

pong

disconnect

onClose