TuoniWebSocket

Connections renew before token expiry, using the client’s serialized token refresh. Transient disconnects retry with delays of 1 to 30 seconds and restore subscriptions. disconnect() stops recovery; connect() can restart it. The server does not replay events missed while disconnected.

Self-signed certificates are accepted by default, matching TuoniC2(). Set verify=True or a CA bundle path on the client to enable verification for both REST and WebSockets. Handshake redirects follow websocket-client’s standard handling and limit; an exhausted redirect limit is reported as a connection failure.

Authorization, TLS and STOMP failures stop recovery. User-event subscriptions require MANAGE_USERS; other event subscriptions require VIEW_RESOURCES. After correcting access, refresh or log in and reconnect explicitly.

Use on_error(callback) or TuoniC2.connect_websocket(on_error=callback) for failure notifications. Callbacks receive an exception in a daemon thread. last_error retains the latest failure, and errors without a callback are logged. A custom CA bundle configured on TuoniC2 also applies here.

Application events

The library covers all 51 server application event types and their 13 resource topics. The server groups these topics by resource: for example, /topic/events/by-type/NOTE carries CREATE_NOTE, UPDATE_NOTE, and ARCHIVE_NOTE. The individual type is the event dictionary’s eventType field.

Subscribe to a specific type with its convenience method or an EVENT_* constant and on_event_type():

from tuoni import TuoniWebSocket

ws = client.connect_websocket()
ws.on_event_create_note(lambda event: print("Created note:", event))
ws.on_event_type(
    TuoniWebSocket.EVENT_ARCHIVE_NOTE,
    lambda event: print("Archived note:", event),
)

Both forms select the resource topic and filter incoming messages by eventType. Every type has a convenience method named on_event_ followed by its lowercase name. on_event_type() rejects unsupported types with ValueError; noncallable callbacks raise TypeError.

To receive every event for a resource, use its on_events_* helper or on_event(topic, callback) with a TOPIC_EVENTS_* constant:

ws.on_events_note(lambda event: print(event["eventType"]))
ws.on_event(
    TuoniWebSocket.TOPIC_EVENTS_COMMAND,
    lambda event: print(event["eventType"]),
)

Callbacks receive the complete, unchanged JSON event dictionary in a daemon thread. References and their data depend on the event; CHANGE_SETTINGS has an empty references list. Events do not refresh existing library objects. Callbacks for the same resource share a STOMP subscription, and all registered callbacks survive reconnection. Registering both a resource callback and a matching type callback invokes both.

on_note(callback) remains a shorthand for on_events_note(callback); TOPIC_NOTE and TOPIC_EVENTS_NOTE are the same destination. Note events include their current note data in references[].data.

Resource topics

Every resource topic is /topic/events/by-type/ followed by the resource name below. The USER topic requires MANAGE_USERS; the other topics require VIEW_RESOURCES.

Resource

Topic constant

Callback helper

AGENT

TOPIC_EVENTS_AGENT

on_events_agent(callback)

DISCOVERED_HOST

TOPIC_EVENTS_DISCOVERED_HOST

on_events_discovered_host(callback)

DISCOVERED_SERVICE

TOPIC_EVENTS_DISCOVERED_SERVICE

on_events_discovered_service(callback)

DISCOVERED_CREDENTIAL

TOPIC_EVENTS_DISCOVERED_CREDENTIAL

on_events_discovered_credential(callback)

JOB

TOPIC_EVENTS_JOB

on_events_job(callback)

COMMAND

TOPIC_EVENTS_COMMAND

on_events_command(callback)

COMMAND_ALIAS

TOPIC_EVENTS_COMMAND_ALIAS

on_events_command_alias(callback)

NOTE

TOPIC_EVENTS_NOTE

on_events_note(callback)

LISTENER

TOPIC_EVENTS_LISTENER

on_events_listener(callback)

FILE

TOPIC_EVENTS_FILE

