Package org.atmosphere.room.protocol

Interface RoomProtocolMessage

All Known Implementing Classes:

RoomProtocolMessage.Broadcast, RoomProtocolMessage.Direct, RoomProtocolMessage.Join, RoomProtocolMessage.Leave, RoomProtocolMessage.Typing

public sealed interface RoomProtocolMessage
permits RoomProtocolMessage.Join, RoomProtocolMessage.Leave, RoomProtocolMessage.Broadcast, RoomProtocolMessage.Direct, RoomProtocolMessage.Typing

Protocol messages exchanged between clients and the server for room operations. This sealed hierarchy enables exhaustive pattern matching in Java 21.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	RoomProtocolMessage.Broadcast	Broadcast a message to all room members.
static final record	RoomProtocolMessage.Direct	Send a direct message to a specific member by member ID.
static final record	RoomProtocolMessage.Join	Join a room with optional member metadata.
static final record	RoomProtocolMessage.Leave	Leave a room.
static final record	RoomProtocolMessage.Typing	Signal that a member has started or stopped typing.

Method Summary

Modifier and Type	Method	Description
String	room()	The target room name.

Method Details

room

String room()

The target room name.