emulinker/org.emulinker.kaillera.controller.v086.protocol

Package-level declarations

Types

Ack

sealed class Ack : V086Message

AllReady

data class AllReady(var messageNumber: Int) : V086Message, ServerMessage, ClientMessage

Message sent by both client and server to indicate that they are ready for the game to start.

CachedGameData

data class CachedGameData(var messageNumber: Int, val key: Int) : V086Message, ServerMessage, ClientMessage

Fills the same function as GameData but encodes a 0-based cache index (key) corresponding to game data that has already been sent.

Chat

sealed class Chat : V086Message

Message type ID: 0x07.

ChatNotification

data class ChatNotification(var messageNumber: Int, val username: String, val message: String) : Chat, ServerMessage

Message sent by the server containing a server chat message.

ChatRequest

data class ChatRequest(var messageNumber: Int, val message: String) : Chat, ClientMessage

Message sent by the client containing a server chat message.

ClientAck

data class ClientAck(var messageNumber: Int) : Ack, ClientMessage

This is effectively a ping response sent by the client when it receives a ServerAck.

ClientMessage

sealed interface ClientMessage

V086Message that is sent from clients to the server.

CloseGame

data class CloseGame(var messageNumber: Int, val gameId: Int, val val1: Int) : V086Message, ServerMessage

ConnectionRejected

data class ConnectionRejected(var messageNumber: Int, val username: String, val userId: Int, val message: String) : V086Message, ServerMessage

Message sent from the server to indicate that the client is not allowed to join the server, including a message to be displayed to the user.

CreateGame

sealed class CreateGame : V086Message

CreateGameNotification

data class CreateGameNotification(var messageNumber: Int, val username: String, val romName: String, val clientType: String, val gameId: Int, val val1: Int) : CreateGame, ServerMessage

Server message indicating that a new game has been created.

CreateGameRequest

data class CreateGameRequest(var messageNumber: Int, val romName: String) : CreateGame, ClientMessage

Client message requesting to create a new game.

GameChat

sealed class GameChat : V086Message

GameChatNotification

data class GameChatNotification(var messageNumber: Int, val username: String, val message: String) : GameChat, ServerMessage

Message sent by the server containing a game chat message.

GameChatRequest

data class GameChatRequest(var messageNumber: Int, val message: String) : GameChat, ClientMessage

Message sent by the client containing a game chat message.

GameData

data class GameData(var messageNumber: Int, val gameData: ByteBuf) : V086Message, ClientMessage, ServerMessage, ReferenceCounted

A message sent by both the client and server, which contains game input data as a ByteBuf.

GameKick

data class GameKick(var messageNumber: Int, val userId: Int) : V086Message, ClientMessage

Message sent to kick a user by userId from a game.

GameStatus

data class GameStatus(var messageNumber: Int, val gameId: Int, val val1: Int, val gameStatus: GameStatus, val numPlayers: Byte, val maxPlayers: Byte) : V086Message, ServerMessage

Message sent by the server to notify all clients that a game's status has changed.

InformationMessage

data class InformationMessage(var messageNumber: Int, val source: String, val message: String) : V086Message, ServerMessage

A message from the server containing text to be displayed to the user, including a source.

JoinGame

sealed class JoinGame : V086Message

JoinGameNotification

data class JoinGameNotification(var messageNumber: Int, val gameId: Int, val val1: Int, val username: String, val ping: Duration, val userId: Int, val connectionType: ConnectionType) : JoinGame, ServerMessage

Server message indiciating a user successfully joined a game.

JoinGameRequest

data class JoinGameRequest(var messageNumber: Int, val gameId: Int, val connectionType: ConnectionType) : JoinGame, ClientMessage

Client message from a user requesting to join a game.

KeepAlive

data class KeepAlive(var messageNumber: Int, val value: Short) : V086Message, ClientMessage

Message periodically sent by the client so the server knows it is still connected on that port.

MessageSerializer

sealed interface MessageSerializer<E : V086Message>

PlayerDrop

sealed class PlayerDrop : V086Message

PlayerDropNotification

data class PlayerDropNotification(var messageNumber: Int, val username: String, val playerNumber: Byte) : PlayerDrop, ServerMessage

PlayerDropRequest

data class PlayerDropRequest(var messageNumber: Int) : PlayerDrop, ClientMessage

PlayerInformation

data class PlayerInformation(var messageNumber: Int, val players: List<PlayerInformation.Player>) : V086Message, ServerMessage

Message sent by the server when a user joins a game, which lists all of the players in that game.

Quit

sealed class Quit : V086Message

QuitGame

sealed class QuitGame : V086Message

QuitGameNotification

data class QuitGameNotification(var messageNumber: Int, val username: String, val userId: Int) : QuitGame, ServerMessage

Message sent by the server to notify that a user has left the game.

QuitGameRequest

data class QuitGameRequest(var messageNumber: Int) : QuitGame, ClientMessage

Message sent by the client to request to leave a game.

QuitNotification

data class QuitNotification(var messageNumber: Int, val username: String, val userId: Int, val message: String) : Quit

Message sent by the server to notify all clients that the user left the server.

QuitRequest

data class QuitRequest(var messageNumber: Int, val message: String) : Quit

Message sent by the client before leaving the server.

ServerAck

data class ServerAck(var messageNumber: Int) : Ack, ServerMessage

A message the server sends to the client, from which it expects a ClientAck in response.

ServerMessage

sealed interface ServerMessage

V086Message that is sent from the server to clients.

ServerStatus

data class ServerStatus(var messageNumber: Int, val users: List<ServerStatus.User>, val games: List<ServerStatus.Game>) : V086Message, ServerMessage

Message sent by the server when the user joins, listing all of the users and games.

StartGame

sealed class StartGame : V086Message

StartGameNotification

data class StartGameNotification(var messageNumber: Int, val val1: Int, val playerNumber: Short, val numPlayers: Short) : StartGame, ServerMessage

Message sent from the server to all clients, informing that a game has started.

StartGameRequest

data class StartGameRequest(var messageNumber: Int) : StartGame, ClientMessage

Message sent from the client to request that a game starts.

UserInformation

data class UserInformation(var messageNumber: Int, val username: String, val clientType: String, val connectionType: ConnectionType) : V086Message, ClientMessage

Message sent from the client when a user joins the server to indicate username, clientType, and connectionType.

UserJoined

data class UserJoined(var messageNumber: Int, val username: String, val userId: Int, val ping: Duration, val connectionType: ConnectionType) : V086Message

Message sent from the server to all clients to give information about a new client that has joined the server.

V086Bundle

sealed interface V086Bundle : ByteBufferMessage, ReferenceCounted

V086BundleFormatException

class V086BundleFormatException(msg: String?, cause: Throwable? = null) : Exception

V086Message

abstract class V086Message : ByteBufferMessage

A message in the v086 Kaillera protocol.

Functions

parseFailure

fun <T : V086Message> parseFailure(string: String): Result<T>