on_events_file(callback)

PAYLOAD

TOPIC_EVENTS_PAYLOAD

on_events_payload(callback)

SETTING

TOPIC_EVENTS_SETTING

on_events_setting(callback)

USER

TOPIC_EVENTS_USER

on_events_user(callback)

Event types

Each EVENT_* constant’s string value is its name without the EVENT_ prefix. For example, EVENT_CREATE_NOTE == "CREATE_NOTE".

Event constant

Callback helper

Resource

EVENT_REGISTER_AGENT

on_event_register_agent(callback)

AGENT

EVENT_DEACTIVATE_AGENT

on_event_deactivate_agent(callback)

AGENT

EVENT_REACTIVATE_AGENT

on_event_reactivate_agent(callback)

AGENT

EVENT_BLOCK_AGENT

on_event_block_agent(callback)

AGENT

EVENT_UPDATE_AGENT_METADATA

on_event_update_agent_metadata(callback)

AGENT

EVENT_MODIFY_AGENT_METADATA

on_event_modify_agent_metadata(callback)

AGENT

EVENT_AGENT_HEARTBEAT

on_event_agent_heartbeat(callback)

AGENT

EVENT_CREATE_DISCOVERED_HOST

on_event_create_discovered_host(callback)

DISCOVERED_HOST

EVENT_EDIT_DISCOVERED_HOST

on_event_edit_discovered_host(callback)

DISCOVERED_HOST

EVENT_ARCHIVE_DISCOVERED_HOST

on_event_archive_discovered_host(callback)

DISCOVERED_HOST

EVENT_RESTORE_DISCOVERED_HOST

on_event_restore_discovered_host(callback)

DISCOVERED_HOST

EVENT_CREATE_DISCOVERED_SERVICE

on_event_create_discovered_service(callback)

DISCOVERED_SERVICE

EVENT_EDIT_DISCOVERED_SERVICE

on_event_edit_discovered_service(callback)

DISCOVERED_SERVICE

EVENT_ARCHIVE_DISCOVERED_SERVICE

on_event_archive_discovered_service(callback)

DISCOVERED_SERVICE

EVENT_RESTORE_DISCOVERED_SERVICE

on_event_restore_discovered_service(callback)

DISCOVERED_SERVICE

EVENT_CREATE_DISCOVERED_CREDENTIAL

on_event_create_discovered_credential(callback)

DISCOVERED_CREDENTIAL

EVENT_EDIT_DISCOVERED_CREDENTIAL

on_event_edit_discovered_credential(callback)

DISCOVERED_CREDENTIAL

EVENT_ARCHIVE_DISCOVERED_CREDENTIAL

on_event_archive_discovered_credential(callback)

DISCOVERED_CREDENTIAL

EVENT_RESTORE_DISCOVERED_CREDENTIAL

on_event_restore_discovered_credential(callback)

DISCOVERED_CREDENTIAL

EVENT_CREATE_JOB

on_event_create_job(callback)

JOB

EVENT_UPDATE_JOB

on_event_update_job(callback)

JOB

EVENT_CREATE_COMMAND

on_event_create_command(callback)

COMMAND

EVENT_RECOVER_COMMAND

on_event_recover_command(callback)

COMMAND

EVENT_SEND_COMMAND

on_event_send_command(callback)

COMMAND

EVENT_RECEIVE_COMMAND_RESULT

on_event_receive_command_result(callback)

COMMAND

EVENT_CREATE_COMMAND_UPDATE

on_event_create_command_update(callback)

COMMAND

EVENT_SEND_COMMAND_UPDATE

on_event_send_command_update(callback)

COMMAND

EVENT_CANCEL_COMMAND

on_event_cancel_command(callback)

COMMAND

EVENT_CREATE_COMMAND_ALIAS

on_event_create_command_alias(callback)

COMMAND_ALIAS

EVENT_UPDATE_COMMAND_ALIAS

on_event_update_command_alias(callback)

