Documentation

Complete API documentation for mqutils

API Documentation

Welcome to the complete API documentation for mqutils. This documentation provides detailed information about all public interfaces, types, and functions across the entire library.

Documentation Structure

Core Components

  • Core Types - All interfaces and types used throughout mqutils

    • Consumer, Producer, Publisher, Transport interfaces
    • Message and MessageBuilder interfaces
    • Health checking interfaces
    • Handler types and registration

  • Main Package - Entry points and factory functions

    • NewConsumer and NewProducer factory functions
    • Global handler registration
    • Package-level documentation

Message Queue Implementations

Each implementation provides the same unified API while supporting system-specific features:

  • AMQP/RabbitMQ - Full AMQP 0-9-1 support

    • Exchange routing and dead letter queues
    • Channel pooling and connection management
    • Priority queues and message TTL

  • Apache Kafka - Event streaming platform

    • Consumer groups and partition management
    • SASL authentication and compression
    • Batch processing optimization

  • NATS - Cloud-native messaging

    • Core NATS and JetStream modes
    • Request-reply patterns
    • Clustering and persistence

  • AWS SQS - Amazon Simple Queue Service

    • Standard and FIFO queues
    • Visibility timeout management
    • Dead letter queue support

  • GCP Pub/Sub - Google Cloud Pub/Sub

    • Message ordering and exactly-once delivery
    • Flow control and batching
    • Dead letter topics

  • Redis - In-memory data structure store

    • Pub/Sub and Streams modes
    • Consumer groups for Streams
    • Connection pooling

Quick Navigation

API Stability

All public APIs documented here follow semantic versioning. We maintain backward compatibility for all v1.x releases.

Contributing

Found an issue in the documentation? Please submit an issue or merge request on GitLab.

Documentation Pages

Core Types

Core interfaces and types used throughout mqutils

Main Package

Entry points and factory functions for mqutils

AMQP

AMQP/RabbitMQ message queue implementation with exchanges, routing keys, and dead letter queues

Kafka

Apache Kafka event streaming implementation with consumer groups, partitions, and SASL/TLS support

NATS

NATS Core and JetStream cloud-native messaging with clustering and persistence support

AWS SQS

AWS SQS cloud-managed message queue implementation with FIFO support and visibility timeout

GCP Pub/Sub

Google Cloud Pub/Sub messaging with exactly-once delivery and message ordering support

Redis

Redis Pub/Sub and Streams messaging with in-memory performance and optional persistence

Examples Package

Example handlers and utility functions