Module io.jooby

Package io.jooby

Interface WebSocketConfigurer

public interface WebSocketConfigurer

Websocket configurer. Allow to register callbacks for websocket.

Since:

2.2.0

Author:

edgar

Method Summary

Modifier and Type	Method	Description
WebSocketConfigurer	onClose(WebSocket.OnClose callback)	Register an onClose callback.
WebSocketConfigurer	onConnect(WebSocket.OnConnect callback)	Register an onConnect callback.
WebSocketConfigurer	onError(WebSocket.OnError callback)	Register an onError callback.
WebSocketConfigurer	onMessage(WebSocket.OnMessage callback)	Register an onMessage callback.

Method Details

onConnect

@NonNull
WebSocketConfigurer onConnect(@NonNull
 WebSocket.OnConnect callback)

Register an onConnect callback.

Parameters:

callback - Callback.

Returns:

This configurer.

onMessage

@NonNull
WebSocketConfigurer onMessage(@NonNull
 WebSocket.OnMessage callback)

Register an onMessage callback.

Parameters:

callback - Callback.

Returns:

This configurer.

onError

@NonNull
WebSocketConfigurer onError(@NonNull
 WebSocket.OnError callback)

Register an onError callback.

Parameters:

callback - Callback.

Returns:

This configurer.

onClose

@NonNull
WebSocketConfigurer onClose(@NonNull
 WebSocket.OnClose callback)

Register an onClose callback.

Parameters:

callback - Callback.

Returns:

This configurer.