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

Interface WebSocketHandler

public interface WebSocketHandler

Handler for an inbound WebSocket requests

Since:

4.2.0

Method Summary

Modifier and Type	Method and Description
WebSocketConnectionHandler	getConnectionHandler()
default long	getIdleSocketTimeoutMills()
WebSocketMessageHandler	getMessageHandler()
String	getPath()

Method Detail

getPath

String getPath()

Returns:

The path of the WebSocket endpoint

getConnectionHandler

WebSocketConnectionHandler getConnectionHandler()

Returns:

The WebSocketConnectionHandler for the getPath()

getMessageHandler

WebSocketMessageHandler getMessageHandler()

Returns:

The WebSocketMessageHandler for the getPath()

getIdleSocketTimeoutMills

default long getIdleSocketTimeoutMills()

Returns:

Timeout in milliseconds for closing idle connections

Since:

4.3.0 - 4.2.2