Interface ConsumerOptions

consume options.

interface ConsumerOptions {
    describe?: string;
    fw?: Forwarder;
    modifyInterest?: Modify;
    retx?: RetxPolicy;
    signal?: AbortSignal;
    verifier?: Verifier;
}

Hierarchy

  • CommonOptions
    • ConsumerOptions

    Properties

    describe? fw? modifyInterest? retx? signal? verifier?

    Properties

    Optionaldescribe

    describe?: string

    Description for debugging purpose.

    Default Value

    In a consumer, "consume" + Interest name. In a producer, "produce" + main prefix.

    Optionalfw

    fw?: Forwarder

    Logical forwarder instance.

    Default Value

    Forwarder.getDefault()

    OptionalmodifyInterest

    modifyInterest?: Modify

    Modify Interest according to specified options.

    Default Value

    undefined, no modification.

    Optionalretx

    retx?: RetxPolicy

    Retransmission policy.

    Default Value

    undefined, no retransmission.

    Optionalsignal

    signal?: AbortSignal

    AbortSignal that allows cancelation via AbortController.

    Remarks

    In a consumer, the promise returned by consume() is rejected. In a producer, the producer is closed.

    Optionalverifier

    verifier?: Verifier

    Data verifier.

    Default Value

    undefined, no verification.

    Settings

    Member Visibility

    On This Page

    Properties