Optional
announcementWhat name to be readvertised.
Ignored if prefix is undefined
.
Optional
autoWhether to add handler return value to .dataBuffer
.
true
This is only relevant when .dataBuffer
is set. If true
, when the ProducerHandler
returns a Data packet, it is automatically inserted to the DataBuffer.
Optional
concurrencyHow many Interests to process in parallel.
1
Optional
dataOutgoing Data buffer.
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 Interest. 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 can prepare the Data packets and insert them to the DataBuffer, and then return
undefined
, so that the Interest is used to query the DataBuffer and the first matching Data
is sent. The producer can also return a specify Data packet to satisfy the current Interest.
Optional
dataIf specified, automatically sign Data packets that are not yet signed.
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.
Optional
describeDescription for debugging purpose.
"consume" + Interest name.
Optional
fwLogical forwarder instance.
Forwarder.getDefault()
Optional
modifyModify Interest according to specified options.
undefined
, no modification.
Optional
retxRetransmission policy.
undefined
, no retransmission.
Optional
routeWhether routes registered by producer would cause @ndn/fw
internal FIB to stop matching
toward shorter prefixes.
true
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.
Optional
signalAbortSignal that allows canceling the Interest via AbortController.
Optional
verifierData verifier.
undefined
, no verification.
Generated using TypeDoc
Endpoint constructor options.
Remarks
This type includes consumer and producer options. These settings will be inherited by Endpoint.consume and Endpoint.produce unless overridden.