org.mule.runtime.http.api.server.ws

Interface WebSocketConnectionHandler

public interface WebSocketConnectionHandler

Handles connection aspects of an inbound WebSocket

Since:

4.2.0

Method Summary

Modifier and Type	Method and Description
String	getSocketId(WebSocketRequest request) Generates the id of the socket that will be created from the given request
void	onClose(WebSocket socket, WebSocketRequest request, WebSocketCloseCode closeCode, String reason) Invoked when the socket is closed.
void	onConnect(WebSocket socket, WebSocketRequest request) Invoked when the socket is established

Method Detail

getSocketId

String getSocketId(WebSocketRequest request)

Generates the id of the socket that will be created from the given request

Parameters:

request - the inbound request to open a WebSocket

Returns:

an id. Cannot be null or empty.

onConnect

void onConnect(WebSocket socket,
               WebSocketRequest request)
        throws WebSocketConnectionRejectedException

Invoked when the socket is established

Parameters:

socket - the established WebSocket

request - the inbound request

Throws:

WebSocketConnectionRejectedException - if the connection is refused by the owning server

onClose

void onClose(WebSocket socket,
             WebSocketRequest request,
             WebSocketCloseCode closeCode,
             String reason)

Invoked when the socket is closed. This method will be invoked whether the socket was closed locally or remotely.

Parameters:

socket - the established WebSocket

request - the inbound request

closeCode - the close code used

reason - the reason provided