@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

References

Interfaces

Variables

Functions

References

Metadata

Re-exports Metadata

MetadataKeyword

Re-exports MetadataKeyword

decodeMetadataContent

Re-exports decodeMetadataContent

encodeMetadataContent

Re-exports encodeMetadataContent

isDiscoveryInterest

Re-exports isDiscoveryInterest

makeDiscoveryInterest

Re-exports makeDiscoveryInterest

makeMetadataPacket

Re-exports makeMetadataPacket

retrieveMetadata

Re-exports retrieveMetadata

serveMetadata

Re-exports serveMetadata

Variables

Const MetadataKeyword

MetadataKeyword: Component = Keyword.create("metadata")

32=metadata component.

Const retrieveMetadata

retrieveMetadata: (prefix: NameLike, opts?: Options) => PCancelable<Metadata> = PCancelable.fn(async (prefix: NameLike, arg2: any, arg3: any) => {const [{endpoint = new Endpoint(),retx,verifier,}, onCancel]: [Options, PCancelable.OnCancelFunction] =typeof arg2 === "function" ? [{}, arg2] : [arg2, arg3];const interest = makeDiscoveryInterest(prefix);const consumer = endpoint.consume(interest, {retx,describe: `RDR-c(${prefix})`,});onCancel(() => consumer.cancel());const data = await consumer;if (verifier) {await verifier.verify(data);}return decodeMetadataContent(data.content);})

Retrieve RDR metadata packet.

Type declaration

- (prefix: NameLike, opts?: Options): PCancelable<Metadata>
- Parameters
  - prefix: NameLike
  - Optional opts: Options
  Returns PCancelable<Metadata>

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: { name: Name }): Uint8Array

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

Parameters
- __namedParameters: { name: Name }
  - name: Name
Returns Uint8Array

isDiscoveryInterest

isDiscoveryInterest(__namedParameters: { canBePrefix: boolean; mustBeFresh: boolean; name: Name }): boolean

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

Parameters
- __namedParameters: { canBePrefix: boolean; mustBeFresh: boolean; name: Name }
  - canBePrefix: boolean
  - mustBeFresh: boolean
  - name: Name
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?: { freshnessPeriod: number; prefix: undefined | string | Name; signer: Signer }): Promise<Data>

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

Parameters
- m: Metadata
- Default value __namedParameters: { freshnessPeriod: number; prefix: undefined | string | Name; signer: Signer } = {}
  - freshnessPeriod: number
  - prefix: undefined | string | Name
  - signer: Signer
Returns Promise<Data>

makeName

makeName(payload: Metadata, prefix?: NameLike): Name

- Defined in packages/rdr/src/producer.ts:7
Parameters
- payload: Metadata
- Optional prefix: NameLike
Returns Name

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)
- Default value opts: Options = {}
Returns Producer

Generated using TypeDoc

@ndn/rdr

Index

References

Interfaces

Variables

Functions

References

Metadata

MetadataKeyword

decodeMetadataContent

encodeMetadataContent

isDiscoveryInterest

makeDiscoveryInterest

makeMetadataPacket

retrieveMetadata

serveMetadata

Variables

Const MetadataKeyword

Const retrieveMetadata

Type declaration

Parameters

prefix: NameLike

Optional opts: Options

Returns PCancelable<Metadata>

Functions

decodeMetadataContent

Parameters

wire: Uint8Array

Returns Metadata

encodeMetadataContent

Parameters

__namedParameters: { name: Name }

name: Name

Returns Uint8Array

isDiscoveryInterest

Parameters

__namedParameters: { canBePrefix: boolean; mustBeFresh: boolean; name: Name }

canBePrefix: boolean

mustBeFresh: boolean

name: Name

Returns boolean

makeDiscoveryInterest

Parameters

prefix: NameLike

Returns Interest

makeMetadataPacket

Parameters

m: Metadata

Default value __namedParameters: { freshnessPeriod: number; prefix: undefined | string | Name; signer: Signer } = {}

freshnessPeriod: number

prefix: undefined | string | Name

signer: Signer

Returns Promise<Data>

makeName

Parameters

payload: Metadata

Optional prefix: NameLike

Returns Name

serveMetadata

Parameters

m: Metadata | (() => Metadata)

Default value opts: Options = {}

Returns Producer