Class BulkInsertInitiator

Send packets to a bulk insertion target.

Hierarchy

TypedEventTarget<EventMap>
- BulkInsertInitiator

Implements

DataStore.Insert
AsyncDisposable

Index

Constructors

Methods

[asyncDispose] insert

Constructors

constructor

new BulkInsertInitiator(tr: Pick<Transport, "tx">): BulkInsertInitiator
Constructor.
Parameters
- tr: Pick<Transport, "tx">
  Transport connected to bulk insertion target. Typically, this is a subclass of @ndn/l3face!Transport. The RX side is opened and any received packets are discarded. The outgoing Data packet stream is passed to TX side. If the transport has a finite MTU, any Data packets exceeding MTU are silently dropped.
  
  You can connect to repo-ng or ndn-python-repo by creating a TCP transport with @ndn/node-transport!TcpTransport.connect. However, it is recommended to use @ndn/pyrepo!PyRepoClient for inserting Data into ndn-python-repo.
Returns BulkInsertInitiator
Overrides TypedEventTarget<EventMap>.constructor
- Defined in bulk-insert-initiator.ts:35

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Finish insertion and close the connection to the target.

Returns Promise<void>
Remarks
.insert() cannot be called after this.
Implementation of AsyncDisposable.[asyncDispose]
- Defined in bulk-insert-initiator.ts:59

insert

insert(
    ...args:
        | (Data | AnyIterable<Data>)[]
        | [{}, ...(Data | AnyIterable<Data>)[]],
): Promise<void>
Send packets to the target.
Parameters
- ...args: (Data | AnyIterable<Data>)[] | [{}, ...(Data | AnyIterable<Data>)[]]
Returns Promise<void>
Promise that resolves when the packets are scheduled for transmission. It does not imply the target has received or accepted these packets.
Implementation of Insert.insert
- Defined in bulk-insert-initiator.ts:69