Control Protocol

Verbs: Options, themes and the dock

Verbs: Options, themes and the dock: part of the Control Protocol of TUIOS.

This page is one part of docs/protocol.md of the tuios repository. The Control Protocol page lists every part.

set-option

Set a session option. The value is recorded in daemon owned session state so a later get-option reads it back, and works with no client attached. When a TUI is attached the change is also routed to it so options it understands apply to the live renderer; applied reports whether that live apply succeeded. With no TUI attached, applied is false and the value waits. The next TUI that attaches applies it.

Params: session (optional), key (required), value (optional), no_save (optional bool).

With no_save true, the client applies the value and does not write it to a config file. Later saves of other settings leave the key alone too. The value stays until the client exits, or until the option is set again without no_save. A value that waits for a client keeps no_save. The response always has no_save. A daemon that predates the param leaves it out of the response and saves the value. no_save is refused with invalid_params for agents.enabled, and when the attached client is too old to hold a value.

Request:

{"verb": "set-option", "params": {"session": "work", "key": "border_style", "value": "rounded"}}

Response:

{"result": {"type": "option_set", "key": "border_style", "value": "rounded", "applied": true, "no_save": false}}

get-option

Read a session option previously set with set-option.

Params: session (optional), key (required).

Request:

{"verb": "get-option", "params": {"session": "work", "key": "border_style"}}

Response:

{"result": {"type": "option", "key": "border_style", "value": "rounded"}}

A key that was never set returns an option_not_found error.

daemon.window_size is the daemon's own. set-option applies it to the session at once and answers applied: true and scope: "session", with no client involved. While a client from before the option is attached, the answer also has in_force: "smallest" and a reason. get-option of the key answers with source: "config" and the daemon's [daemon] window_size when the session has no value of its own.

tuios lives only at tuios.dev and github.com/Gaurav-Gosain/tuios. tuios has no X or Twitter account. An account that offers a tuios token or presale is not this project.

On this page