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

SocketSession

class SocketSession(session: DefaultWebSocketServerSession)

Represents a WebSocket session and provides methods for handling events and messages.

This class allows WebSocket clients to interact with the server, send/receive messages, and join/leave rooms.

Constructors

SocketSession

constructor(session: DefaultWebSocketServerSession)

Properties

closeReason

var closeReason: String?

host

val host: String

val id: UUID

player

var player: Player?

room

var room: String

username

var username: String?

Functions

suspend fun close(reason: String? = null): SocketSession

Closes the WebSocket session with an optional reason.

emit

suspend fun emit(event: String, data: Any, acknowledgment: Boolean = false, timeout: Long = 5000): SocketSession

Emits an event with data to the WebSocket client, optionally requiring an acknowledgment.

header

fun header(key: String): String?

Retrieves a header value from the WebSocket connection.

isOpen

fun isOpen(): Boolean

Checks if the WebSocket session is still open.

join

fun join(newRoom: String): SocketSession

Joins a specific room for the session.

leave

fun leave(): SocketSession

Leaves the current room and reverts to the default "global" room.

fun on(event: String, callback: suspend (JsonElement) -> Unit): SocketSession

Registers an event listener for a specific event.

onAny

fun onAny(callback: suspend (String, JsonElement) -> Unit): SocketSession

Registers a wildcard event listener for all events.

onClose

fun onClose(callback: suspend (String) -> Unit): SocketSession

Sets the callback function to be invoked when the WebSocket session is closed.

onTyped

inline fun <T> onTyped(event: String, crossinline callback: suspend (T) -> Unit): SocketSession

Registers a typed event listener for a specific event, decoding the event data to the specified type.

send

suspend fun send(text: String): SocketSession

Sends a message to the WebSocket client.