Interface Producer

A running producer.

interface Producer {
    close: (() => void);
    dataBuffer?: DataBuffer;
    face: FwFace;
    prefix: undefined | Name;
    processInterest: ((interest) => Promise<undefined | Data>);
}

Hierarchy

  • Disposable
    • Producer

Properties

close dataBuffer? face prefix processInterest

Properties

close

close: (() => void)

Close the producer.

Type declaration

    • (): void

    • Returns void

Optional Readonly dataBuffer

dataBuffer?: DataBuffer

Outgoing Data buffer.

Readonly face

face: FwFace

Logical forwarder face for this producer.

Readonly prefix

prefix: undefined | Name

Prefix specified in produce call. Additional prefixes can be added via .face.addRoute().

processInterest

processInterest: ((interest) => Promise<undefined | Data>)

Process an Interest received elsewhere.

Type declaration

    • (interest): Promise<undefined | Data>

    • Parameters

      Returns Promise<undefined | Data>

Remarks

Use case of this function:

  1. Producer A dynamically creates producer B upon receiving an Interest.
  2. Producer A can invoke this function to let producer B generate a response.
  3. The response should be sent by producer A.

Settings

Member Visibility

Theme

On This Page

closedataBufferfaceprefixprocessInterest