WebSocketAdapter (IG Aggregated Javadoc 7.2.0 Documentation)

All Superinterfaces:

AutoCloseable, Closeable
```
public interface WebSocketAdapter
extends Closeable
```
Basic websocket application interface facilitating different provider implementations. See implementation documentation to understand specific configuration options.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`close()`
`Promise<Void,IOException>`	`sendObject(Object request)`	Send the supplied request over the websocket to the remote party.
`Promise<WebSocketAdapter,Exception>`	`start()`	Start the websocket client and connect to the remote endpoint.

- Method Detail
  - start
```
Promise<WebSocketAdapter,Exception> start()
```
    Start the websocket client and connect to the remote endpoint.
    
    Returns:
    
    Promise holding the WebSocketAdapter and any Exception thrown when trying to start the connection.
  - close
```
void close()
    throws IOException
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    Throws:
    
    IOException
  - sendObject
```
Promise<Void,IOException> sendObject(Object request)
```
    Send the supplied request over the websocket to the remote party.
    
    Parameters:
    
    request - The request to transmit
    
    Returns:
    
    Promise of any IOException that occurred in the event of a send failure