remote/dev.s7a.strata.runtime.remote/RemoteScreenService

RemoteScreenService

class RemoteScreenService<Player : Any, Owner : Any>(endpoint: RemoteEndpoint, send: (Player, ByteArray) -> Unit, report: (Throwable) -> Unit, dispatchClose: (() -> Unit) -> Unit = { it() }, notify: (Player, RemoteLifecycleEvent<Owner>) -> Unit = { _, _ -> }) : AutoCloseable(source)

Owns authenticated player transports and declarations under one adapter execution owner. Network callbacks only enqueue bounded bytes; handlers never run in messaging callbacks. Closing permanently rejects new players, schemas, and definitions before notifying listeners.

Constructors

RemoteScreenService

constructor(endpoint: RemoteEndpoint, send: (Player, ByteArray) -> Unit, report: (Throwable) -> Unit, dispatchClose: (() -> Unit) -> Unit = { it() }, notify: (Player, RemoteLifecycleEvent<Owner>) -> Unit = { _, _ -> })

Functions

capabilities

fun capabilities(player: Player): RemoteCapabilities?

Returns the successful capability handshake for one current player connection.

open override fun close()

Ends admission before releasing peers and notifying terminal listeners; repeated close has no effect.

containerChanged

fun containerChanged(player: Player)

Invalidates the current screen generation when Minecraft replaces or closes its native container. Subsequent messages still carry the retired session identity and cannot target a replacement screen.

disconnect

fun disconnect(player: Player)

Removes all queues and state belonging to one disconnected player.

enqueue

fun enqueue(player: Player, bytes: ByteArray)

Copies inbound authenticated payloads without executing server-owned behavior.

join

fun join(player: Player)

Creates a fresh protocol endpoint for a joined player.

open

fun open(owner: Owner, player: Player, definition: ScreenDefinition): RemoteScreenSession

Compatibility entry sharing the common definition and session path.

fun open(owner: Owner, player: Player, definition: UiDefinition): RemoteScreenSession

Consumes the definition and opens a screen only after successful peer negotiation. Pending openings close without evaluating content if replacement listeners retire the connection. Preparation failures terminate admitted handles before propagating.

ownerDisabled

fun ownerDisabled(owner: Owner)

Ends every screen owned by a plugin before that plugin can be unloaded. Rejected transition admission preserves registrations so a later retry can retire dependent screens.

fun register(owner: Owner, type: ProjectionType)

Admits one exact plugin-owned schema for subsequent connections.

tick

fun tick()

Processes a bounded number of frames, then commits state and flushes bounded output for each player.