WebSocket (HTTP Service Definition 4.3.0 API)

```
@NoImplement
public interface WebSocket
```
Mule's abstraction of a Web Socket.
Each socket is classified according to a type and identified by an unique id
Sockets can also be labeled with groups, which allow to logically gather sets of sockets by a random taxonomy.

Since:

4.2.0

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class WebSocket.WebSocketType
Types of WebSocket

Nested Classes
Modifier and Type	Interface and Description
`static class`	`WebSocket.WebSocketType` Types of WebSocket

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addGroup(String group)` Subscribes `this` socket to the given `group`
`CompletableFuture<Void>`	`close(WebSocketCloseCode code, String reason)` Closes `this` socket
`List<String>`	`getGroups()`
`String`	`getId()`
`WebSocketProtocol`	`getProtocol()`
`WebSocket.WebSocketType`	`getType()`
`URI`	`getUri()`
`boolean`	`isClosed()` Tests whether the `close(WebSocketCloseCode, String)` method has been called on `this` instance or not.
`boolean`	`isConnected()` Tests whether this socket's connection to the remote system is still active.
`CompletableFuture<WebSocket>`	`reconnect(RetryPolicyTemplate retryPolicyTemplate, org.mule.runtime.api.scheduler.Scheduler scheduler)` Reconnects by opening a new `WebSocket` generated from an HTTP request identical to the one that originally spawned `this` one.
`void`	`removeGroup(String group)` Unsubscribe `this` socket to the given `group`
`CompletableFuture<Void>`	`send(InputStream content, org.mule.runtime.api.metadata.MediaType mediaType)` Sends the given `content` to the remote peer.
`CompletableFuture<Void>`	`sendFrame(byte[] frameBytes)` Sends the given frame in its binary representation.
`boolean`	`supportsReconnection()` Tests if `this` socket supports reconnection by the means of the `reconnect(RetryPolicyTemplate, Scheduler)` method.
`byte[]`	`toBinaryFrame(byte[] data, boolean last)` Transforms the given `data` into a binary data frame per the WebSockets specification.
`byte[]`	`toTextFrame(String data, boolean last)` Transforms the given `data` into a text data frame per the WebSockets specification.

- Method Detail
  - getId
```
String getId()
```
    Returns:
    
    Unique identified for this socket
  - getType
```
WebSocket.WebSocketType getType()
```
    Returns:
    
    this socket's type
  - getProtocol
```
WebSocketProtocol getProtocol()
```
    Returns:
    
    this socket's protocol
  - getUri
```
URI getUri()
```
    Returns:
    
    The URI of the endpoint that received the originating HTTP request.
  - supportsReconnection
```
boolean supportsReconnection()
```
    Tests if this socket supports reconnection by the means of the reconnect(RetryPolicyTemplate, Scheduler) method.
    
    Returns:
    
    Whether reconnection is supported for this instance.
    
    Since:
    
    4.2.2
  - reconnect
```
CompletableFuture<WebSocket> reconnect(RetryPolicyTemplate retryPolicyTemplate,
                                       org.mule.runtime.api.scheduler.Scheduler scheduler)
```
    Reconnects by opening a new WebSocket generated from an HTTP request identical to the one that originally spawned this one. The new WebSocket will have THE SAME getId() as the original instance.
    The term reconnection is not to be interpreted here as in the "socket MUST have had a connectivity issue first". Although recovering from connectivity issues is one of the prime uses of this method, that is not a prerequisite. Invoking this method on a perfectly functioning instance will just spawn a new WebSocket connected to the same remote system. However, be mindful that the new WebSocket will share the same id as this one. Having two active sockets with the same ID might be problematic depending on the use case.
    This method does not alter the current state of this instance. It merely generates a new WebSocket similar to this one.
    Not all implementations are required to support this method as it's not possible to do in some cases. The general contract is that this method should only be called when supportsReconnection() returns true. Invoking this method on an implementation that doesn't support it will result in a CompletableFuture immediately and exceptionally completed with an OperationNotSupportedException.
    
    Parameters:
    
    retryPolicyTemplate - the retry policy to use while reconnecting
    
    scheduler - the scheduler on which reconnection work should happen
    
    Returns:
    
    a CompletableFuture with the newly generated WebSocket
    
    Since:
    
    4.2.2
  - getGroups
```
List<String> getGroups()
```
    Returns:
    
    an immutable list with the groups to which this socket belongs to. Maybe empty but never null.
  - addGroup
```
void addGroup(String group)
```
    Subscribes this socket to the given group
    
    Parameters:
    
    group - a group. Not null nor empty.
  - removeGroup
```
void removeGroup(String group)
```
    Unsubscribe this socket to the given group
    
    Parameters:
    
    group - a group. Not null nor empty.
  - send
```
CompletableFuture<Void> send(InputStream content,
                             org.mule.runtime.api.metadata.MediaType mediaType)
