WebSocketAdapter (HtmlUnit 4.6.0 API)

All Known Implementing Classes:

JettyWebSocketAdapter
```
public interface WebSocketAdapter
```
Helper to have no direct dependency to the WebSockt client implementation used by HtmlUnit.

Author:

Ronald Brill

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`closeClient()` Close the client.
`void`	`closeIncommingSession()` Close the incomming session.
`void`	`closeOutgoingSession()` Close the outgoing session.
`void`	`connect(URI url)` Connects to the given `URI`.
`void`	`onWebSocketBinary(byte[] data, int offset, int length)` Callback to be called when binary data retrieved.
`void`	`onWebSocketClose(int statusCode, String reason)` Callback to be called when closed.
`void`	`onWebSocketConnect()` Callback to be called when connected.
`void`	`onWebSocketConnectError(Throwable cause)` Callback to be called on connect error.
`void`	`onWebSocketConnecting()` Callback to be called when connecting.
`void`	`onWebSocketError(Throwable cause)` Callback to be called on error.
`void`	`onWebSocketText(String message)` Callback to be called when closed.
`void`	`send(Object content)` Sends the provided content.
`void`	`start()` Starts the client.

- Method Detail
  - start
```
void start()
    throws Exception
```
    Starts the client.
    
    Throws:
    
    Exception - in case of error
  - connect
```
void connect(URI url)
      throws Exception
```
    Connects to the given URI.
    
    Parameters:
    
    url - the target url
    
    Throws:
    
    Exception - in case of error
  - send
```
void send(Object content)
   throws IOException
```
    Sends the provided content.
    
    Parameters:
    
    content - the content to be sent
    
    Throws:
    
    IOException - in case of error
  - closeIncommingSession
```
void closeIncommingSession()
                    throws Exception
```
    Close the incomming session.
    
    Throws:
    
    Exception - in case of error
  - closeOutgoingSession
```
void closeOutgoingSession()
                   throws Exception
```
    Close the outgoing session.
    
    Throws:
    
    Exception - in case of error
  - closeClient
```
void closeClient()
          throws Exception
```
    Close the client.
    
    Throws:
    
    Exception - in case of error
  - onWebSocketConnecting
```
void onWebSocketConnecting()
```
    Callback to be called when connecting.
  - onWebSocketConnect
```
void onWebSocketConnect()
```
    Callback to be called when connected.
  - onWebSocketClose
```
void onWebSocketClose(int statusCode,
                      String reason)
```
    Callback to be called when closed.
    
    Parameters:
    
    statusCode - the status code
    
    reason - the reason
  - onWebSocketText
```
void onWebSocketText(String message)
```
    Callback to be called when closed.
    
    Parameters:
    
    message - the message
  - onWebSocketBinary
```
void onWebSocketBinary(byte[] data,
                       int offset,
                       int length)
```
    Callback to be called when binary data retrieved.
    
    Parameters:
    
    data - the bytes
    
    offset - start offset
    
    length - the length
  - onWebSocketConnectError
```
void onWebSocketConnectError(Throwable cause)
```
    Callback to be called on connect error.
    
    Parameters:
    
    cause - the cause
  - onWebSocketError
```
void onWebSocketError(Throwable cause)
```
    Callback to be called on error.
    
    Parameters:
    
    cause - the cause

Interface WebSocketAdapter

Method Summary

Method Detail

start

connect

send

closeIncommingSession

closeOutgoingSession

closeClient

onWebSocketConnecting

onWebSocketConnect

onWebSocketClose

onWebSocketText

onWebSocketBinary

onWebSocketConnectError

onWebSocketError