COMMAND_ALIAS

EVENT_ARCHIVE_COMMAND_ALIAS

on_event_archive_command_alias(callback)

COMMAND_ALIAS

EVENT_CREATE_NOTE

on_event_create_note(callback)

NOTE

EVENT_UPDATE_NOTE

on_event_update_note(callback)

NOTE

EVENT_ARCHIVE_NOTE

on_event_archive_note(callback)

NOTE

EVENT_CREATE_LISTENER

on_event_create_listener(callback)

LISTENER

EVENT_RECOVER_LISTENER

on_event_recover_listener(callback)

LISTENER

EVENT_UPDATE_LISTENER

on_event_update_listener(callback)

LISTENER

EVENT_START_LISTENER

on_event_start_listener(callback)

LISTENER

EVENT_STOP_LISTENER

on_event_stop_listener(callback)

LISTENER

EVENT_DELETE_LISTENER

on_event_delete_listener(callback)

LISTENER

EVENT_CREATE_FILE

on_event_create_file(callback)

FILE

EVENT_UPDATE_FILE

on_event_update_file(callback)

FILE

EVENT_DELETE_FILE

on_event_delete_file(callback)

FILE

EVENT_CREATE_PAYLOAD

on_event_create_payload(callback)

PAYLOAD

EVENT_RECOVER_PAYLOAD

on_event_recover_payload(callback)

PAYLOAD

EVENT_UPDATE_PAYLOAD

on_event_update_payload(callback)

PAYLOAD

EVENT_ARCHIVE_PAYLOAD

on_event_archive_payload(callback)

PAYLOAD

EVENT_CHANGE_SETTINGS

on_event_change_settings(callback)

SETTING

EVENT_CREATE_USER

on_event_create_user(callback)

USER

EVENT_UPDATE_USER

on_event_update_user(callback)

USER

EVENT_LOGIN_USER

on_event_login_user(callback)

USER

Legacy notifications

The original notification topics and their callback payloads remain supported. Their payloads are specific to each topic, while application events above use event dictionaries. In particular, on_agent_heartbeat() receives the legacy heartbeat payload; on_event_agent_heartbeat() receives the AGENT_HEARTBEAT event dictionary. Command-template notifications are available through their legacy topics.

Topic constant

Destination

Callback helper

TOPIC_AGENT

/topic/agent

on_new_agent(callback)

TOPIC_AGENT_HEARTBEAT

/topic/agent/heartbeat

on_agent_heartbeat(callback)

TOPIC_AGENT_ACTIVE

/topic/agent/active

on_agent_active_change(callback)

TOPIC_AGENT_METADATA

/topic/agent/metadata

on_agent_metadata(callback)

TOPIC_COMMAND_SENT

/topic/command/sent

on_command_sent(callback)

TOPIC_COMMAND_RESULT

/topic/command/result

on_command_result(callback)

TOPIC_COMMAND_TEMPLATE_NEW

/topic/command-templates/new

on_command_template_new(callback)

TOPIC_COMMAND_TEMPLATE_REMOVED

/topic/command-templates/removed

on_command_template_removed(callback)

TOPIC_COMMAND_ALIAS_NEW

/topic/command-alias/new

on_command_alias_new(callback)

TOPIC_COMMAND_ALIAS_REMOVED

/topic/command-alias/removed

on_command_alias_removed(callback)

TOPIC_LISTENER_NEW

/topic/listener/new

on_listener_new(callback)

TOPIC_LISTENER_REMOVED

/topic/listener/removed

on_listener_removed(callback)

TOPIC_LISTENER_MODIFIED

/topic/listener/modified

on_listener_modified(callback)

TOPIC_PAYLOAD_NEW

/topic/payload/new

on_payload_new(callback)

TOPIC_PAYLOAD_ARCHIVED

/topic/payload/archived

on_payload_archived(callback)

TOPIC_USER_NEW

/topic/users/new

