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.3.7.tar.gz (38.7 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.3.7-py3-none-any.whl (44.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hydra_router-0.3.7.tar.gz
  • Upload date:
  • Size: 38.7 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.3.7.tar.gz
Algorithm Hash digest
SHA256 3d61f9de64dad862850db6c7ede0a1126e58c29461b251f4b75fe5e184aeb9c7
MD5 a530f33cd99a513388139f29b8aef3c7
BLAKE2b-256 fb321850e6ac35d787eb4baae6d98b10a17e65c6503c9ef78057a4f20148d75e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hydra_router-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 44.2 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.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 f9f1f46874d2a6128c5038c01c499c9c4d9bcb36e6f6b9ab9e357633a235ba98
MD5 6c5e9a281e0091b9f8cc938c6d999068
BLAKE2b-256 a983f9fcc1e17122ec284b8123ef7f7e1b6c333aec8d4780b91da05dae2f7d48

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