Skip to main content

Module paths

Module paths 

Source
Expand description

Room filesystem path resolution.

All persistent state lives under ~/.room/:

  • ~/.room/state/ — tokens, cursors, subscriptions (0700)
  • ~/.room/data/ — chat files (default, overridable via --data-dir)

Ephemeral runtime files (sockets, PID, meta) use the platform-native temporary directory:

  • macOS: $TMPDIR (per-user, e.g. /var/folders/...)
  • Linux: $XDG_RUNTIME_DIR/room/ or /tmp/ fallback

Functions§

broker_event_filters_path
Broker event-filter-map file path: <state_dir>/<room_id>.event_filters.
broker_subscriptions_path
Broker subscription-map file path: <state_dir>/<room_id>.subscriptions.
broker_tokens_path
Broker token-map file path: <state_dir>/<room_id>.tokens.
cursor_path
Cursor file path for a given room/user pair.
effective_socket_path
Resolve the effective daemon socket path.
ensure_room_dirs
Ensure ~/.room/state/ and ~/.room/data/ exist.
global_token_path
Global token file path for a user (room-independent).
legacy_token_dir
Directory that contained per-room token files in older daemon versions.
room_data_dir
Default directory for chat files: ~/.room/data/.
room_home
Root of all persistent room state: ~/.room/.
room_meta_path
Platform-native meta file path for a single-room broker.
room_pid_path
PID file for the daemon process: ~/.room/roomd.pid.
room_runtime_dir
Platform-native runtime directory for ephemeral room files (sockets, PID, meta).
room_single_socket_path
Socket path for a standalone single-room broker (test fixtures only).
room_socket_path
Platform-native socket path for the multi-room daemon.
room_state_dir
Directory for persistent state files (tokens, cursors, subscriptions).
system_tokens_path
System-level token persistence path: ~/.room/state/tokens.json.
token_path
Token file path for a given room/user pair (legacy, per-room tokens).