org.mule.runtime.http.api.ws

Interface WebSocket

@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

Method Summary

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()
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.

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.

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

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