Options
All
  • Public
  • Public/Protected
  • All
Menu

Module endpoint

@ndn/endpoint

This package is part of NDNts, Named Data Networking libraries for the modern web.

This package implements Endpoint type, which is the basic abstraction through which an application can communicate with the NDN network.

An endpoint is similar to a "client face" in other NDN libraries, with the enhancement that it handles these details automatically:

  • Outgoing packets are signed and incoming packets are verified, if trust schema is provided.
  • Outgoing Interests are retransmitted periodically, if retransmission policy is specified.
  • Outgoing Data buffer, if enabled, allows the producer to reply to one Interest with multiple Data (e.g. segments), or push generated Data without receiving an Interest.
    Data will be sent automatically upon Interest arrival.
    
  • The underlying transport is reconnected upon failure, if transport failure policy is specified (implemented in @ndn/l3face package).
  • Prefix registrations are refreshed periodically or upon transport reconnection.

Index

Type aliases

ConsumerContext

ConsumerContext: Promise<Data> & { interest: Interest; nRetx: number }

Progress of Data retrieval.

This is a Promise that resolves with the retrieved Data, and rejects upon timeout. Calling .cancel() cancels Data retrieval and rejects the Promise.

ProducerHandler

ProducerHandler: (interest: Interest, producer: Producer) => Promise<Data | undefined>

Producer handler function.

The handler can return a Data to respond to the Interest, or return undefined to cause a timeout.

If Options.dataBuffer is provided, the handler can access the DataBuffer via producer.dataBuffer . The handler can return a Data to respond to the Interest, which is also inserted to the DataBuffer unless Options.autoBuffer is set to false. If the handler returns undefined, the Interest is used to query the DataBuffer, and any matching Data may be sent.

Type declaration

RetxPolicy

RetxPolicy: RetxOptions | RetxGenerator | number

Interest retransmission policy.

A number is interpreted as the limit. Set 0 to disable retransmissions.

Generated using TypeDoc