Fake Mirrors
    Preparing search index...

    Interface AnalyzeQueue

    Defines the public contract for an analyze queue.

    This queue is responsible for processing captured messages from a reverse-proxy and performing analysis tasks like parsing, logging, or threat detection.

    interface AnalyzeQueue {
        addJob(name: string, data: AnalyzeJobData): Promise<void>;
        close(): Promise<void>;
        getJobCount(): Promise<number>;
        getWorkers(): Promise<object[]>;
    }

    Hierarchy (View Summary)

    Implemented by

    • Adds a new job to the analyze queue.

      Parameters

      • name: string

        The name of the job to be added.

      • data: AnalyzeJobData

        The arbitrary data to append to the job.

      Returns Promise<void>

      ProducerError If adding job fails.

    • Gracefully closes the queue.

      This method should be called during application shutdown.

      Returns Promise<void>

      LifecycleError If the queue cannot be closed properly.

    • Retrieves the total number of jobs in the queue.

      Returns Promise<number>

      The total job count.

      ProducerError If the count cannot be retrieved.

    • Retrieves the workers for the queue.

      Returns Promise<object[]>

      The queue workers list.

      ProducerError If the workers cannot be retrieved.

    Methods