Skip to main content

Generic message bus transport — Unix Socket message routing, session management, heartbeat

Project description

hermes-bus

English | 中文

A generic message bus for Unix Socket IPC — message routing, session management, heartbeat.

Transport-only. Notification logic is injected via configurable hooks — the bus itself knows nothing about audio, display, or LLM context.

Install

pip install hermes-bus

Or from source:

git clone https://github.com/mlinquan/hermes-bus.git
cd hermes-bus && pip install -e .

CLI

# Daemon management
hermes-busd start       # Start the bus daemon
hermes-busd stop        # Stop the daemon
hermes-busd status      # Check daemon + connected endpoints
hermes-busd restart     # Restart the daemon

# Foreground server (for debugging)
hermes-bus-server

Python API

from hermes_bus.client import BusClient, send_message

# Long-lived: register as an endpoint and receive messages
client = BusClient("my-service")
client.connect()
for msg in client.poll():
    print(msg)

# Short-lived: fire-and-forget
send_message("target-service", {"text": "hello", "type": "ack"})

Architecture

client.py ──── Unix Socket ──── server.py
  (BusClient)                    (BusServer)
   - Register endpoint           - Session management
   - Heartbeat (60s)             - Message routing
   - Auto-reconnect              - Hook triggers
   - Thread-safe message queue
   
busd.py — Daemon manager: start / stop / status / restart

Protocol

4-byte big-endian length prefix + JSON body. Max payload: 10 MB.

Long-lived connections register an endpoint name and can send/receive. Short-lived connections send one message and disconnect — no registration, no endpoint_map pollution.

Hooks

After each message is routed, hook scripts are triggered asynchronously. Resolution priority:

  1. HERMES_BUS_HOOKS env var (comma-separated or JSON array of script paths)
  2. hooks.yaml config file
  3. Default: none (routing handled by hermes-bus-plugin)

Each hook receives the full message JSON on stdin. Hook execution is non-blocking — the bus continues routing.

Messages

{
  "type": "message",
  "to": "target-endpoint",
  "from": "sender-endpoint",
  "text": "hello",
  "body": { }
}

Special message types: register (endpoint registration), ping/pong (heartbeat), list_endpoints (admin query).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hermes_bus-0.4.0.tar.gz (14.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hermes_bus-0.4.0-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file hermes_bus-0.4.0.tar.gz.

File metadata

  • Download URL: hermes_bus-0.4.0.tar.gz
  • Upload date:
  • Size: 14.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for hermes_bus-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e7b4d367d5b545a606311741b57ca7b0abb1e345127777d191f4650eada1e18d
MD5 5245f4d52d2c6cd2ab7ce64efe5d84be
BLAKE2b-256 c28bfa9e56a3f418894874f061bda07a1ea90ea30d5d94cd5b12af042a254913

See more details on using hashes here.

File details

Details for the file hermes_bus-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: hermes_bus-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for hermes_bus-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 46fba30d5398762fea34ad17b29edeb2c7ed00f5fc22726a1dd8933d900c3065
MD5 14bdcc04f07a61aa64ab8b7126638df6
BLAKE2b-256 d6345d156a07452424c5cfdd7335633d4fc5e9749aeaaa382cea8761aba84813

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page