Class PrpsPublisher

Type declaration

• Optionalannouncement?: FwFace.RouteAnnouncement

  What name to be readvertised. Ignored if prefix is undefined.

• OptionalautoBuffer?: boolean

  Whether to add handler return value to .dataBuffer.

  Default Value

  true

  Remarks

  This is only relevant when .dataBuffer is set. If true, when the ProducerHandler returns a Data packet, it is automatically inserted to the DataBuffer.

• Optionalconcurrency?: number

  How many Interests to process in parallel.

  Default Value

  1

• OptionaldataBuffer?: DataBuffer

  Outgoing Data buffer.

  Remarks

  Providing an outgoing Data buffer allows the ProducerHandler to prepare multiple Data packets in response to one Interest, in which one Data satisfies the current Interest and additional Data satisfy upcoming Interests. This is useful for a producer that generates a multi-segment response triggered by a single Interest, such as a StatusDataset producer in NFD Management protocol.

  The producer handler can prepare the Data packets and insert them to the DataBuffer. Either it can return undefined, so that the DataBuffer is queried with the current Interest and the first matching Data is sent. Or it can return a specific Data packet for satisfying the current Interest.

• OptionaldataSigner?: Signer

  If specified, automatically sign Data packets that are not yet signed.

  Remarks

  If the ProducerHandler returns a Data packet that is not signed (its SigType is Null), it is automatically signed with this signer.

  This option does not apply to Data packets manually inserted into .dataBuffer. To auto-sign those packet, specify DataStoreBuffer.Options.dataSigner in addition.

• Optionaldescribe?: string

  Description for debugging purpose.

  Default Value

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

• fw: Forwarder

  Logical forwarder instance.

  Default Value

  Forwarder.getDefault()

• OptionalmodifyInterest?: Modify

  Modify Interest according to specified options.

  Default Value

  undefined, no modification.

• Optionalretx?: RetxPolicy

  Retransmission policy.

  Default Value

  undefined, no retransmission.

• OptionalrouteCapture?: boolean

  Whether routes registered by producer would cause @ndn/fw internal FIB to stop matching toward shorter prefixes.

  Default Value

  true

  Remarks

  If all nexthops of a FIB entry are set to non-capture, FIB lookup may continue onto nexthops on FIB entries with shorter prefixes. One use case is in dataset synchronization protocols, where both local and remote sync participants want to receive each other's Interests.

• Optionalsignal?: AbortSignal

  AbortSignal that allows cancellation via AbortController.

  Remarks

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

• Optionalverifier?: Verifier

  Data verifier.

  Default Value

  undefined, no verification.