org.mule.runtime.http.api.client.ws

Interface WebSocketCallback

public interface WebSocketCallback

A Callback to receive outbound WebSocket events.

Implementations MUST be thread safe

Since:

4.2.0

Method Summary

Modifier and Type	Method and Description
void	onClose(WebSocket webSocket, WebSocketCloseCode code, String reason) Invoked then the given webSocket is closed.
void	onConnect(WebSocket webSocket) Invoked when the webSocket has been established
void	onMessage(WebSocket webSocket, org.mule.runtime.api.metadata.TypedValue<InputStream> content) Invoked when the given webSocket receives data.

Method Detail

onConnect

void onConnect(WebSocket webSocket)

Invoked when the webSocket has been established

Parameters:

webSocket - the created WebSocket

onClose

void onClose(WebSocket webSocket,
             WebSocketCloseCode code,
             String reason)

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

Parameters:

webSocket - the closed WebSocket

code - the close code used

reason - the reason provided

onMessage

void onMessage(WebSocket webSocket,
               org.mule.runtime.api.metadata.TypedValue<InputStream> content)

Invoked when the given webSocket receives data.

Parameters:

webSocket - the WebSocket that received the data

content - the received content