module Obsctl::IPC::ErrorCode

Overview

Canonical public error-code taxonomy for server-to-client IPC failures.

Defined in:

obsctl/ipc/response.cr

Constant Summary

ALIAS_AMBIGUOUS = "ALIAS_AMBIGUOUS"

AUDIO_INPUT_NOT_FOUND = "AUDIO_INPUT_NOT_FOUND"

CODES = [CONFIG_INVALID, SERVER_UNAVAILABLE, OBS_UNAVAILABLE, REQUEST_TIMEOUT, OBS_REQUEST_FAILED, SCENE_NOT_FOUND, AUDIO_INPUT_NOT_FOUND, ALIAS_AMBIGUOUS, COMMAND_PARSE_ERROR, IPC_PROTOCOL_ERROR, SHUTDOWN_DISABLED, SERVER_ERROR]

COMMAND_PARSE_ERROR = "COMMAND_PARSE_ERROR"

CONFIG_INVALID = "CONFIG_INVALID"

IPC_PROTOCOL_ERROR = "IPC_PROTOCOL_ERROR"

LEGACY_CODES = {"CONFIG_ERROR" => CONFIG_INVALID, "REQUEST_FAILED" => OBS_REQUEST_FAILED, "INTERNAL_ERROR" => SERVER_ERROR, "INVALID_REQUEST" => IPC_PROTOCOL_ERROR}

OBS_REQUEST_FAILED = "OBS_REQUEST_FAILED"

OBS_UNAVAILABLE = "OBS_UNAVAILABLE"

REQUEST_TIMEOUT = "REQUEST_TIMEOUT"

SCENE_NOT_FOUND = "SCENE_NOT_FOUND"

SERVER_ERROR = "SERVER_ERROR"

SERVER_UNAVAILABLE = "SERVER_UNAVAILABLE"

SHUTDOWN_DISABLED = "SHUTDOWN_DISABLED"

Class Method Summary

• .canonical(code : String) : String
• .for_exception(error : Domain::ObsctlError) : String

Class Method Detail