Class FlickProtocol

java.lang.Object

net.flick.serverapi.protocol.FlickProtocol

public final class FlickProtocol
extends Object

Wire format of the flick:api plugin channel (spec: docs/SERVER_API.md). Each plugin message is one UTF-8 JSON object with a type field "t"; no length prefix.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FlickProtocol.ClientHello	Parsed and validated hello.
static final record	FlickProtocol.ModsReply	mods: nonce (nullable), ids, denied flag.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANNEL
static final int	MAX_BODY
static final int	MAX_BYTES	Max payload in both directions (vanilla limit for serverbound custom payloads).
static final int	MAX_DISABLED
static final int	MAX_REASON
static final int	MAX_RPC
static final int	MAX_SERVER_NAME
static final int	MAX_TITLE
static final int	MAX_WAYPOINTS
static final int	PROTOCOL

Method Summary

Modifier and Type	Method	Description
static byte[]	encode(com.google.gson.JsonObject o)
static com.google.gson.JsonObject	helloAck(String serverName)
static com.google.gson.JsonObject	modsRequest(String nonce)
static com.google.gson.JsonObject	modules(Collection<String> disabled, String reason)	Full set of modules forced off (replaces the previous set on the client).
static com.google.gson.JsonObject	modulesReset()
static com.google.gson.JsonObject	notify(String title, String body, NotificationKind kind, long durationMs)
static com.google.gson.JsonObject	parse(byte[] data)	Parses a payload into a JSON object with a string t; null if malformed or too large.
static FlickProtocol.ClientHello	parseHello(com.google.gson.JsonObject o)	Validates a client hello; null when it is not a Flick hello we can talk to.
static FlickProtocol.ModsReply	parseMods(com.google.gson.JsonObject o)
static Set<String>	parseState(com.google.gson.JsonObject o)	Module ids from a state message.
static com.google.gson.JsonObject	reset()
static com.google.gson.JsonObject	rpc(String details, String state)
static com.google.gson.JsonObject	rpcReset()
static String	type(com.google.gson.JsonObject o)
static com.google.gson.JsonObject	waypointAdd(FlickWaypoint w)
static com.google.gson.JsonObject	waypointClear()
static com.google.gson.JsonObject	waypointRemove(String id)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CHANNEL

public static final String CHANNEL

See Also:

• Constant Field Values

PROTOCOL

public static final int PROTOCOL

See Also:

• Constant Field Values

MAX_BYTES

public static final int MAX_BYTES

Max payload in both directions (vanilla limit for serverbound custom payloads).

See Also:

• Constant Field Values

MAX_WAYPOINTS

public static final int MAX_WAYPOINTS

See Also:

• Constant Field Values

MAX_DISABLED

public static final int MAX_DISABLED

See Also:

• Constant Field Values

MAX_TITLE

public static final int MAX_TITLE

See Also:

• Constant Field Values

MAX_BODY

public static final int MAX_BODY

See Also:

• Constant Field Values

MAX_RPC

public static final int MAX_RPC

See Also:

• Constant Field Values

MAX_REASON

public static final int MAX_REASON

See Also:

• Constant Field Values

MAX_SERVER_NAME

public static final int MAX_SERVER_NAME

See Also:

• Constant Field Values

Method Details

parse

public static com.google.gson.JsonObject parse(byte[] data)

Parses a payload into a JSON object with a string t; null if malformed or too large.

type

public static String type(com.google.gson.JsonObject o)

parseHello

public static FlickProtocol.ClientHello parseHello(com.google.gson.JsonObject o)

Validates a client hello; null when it is not a Flick hello we can talk to.

parseState

public static Set<String> parseState(com.google.gson.JsonObject o)

Module ids from a state message.

parseMods

public static FlickProtocol.ModsReply parseMods(com.google.gson.JsonObject o)

helloAck

public static com.google.gson.JsonObject helloAck(String serverName)

waypointAdd

public static com.google.gson.JsonObject waypointAdd(FlickWaypoint w)

waypointRemove

public static com.google.gson.JsonObject waypointRemove(String id)

waypointClear

public static com.google.gson.JsonObject waypointClear()

modules

public static com.google.gson.JsonObject modules(Collection<String> disabled,
 String reason)

Full set of modules forced off (replaces the previous set on the client).

modulesReset

public static com.google.gson.JsonObject modulesReset()

notify

public static com.google.gson.JsonObject notify(String title,
 String body,
 NotificationKind kind,
 long durationMs)

rpc

public static com.google.gson.JsonObject rpc(String details,
 String state)

rpcReset

public static com.google.gson.JsonObject rpcReset()

modsRequest

public static com.google.gson.JsonObject modsRequest(String nonce)

reset

public static com.google.gson.JsonObject reset()

encode

public static byte[] encode(com.google.gson.JsonObject o)