on_user_new(callback)

TOPIC_USER_MODIFIED

/topic/users/modified

on_user_modified(callback)

API reference

class tuoni.TuoniWebSocket(c2)[source]

Real-time WebSocket client for the Tuoni server using SockJS/STOMP.

Subscribes to server-pushed events (agent checkins, command results, listener changes, etc.) without polling. Requires the websocket-client package.

Expiring tokens and transient disconnects trigger reconnection with restored subscriptions. Permission denials and invalid authentication stop recovery. Events sent during a disconnect are not replayed by the server.

Application events use TOPIC_EVENTS_* resource topics and EVENT_* event-type constants. Use on_events_* for a whole resource category, or on_event_* for one event type. Both receive raw event dictionaries. Existing topic callbacks retain their original payload formats.

TOPIC_AGENT

New agent registered.

Type:

str

TOPIC_AGENT_HEARTBEAT

Agent heartbeat/checkin.

Type:

str

TOPIC_AGENT_ACTIVE

Agent active-status change.

Type:

str

TOPIC_AGENT_METADATA

Agent metadata changed.

Type:

str

TOPIC_COMMAND_SENT

Command dispatched to agent.

Type:

str

TOPIC_COMMAND_RESULT

Command result received.

Type:

str

TOPIC_COMMAND_TEMPLATE_NEW

New command template available.

Type:

str

TOPIC_COMMAND_TEMPLATE_REMOVED

Command template removed.

Type:

str

TOPIC_COMMAND_ALIAS_NEW

New command alias available.

Type:

str

TOPIC_COMMAND_ALIAS_REMOVED

Command alias removed.

Type:

str

TOPIC_LISTENER_NEW

New listener created.

Type:

str

TOPIC_LISTENER_REMOVED

Listener deleted.

Type:

str

TOPIC_LISTENER_MODIFIED

Listener configuration changed.

Type:

str

TOPIC_PAYLOAD_NEW

New payload created.

Type:

str

TOPIC_PAYLOAD_ARCHIVED

Payload archived.

Type:

str

TOPIC_USER_NEW

New user created.

Type:

str

TOPIC_USER_MODIFIED

User modified.

Type:

str

TOPIC_NOTE

Command note created, updated or archived.

Type:

str

Examples

