Skip to main content

A ZeroMQ messaging router and client

Project description

Hydra Router

A standalone ZeroMQ-based message routing system that provides reliable communication between multiple clients and a single server.

Features

  • Centralized Message Routing: Routes messages between multiple clients and a single server
  • Message Format Conversion: Automatic conversion between internal and router message formats
  • Heartbeat Monitoring: Automatic client health monitoring and connection tracking
  • Comprehensive Error Handling: Detailed validation and error reporting
  • Simple Examples: Includes simple client/server examples for quick testing
  • Client Registry Query: Query router for connected client information

Installation

pip install hydra-router

Quick Start

Start the Router

# Basic usage
hydra-router

# Custom configuration
hydra-router --address 0.0.0.0 --port 5556 --log-level INFO

Simple Client/Server Demo

# Terminal 1: Start the router
hydra-router --log-level DEBUG

# Terminal 2: Start the simple server
hydra-server_simple --router tcp://localhost:5556

# Terminal 3: Start the simple client
hydra-client_simple --router tcp://localhost:5556
# Then enter numbers to see their squares calculated by the server

Using the MQClient Library

from hydra_router import MQClient, RouterConstants

# Create a client
client = MQClient(
    router_address="tcp://localhost:5556",
    client_type=RouterConstants.HYDRA_CLIENT,
    client_id="my-client-001"
)

# Connect and send messages
await client.connect()
await client.send_message(my_message)

# Query connected clients
client_table = await client.request_client_registry()
print("Connected clients:", client_table)

Architecture

The Hydra Router system consists of:

  • HydraRouter: Central message routing component
  • MQClient: Generic client library for applications
  • RouterConstants: Message format definitions and constants
  • SimpleClient/SimpleServer: Example applications

Configuration

The router supports the following command-line options:

  • --address, -a: IP address to bind to (default: 0.0.0.0)
  • --port, -p: Port to bind to (default: 5556)
  • --log-level: Logging level (DEBUG, INFO, WARNING, ERROR, default: INFO)
  • --help, -h: Show help message

Requirements

  • Python 3.11+
  • ZeroMQ (pyzmq)

License

GPL-3.0

Contributing

This project follows the specification-driven development methodology. See the .kiro/specs/ directory for detailed requirements, design, and implementation tasks.

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

hydra_router-0.2.3.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

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

hydra_router-0.2.3-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file hydra_router-0.2.3.tar.gz.

File metadata

  • Download URL: hydra_router-0.2.3.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.14 Linux/6.11.0-1018-azure

File hashes

Hashes for hydra_router-0.2.3.tar.gz
Algorithm Hash digest
SHA256 3d8c945e4e992745da687c2572b393d8ef948569e00ed6834527523a305df152
MD5 876a8d698729d2e0fff0e83208c3a5d0
BLAKE2b-256 5f6869a951756109000bbcaeffc669cf1ec292b5db6c328af7660d6983a417b0

See more details on using hashes here.

File details

Details for the file hydra_router-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: hydra_router-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.11.14 Linux/6.11.0-1018-azure

File hashes

Hashes for hydra_router-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 14f592bda03f14feb0e9ded917dad3fad27477d5e33f8b70a3a5d2933c77d6c0
MD5 5027730e6c5817a97c892861ad050eaa
BLAKE2b-256 b6f7798e44b712e774d55556ea939f51b33adb7a23c23f2c40a58105e12289f9

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