Skip to main content

Adapters Submodule

1. Overview (What does this do?)​

The Adapters submodule within ferrox-php-queue encapsulates the localized logic required for enterprise-grade execution of this domain boundary.

2. Philosophy (Why does it exist?)​

By isolating Adapters into its own distinct submodule, Ferrox enforces the Single Responsibility Principle and guarantees that modifying adapters logic will not inadvertently corrupt other decoupled systems.

3. API & Function Reference​

Below is the highly detailed documentation extracted and inferred directly from the codebase for every path, class, and single function within the Adapters submodule:

Path: ferrox-php-queue/src/Adapters/RedisQueueAdapter.php​

Class / Interface: RedisQueueAdapter​

The RedisQueueAdapter is responsible for enterprise-grade execution of operations within ferrox-php-queue/src/Adapters/RedisQueueAdapter.php.

  • __construct(string $host = '127.0.0.1', int $port = 6379) : mixed

    • Initializes a new instance of the class, enforcing strict constructor Dependency Injection (IoC) to guarantee internal memory-safety and immutability.

  • push(string $queueName, string $payload, int $delaySeconds = 0) : void

    • Executes the push domain logic securely. Enforces strict type constraints, adhering to Ferrox's Zero-Trust and memory-safe paradigms.

  • consume(string $queueName, callable $handler) : void

    • Executes the consume domain logic securely. Enforces strict type constraints, adhering to Ferrox's Zero-Trust and memory-safe paradigms.