>>> ws = tuoni_server.connect_websocket()
>>> results = []
>>> ws.on_command_result(lambda data: results.append(data))
>>> agent.send_command(TuoniCommandLs(".", 1))
>>> # callback fires when agent returns the result
EVENT_AGENT_HEARTBEAT = 'AGENT_HEARTBEAT'
EVENT_ARCHIVE_COMMAND_ALIAS = 'ARCHIVE_COMMAND_ALIAS'
EVENT_ARCHIVE_DISCOVERED_CREDENTIAL = 'ARCHIVE_DISCOVERED_CREDENTIAL'
EVENT_ARCHIVE_DISCOVERED_HOST = 'ARCHIVE_DISCOVERED_HOST'
EVENT_ARCHIVE_DISCOVERED_SERVICE = 'ARCHIVE_DISCOVERED_SERVICE'
EVENT_ARCHIVE_NOTE = 'ARCHIVE_NOTE'
EVENT_ARCHIVE_PAYLOAD = 'ARCHIVE_PAYLOAD'
EVENT_BLOCK_AGENT = 'BLOCK_AGENT'
EVENT_CANCEL_COMMAND = 'CANCEL_COMMAND'
EVENT_CHANGE_SETTINGS = 'CHANGE_SETTINGS'
EVENT_CREATE_COMMAND = 'CREATE_COMMAND'
EVENT_CREATE_COMMAND_ALIAS = 'CREATE_COMMAND_ALIAS'
EVENT_CREATE_COMMAND_UPDATE = 'CREATE_COMMAND_UPDATE'
EVENT_CREATE_DISCOVERED_CREDENTIAL = 'CREATE_DISCOVERED_CREDENTIAL'
EVENT_CREATE_DISCOVERED_HOST = 'CREATE_DISCOVERED_HOST'
EVENT_CREATE_DISCOVERED_SERVICE = 'CREATE_DISCOVERED_SERVICE'
EVENT_CREATE_FILE = 'CREATE_FILE'
EVENT_CREATE_JOB = 'CREATE_JOB'
EVENT_CREATE_LISTENER = 'CREATE_LISTENER'
EVENT_CREATE_NOTE = 'CREATE_NOTE'
EVENT_CREATE_PAYLOAD = 'CREATE_PAYLOAD'
EVENT_CREATE_USER = 'CREATE_USER'
EVENT_DEACTIVATE_AGENT = 'DEACTIVATE_AGENT'
EVENT_DELETE_FILE = 'DELETE_FILE'
EVENT_DELETE_LISTENER = 'DELETE_LISTENER'
EVENT_EDIT_DISCOVERED_CREDENTIAL = 'EDIT_DISCOVERED_CREDENTIAL'
EVENT_EDIT_DISCOVERED_HOST = 'EDIT_DISCOVERED_HOST'
EVENT_EDIT_DISCOVERED_SERVICE = 'EDIT_DISCOVERED_SERVICE'
EVENT_LOGIN_USER = 'LOGIN_USER'
EVENT_MODIFY_AGENT_METADATA = 'MODIFY_AGENT_METADATA'
EVENT_REACTIVATE_AGENT = 'REACTIVATE_AGENT'
EVENT_RECEIVE_COMMAND_RESULT = 'RECEIVE_COMMAND_RESULT'
EVENT_RECOVER_COMMAND = 'RECOVER_COMMAND'
EVENT_RECOVER_LISTENER = 'RECOVER_LISTENER'
EVENT_RECOVER_PAYLOAD = 'RECOVER_PAYLOAD'
EVENT_REGISTER_AGENT = 'REGISTER_AGENT'
EVENT_RESTORE_DISCOVERED_CREDENTIAL = 'RESTORE_DISCOVERED_CREDENTIAL'
EVENT_RESTORE_DISCOVERED_HOST = 'RESTORE_DISCOVERED_HOST'
EVENT_RESTORE_DISCOVERED_SERVICE = 'RESTORE_DISCOVERED_SERVICE'
EVENT_SEND_COMMAND = 'SEND_COMMAND'
EVENT_SEND_COMMAND_UPDATE = 'SEND_COMMAND_UPDATE'
EVENT_START_LISTENER = 'START_LISTENER'
EVENT_STOP_LISTENER = 'STOP_LISTENER'
EVENT_UPDATE_AGENT_METADATA = 'UPDATE_AGENT_METADATA'
EVENT_UPDATE_COMMAND_ALIAS = 'UPDATE_COMMAND_ALIAS'
EVENT_UPDATE_FILE = 'UPDATE_FILE'
EVENT_UPDATE_JOB = 'UPDATE_JOB'
EVENT_UPDATE_LISTENER = 'UPDATE_LISTENER'
EVENT_UPDATE_NOTE = 'UPDATE_NOTE'
EVENT_UPDATE_PAYLOAD = 'UPDATE_PAYLOAD'
EVENT_UPDATE_USER = 'UPDATE_USER'
TOPIC_EVENTS_AGENT = '/topic/events/by-type/AGENT'
TOPIC_EVENTS_COMMAND = '/topic/events/by-type/COMMAND'
TOPIC_EVENTS_COMMAND_ALIAS = '/topic/events/by-type/COMMAND_ALIAS'
TOPIC_EVENTS_DISCOVERED_CREDENTIAL = '/topic/events/by-type/DISCOVERED_CREDENTIAL'
TOPIC_EVENTS_DISCOVERED_HOST = '/topic/events/by-type/DISCOVERED_HOST'
TOPIC_EVENTS_DISCOVERED_SERVICE = '/topic/events/by-type/DISCOVERED_SERVICE'
TOPIC_EVENTS_FILE = '/topic/events/by-type/FILE'
TOPIC_EVENTS_JOB = '/topic/events/by-type/JOB'
TOPIC_EVENTS_LISTENER = '/topic/events/by-type/LISTENER'
TOPIC_EVENTS_NOTE = '/topic/events/by-type/NOTE'
TOPIC_EVENTS_PAYLOAD = '/topic/events/by-type/PAYLOAD'
TOPIC_EVENTS_SETTING = '/topic/events/by-type/SETTING'
TOPIC_EVENTS_USER = '/topic/events/by-type/USER'
connect(timeout: float = 10) → bool[source]

