Interface ConsumerAdapter

A resource is extended component that represent the access to an external/internal resource, besides the error handling and identity, it has a start, stop and close methods to manage the resource lifecycle. It also has a checks property to define the checks that will be performed over the resource to achieve the resulted status. The most typical example of a resource are the Provider that allow to access to external databases, message brokers, etc.

interface ConsumerAdapter {
    on(event: "error", listener: (error: Crash | Error) => void): this;
    on(
        event: "status",
        listener: (status: "pass" | "fail" | "warn") => void,
    ): this;
    start(): Promise<void>;
    stop(): Promise<void>;
    subscribe(handler: OnCommandHandler): Promise<void>;
    unsubscribe(handler: OnCommandHandler): Promise<void>;
}

Hierarchy (View Summary)

Implemented by

Methods

on start stop subscribe unsubscribe

Methods

on

  • on(event: "error", listener: (error: Crash | Error) => void): this

  • Emitted when a adapter's operation has some error

    Parameters

    • event: "error"
    • listener: (error: Crash | Error) => void

    Returns this

  • on(event: "status", listener: (status: "pass" | "fail" | "warn") => void): this

  • Emitted on every state change

    Parameters

    • event: "status"
    • listener: (status: "pass" | "fail" | "warn") => void

    Returns this

start

  • start(): Promise<void>

  • Connect the OpenC2 Adapter to the underlayer transport system

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Disconnect the OpenC2 Adapter to the underlayer transport system

    Returns Promise<void>

subscribe

  • subscribe(handler: OnCommandHandler): Promise<void>

  • Subscribe the incoming command handler to the underlayer transport system

    Parameters

    Returns Promise<void>

unsubscribe

  • unsubscribe(handler: OnCommandHandler): Promise<void>

  • Unsubscribe the incoming command handler from the underlayer transport system

    Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods