Module rdr

@ndn/rdr

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

This package implements Realtime Data Retrieval (RDR) protocol.

Index

Namespaces

retrieveMetadata

Interfaces

Metadata

Variables

MetadataKeyword

Functions

Variables

Const MetadataKeyword

MetadataKeyword: Component = ...

32=metadata component.

Functions

decodeMetadataContent

decodeMetadataContent(wire: Uint8Array): Metadata

- Defined in packages/rdr/src/metadata.ts:22
Decode RDR metadata packet content.

Parameters
- wire: Uint8Array
Returns Metadata

encodeMetadataContent

encodeMetadataContent(__namedParameters: Metadata): Uint8Array

- Defined in packages/rdr/src/metadata.ts:15
Encode RDR metadata packet content.

Parameters
- __namedParameters: Metadata
Returns Uint8Array

isDiscoveryInterest

isDiscoveryInterest(__namedParameters: Interest): boolean

- Defined in packages/rdr/src/producer.ts:56
Determine if an Interest is an RDR discovery Interest.

Parameters
- __namedParameters: Interest
Returns boolean

makeDiscoveryInterest

makeDiscoveryInterest(prefix: NameLike): Interest

- Defined in packages/rdr/src/consumer.ts:11
Make RDR discovery Interest.

Parameters
- prefix: NameLike
  
  prefix of RDR metadata packet; 32=metadata component is optional.
Returns Interest

makeMetadataPacket

makeMetadataPacket(m: Metadata, __namedParameters?: Options): Promise<Data>

- Defined in packages/rdr/src/producer.ts:39
Make RDR metadata packet.

Parameters
- m: Metadata
- __namedParameters: Options = {}
Returns Promise<Data>

retrieveMetadata

retrieveMetadata(prefix: NameLike, __namedParameters?: Options): Promise<Metadata>

- Defined in packages/rdr/src/consumer.ts:20
Retrieve RDR metadata packet.

Parameters
- prefix: NameLike
- __namedParameters: Options = {}
Returns Promise<Metadata>

serveMetadata

serveMetadata(m: Metadata | (() => Metadata), opts?: Options): Producer

- Defined in packages/rdr/src/producer.ts:61
Serve RDR metadata packet in a producer.

Parameters
- m: Metadata | (() => Metadata)
- opts: Options = {}
Returns Producer

Generated using TypeDoc