Connect to the server’s WebSocket endpoint and complete the STOMP handshake.

Parameters:

timeout (float) – Seconds to wait for the STOMP CONNECTED frame.

Returns:

True if the STOMP session was established within timeout seconds.

Return type:

bool

Examples

>>> ws = TuoniWebSocket(tuoni_server)
>>> if not ws.connect():
>>>     print("WebSocket connection failed")
disconnect()[source]

Send STOMP DISCONNECT and close the WebSocket.

property is_connected: bool

True if the STOMP session is active.

on_agent_active_change(callback)[source]

Register a callback for agent active-status changes.

on_agent_heartbeat(callback)[source]

Register a callback for agent heartbeats.

on_agent_metadata(callback)[source]

Register a callback for agent metadata changes.

on_command_alias_new(callback)[source]

Register a callback for new command aliases.

on_command_alias_removed(callback)[source]

Register a callback for removed command aliases.

on_command_result(callback)[source]

Register a callback for command results.

on_command_sent(callback)[source]

Register a callback for commands dispatched to agents.

on_command_template_new(callback)[source]

Register a callback for new command templates.

on_command_template_removed(callback)[source]

Register a callback for removed command templates.

on_error(callback)[source]

Register callback(exception) for connection, authorization and protocol errors.

Callbacks run in daemon threads. The most recent error is also available as last_error. Without a callback, errors are logged as warnings.

on_event(topic: str, callback)[source]

Subscribe to a STOMP topic and register a callback.

If already connected the subscription is sent immediately; otherwise it is queued and sent once the STOMP session is established.

Parameters:
  • topic (str) – STOMP topic (e.g. TuoniWebSocket.TOPIC_COMMAND_RESULT).

  • callback (callable) – Called with the deserialized JSON payload when a message arrives. Runs in a daemon thread.

Examples

>>> ws.on_event(TuoniWebSocket.TOPIC_AGENT, lambda data: print("new agent:", data))
on_event_agent_heartbeat(callback)[source]

Register a callback for AGENT_HEARTBEAT application events (raw JSON).

on_event_archive_command_alias(callback)[source]

Register a callback for ARCHIVE_COMMAND_ALIAS application events (raw JSON).

on_event_archive_discovered_credential(callback)[source]

Register a callback for ARCHIVE_DISCOVERED_CREDENTIAL application events (raw JSON).

on_event_archive_discovered_host(callback)[source]

Register a callback for ARCHIVE_DISCOVERED_HOST application events (raw JSON).

on_event_archive_discovered_service(callback)[source]

Register a callback for ARCHIVE_DISCOVERED_SERVICE application events (raw JSON).

on_event_archive_note(callback)[source]

Register a callback for ARCHIVE_NOTE application events (raw JSON).

on_event_archive_payload(callback)[source]

Register a callback for ARCHIVE_PAYLOAD application events (raw JSON).

on_event_block_agent(callback)[source]

Register a callback for BLOCK_AGENT application events (raw JSON).

on_event_cancel_command(callback)[source]

Register a callback for CANCEL_COMMAND application events (raw JSON).

on_event_change_settings(callback)[source]

Register a callback for CHANGE_SETTINGS application events (raw JSON).

