NollyAPI/com.thenolle.api.nollyapi.util.web.socket/SocketBuilder

SocketBuilder

A builder class used to configure WebSocket server sessions.

This class allows for the setup of WebSocket event handlers such as connection, message reception, and disconnection. It also provides middleware support to process events before passing to the handler.

Constructors

SocketBuilder

constructor()

Functions

onClose

fun onClose(block: suspend (String) -> Unit): SocketBuilder

Sets the callback to be invoked when the WebSocket connection is closed.

onConnect

fun onConnect(block: suspend SocketSession.() -> Unit): SocketBuilder

Sets the callback to be invoked when a WebSocket connection is established.

onMessage

fun onMessage(block: suspend SocketSession.(String) -> Unit): SocketBuilder

Sets the callback to be invoked when a message is received through the WebSocket connection.

use

fun use(block: suspend SocketSession.() -> Unit): SocketBuilder

Adds middleware to the WebSocket session.