Skip to main content

InMemoryTransport

@totemsdk/stream-transport

@totemsdk/stream-transport / InMemoryTransport

Class: InMemoryTransport

In-process bidirectional transport for use in unit tests and the contract suite. Call createInMemoryPair() to get two linked instances.

Extra test-helper methods: _deliver(event, ...args) — fire event handlers on this side only _deliverClose() — fire 'close' on this side's handlers only simulateRemoteClose() — fire 'close' on BOTH sides (asynchronous) _simulateServerClose() — alias for simulateRemoteClose() _linkPeer(other) — link two transports together

Implements​

Constructors​

Constructor​

new InMemoryTransport(): InMemoryTransport

Returns​

InMemoryTransport

Accessors​

state​

Get Signature​

get state(): TransportState

Explicit connection state.

Returns​

TransportState

Explicit connection state.

Implementation of​

IStreamTransport.state

Methods​

_deliver()​

_deliver(event, ...args): void

Fire event handlers on THIS side only.

Parameters​

event​

string

args​

...unknown[]

Returns​

void

_deliverClose()​

_deliverClose(): void

Fire 'close' on this side's handlers only (for reconnect testing).

Returns​

void

_linkPeer()​

_linkPeer(other): void

Parameters​

other​

InMemoryTransport

Returns​

void

_simulateServerClose()​

_simulateServerClose(): void

Alias for simulateRemoteClose().

Returns​

void

close()​

close(): Promise<void>

Close the transport. After the returned promise resolves, no further data or close deliveries occur. Calling close() more than once is safe (the second call resolves immediately).

Returns​

Promise<void>

Implementation of​

IStreamTransport.close

onClose()​

onClose(handler): () => void

Subscribe to connection close. Returns an unsubscribe function.

Parameters​

handler​

CloseHandler

Returns​

() => void

Implementation of​

IStreamTransport.onClose

onData()​

onData(handler): () => void

Subscribe to data chunks. Returns an unsubscribe function.

Parameters​

handler​

DataHandler

Returns​

() => void

Implementation of​

IStreamTransport.onData

onError()​

onError(handler): () => void

Subscribe to transport errors. Returns an unsubscribe function.

Parameters​

handler​

ErrorHandler

Returns​

() => void

Implementation of​

IStreamTransport.onError

send()​

send(data): Promise<void>

Send bytes to the remote peer.

  • Returns a promise that resolves once the bytes are accepted by the underlying transport (or after the documented backpressure policy).
  • Rejects with ClosedTransportError if the transport is closed.
  • Rejects with the underlying error if delivery fails.

Parameters​

data​

Uint8Array

Returns​

Promise<void>

Implementation of​

IStreamTransport.send

simulateRemoteClose()​

simulateRemoteClose(): void

Fire 'close' on BOTH sides asynchronously. Use when simulating a remote side terminating the connection.

Returns​

void