on_event_create_command(callback)[source]

Register a callback for CREATE_COMMAND application events (raw JSON).

on_event_create_command_alias(callback)[source]

Register a callback for CREATE_COMMAND_ALIAS application events (raw JSON).

on_event_create_command_update(callback)[source]

Register a callback for CREATE_COMMAND_UPDATE application events (raw JSON).

on_event_create_discovered_credential(callback)[source]

Register a callback for CREATE_DISCOVERED_CREDENTIAL application events (raw JSON).

on_event_create_discovered_host(callback)[source]

Register a callback for CREATE_DISCOVERED_HOST application events (raw JSON).

on_event_create_discovered_service(callback)[source]

Register a callback for CREATE_DISCOVERED_SERVICE application events (raw JSON).

on_event_create_file(callback)[source]

Register a callback for CREATE_FILE application events (raw JSON).

on_event_create_job(callback)[source]

Register a callback for CREATE_JOB application events (raw JSON).

on_event_create_listener(callback)[source]

Register a callback for CREATE_LISTENER application events (raw JSON).

on_event_create_note(callback)[source]

Register a callback for CREATE_NOTE application events (raw JSON).

on_event_create_payload(callback)[source]

Register a callback for CREATE_PAYLOAD application events (raw JSON).

on_event_create_user(callback)[source]

Register a callback for CREATE_USER application events (raw JSON).

on_event_deactivate_agent(callback)[source]

Register a callback for DEACTIVATE_AGENT application events (raw JSON).

on_event_delete_file(callback)[source]

Register a callback for DELETE_FILE application events (raw JSON).

on_event_delete_listener(callback)[source]

Register a callback for DELETE_LISTENER application events (raw JSON).

on_event_edit_discovered_credential(callback)[source]

Register a callback for EDIT_DISCOVERED_CREDENTIAL application events (raw JSON).

on_event_edit_discovered_host(callback)[source]

Register a callback for EDIT_DISCOVERED_HOST application events (raw JSON).

on_event_edit_discovered_service(callback)[source]

Register a callback for EDIT_DISCOVERED_SERVICE application events (raw JSON).

on_event_login_user(callback)[source]

Register a callback for LOGIN_USER application events (raw JSON).

on_event_modify_agent_metadata(callback)[source]

Register a callback for MODIFY_AGENT_METADATA application events (raw JSON).

on_event_reactivate_agent(callback)[source]

Register a callback for REACTIVATE_AGENT application events (raw JSON).

on_event_receive_command_result(callback)[source]

Register a callback for RECEIVE_COMMAND_RESULT application events (raw JSON).

on_event_recover_command(callback)[source]

Register a callback for RECOVER_COMMAND application events (raw JSON).

on_event_recover_listener(callback)[source]

Register a callback for RECOVER_LISTENER application events (raw JSON).

on_event_recover_payload(callback)[source]

Register a callback for RECOVER_PAYLOAD application events (raw JSON).

on_event_register_agent(callback)[source]

Register a callback for REGISTER_AGENT application events (raw JSON).

on_event_restore_discovered_credential(callback)[source]

Register a callback for RESTORE_DISCOVERED_CREDENTIAL application events (raw JSON).

on_event_restore_discovered_host(callback)[source]

Register a callback for RESTORE_DISCOVERED_HOST application events (raw JSON).

on_event_restore_discovered_service(callback)[source]

Register a callback for RESTORE_DISCOVERED_SERVICE application events (raw JSON).

on_event_send_command(callback)[source]

Register a callback for SEND_COMMAND application events (raw JSON).

on_event_send_command_update(callback)[source]

Register a callback for SEND_COMMAND_UPDATE application events (raw JSON).

on_event_start_listener(callback)[source]

Register a callback for START_LISTENER application events (raw JSON).

on_event_stop_listener(callback)[source]

Register a callback for STOP_LISTENER application events (raw JSON).

