Options
All
  • Public
  • Public/Protected
  • All
Menu

@ndn/repo-api

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

This package defines the programming interface of an abstract Data repository, and functions that work with this interface.

DataStore

DataStore is a group of interfaces that defines the API of a Data repository. DataStore type of @ndn/repo package is an implementation of these interfaces.

Lookup and Enumeration Methods

get(name) retrieves Data by exact name.

find(interest) finds Data that satisfies Interest.

listNames(prefix?) iterates over names of stored Data.

listData(prefix?) iterates over stored Data.

Modifier Methods

insert([options], ...pkts) inserts Data packets.

erase(...names) deletes Data packets.

Bulk Insert

A repo may accept Data ingestion via bulk insertion protocol. The Data producer initiates a reliable connection to the repo's bulk insertion target, and then writes Data packets over this connection. The repo then saves received Data to storage, but provides no feedback. Conventionally, this protocol runs over TCP and uses port 7376.

This package implements core functionality of this protocol.

  • Data producer can use BulkInsertInitiator type to initiate bulk insertion.
  • Repo can use BulkInsertTarget type to accept bulk insertion.

They are used in @ndn/repo-cli package.

Index

References

BulkInsertInitiator

Re-exports BulkInsertInitiator

BulkInsertTarget

Re-exports BulkInsertTarget

BulkInserter

Re-exports BulkInserter

DataStore

Renames and re-exports repo-api

respondRdr

Re-exports respondRdr

Legend

  • Namespace
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Class
  • Class with type parameter
  • Enumeration

Generated using TypeDoc