```
    Sends the given content to the remote peer.
    
    Parameters:
    
    content - the content to be sent
    
    mediaType - the content's MediaType
    
    Returns:
    
    a CompletableFuture
  - sendFrame
```
CompletableFuture<Void> sendFrame(byte[] frameBytes)
```
    Sends the given frame in its binary representation.
    The frameBytes passed here are not a binary payload but the complete DataFrame that gets sent through the wire per the WebSockets specification. This method is useful when the exact same content has to be sent many times and the actual frame is cached as a performance improvement.
    The frameBytes can be (but are not forced to) be generated through the toTextFrame(String, boolean) and toBinaryFrame(byte[], boolean) methods
    
    Parameters:
    
    frameBytes - a data frame per the WebSocket specification
    
    Returns:
    
    a CompletableFuture
    
    Since:
    
    4.2.2
  - toTextFrame
```
byte[] toTextFrame(String data,
                   boolean last)
```
    Transforms the given data into a text data frame per the WebSockets specification.
    The returned frame is the actual set of bytes to be sent through the wire as specified by the protocol. This is not just a mere binary representation of the data.
    The returned frame is to be sent through the sendFrame(byte[]) method. Using this frame as input of the send(InputStream, MediaType) method will result in a frame wrapping another frame.
    
    Parameters:
    
    data - text to be sent
    
    last - whether the returned frame is the last in a chain of correlated frames
    
    Returns:
    
    A text data frame per the WebSockets specification
    
    Since:
    
    4.2.2
  - toBinaryFrame
```
byte[] toBinaryFrame(byte[] data,
                     boolean last)
```
    Transforms the given data into a binary data frame per the WebSockets specification.
    The returned frame is the actual set of bytes to be sent through the wire as specified by the protocol. This is not just a mere binary representation of the data.
    The returned frame is to be sent through the sendFrame(byte[]) method. Using this frame as input of the send(InputStream, MediaType) method will result in a frame wrapping another frame.
    
    Parameters:
    
    data - binary data to be sent
    
    last - whether the returned frame is the last in a chain of correlated frames
    
    Returns:
    
    A binary data frame per the WebSockets specification
    
    Since:
    
    4.2.2
  - close
```
CompletableFuture<Void> close(WebSocketCloseCode code,
                              String reason)
```
    Closes this socket
    
    Parameters:
    
    code - WebSocketCloseCode the close code
    
    reason - the reason why it's being closed
    
    Returns:
    
    a CompletableFuture
  - isClosed
```
boolean isClosed()
```
    Tests whether the close(WebSocketCloseCode, String) method has been called on this instance or not.
    Notice that this method differs from isConnected() in that even though the socket might not have been closed, it might still have lost its connection to the remote system. There's no forced correlation between the output values of both methods.
    
    Returns:
    
    Whether this socket has been closed or not
    
    Since:
    
    4.2.2
  - isConnected
```
boolean isConnected()
```
    Tests whether this socket's connection to the remote system is still active.
    Notice that this method differs from isClosed() ()} in that even though the socket might not have been closed, it might still have lost its connection to the remote system. There's no forced correlation between the output values of both methods.
    
    Returns:
    
    Whether this socket's connection is still active.
    
    Since:
    
    4.2.2

Interface WebSocket

Nested Class Summary

Method Summary

Method Detail

getId

getType

getProtocol

getUri

supportsReconnection

reconnect

getGroups

addGroup

removeGroup

send

sendFrame

toTextFrame

toBinaryFrame

close

isClosed

isConnected