on_event_type(event_type: str, callback)[source]

Register a callback for a single application event type.

The server groups application events by resource topic. This method subscribes to the matching topic and filters its messages by eventType. Multiple callbacks share one STOMP subscription per topic, including after reconnection.

Parameters:
  • event_type (str) – A supported EVENT_* constant, such as TuoniWebSocket.EVENT_CREATE_NOTE.

  • callback (callable) – Receives the unchanged event dictionary, including eventType, actor, parentEvent and references. Runs in a daemon thread.

Raises:
  • TypeError – If callback is not callable.

  • ValueError – If event_type is not a supported event type.

User events require MANAGE_USERS; other application events require VIEW_RESOURCES. Unknown future event types can still be received through on_event(topic, callback) or the category callbacks.

Examples

>>> ws.on_event_type(TuoniWebSocket.EVENT_CREATE_NOTE, print)
on_event_update_agent_metadata(callback)[source]

Register a callback for UPDATE_AGENT_METADATA application events (raw JSON).

on_event_update_command_alias(callback)[source]

Register a callback for UPDATE_COMMAND_ALIAS application events (raw JSON).

on_event_update_file(callback)[source]

Register a callback for UPDATE_FILE application events (raw JSON).

on_event_update_job(callback)[source]

Register a callback for UPDATE_JOB application events (raw JSON).

on_event_update_listener(callback)[source]

Register a callback for UPDATE_LISTENER application events (raw JSON).

on_event_update_note(callback)[source]

Register a callback for UPDATE_NOTE application events (raw JSON).

on_event_update_payload(callback)[source]

Register a callback for UPDATE_PAYLOAD application events (raw JSON).

on_event_update_user(callback)[source]

Register a callback for UPDATE_USER application events (raw JSON).

on_events_agent(callback)[source]

Register a callback for all AGENT application events (raw JSON).

on_events_command(callback)[source]

Register a callback for all COMMAND application events (raw JSON).

on_events_command_alias(callback)[source]

Register a callback for all COMMAND_ALIAS application events (raw JSON).

on_events_discovered_credential(callback)[source]

Register a callback for all DISCOVERED_CREDENTIAL application events (raw JSON).

on_events_discovered_host(callback)[source]

Register a callback for all DISCOVERED_HOST application events (raw JSON).

on_events_discovered_service(callback)[source]

Register a callback for all DISCOVERED_SERVICE application events (raw JSON).

on_events_file(callback)[source]

Register a callback for all FILE application events (raw JSON).

on_events_job(callback)[source]

Register a callback for all JOB application events (raw JSON).

on_events_listener(callback)[source]

Register a callback for all LISTENER application events (raw JSON).

on_events_note(callback)[source]

Register a callback for all NOTE application events (raw JSON).

on_events_payload(callback)[source]

Register a callback for all PAYLOAD application events (raw JSON).

on_events_setting(callback)[source]

Register a callback for all SETTING application events (raw JSON).

on_events_user(callback)[source]

Register a callback for all USER application events (raw JSON).

on_listener_modified(callback)[source]

Register a callback for listener modifications.

on_listener_new(callback)[source]

Register a callback for new listeners.

on_listener_removed(callback)[source]

Register a callback for removed listeners.

on_new_agent(callback)[source]

Register a callback for new agent registrations.

on_note(callback)[source]

Register a callback for command note events.

Parameters:

callback (callable) – Receives the raw JSON event for CREATE_NOTE, UPDATE_NOTE or ARCHIVE_NOTE. Note data is included in references[].data. Runs in a daemon thread.

Requires VIEW_RESOURCES. Existing note objects are not updated automatically, and events missed during disconnection are not replayed.

on_payload_archived(callback)[source]

Register a callback for archived payloads.

on_payload_new(callback)[source]

Register a callback for new payloads.

on_user_modified(callback)[source]

Register a callback for user modifications.

on_user_new(callback)[source]

Register a callback for new users.