@nanoforge-dev/network-client

Classes

NetworkClientLibrary

Extends

Component

Constructors

Constructor

new NetworkClientLibrary(): NetworkClientLibrary;

Returns

NetworkClientLibrary

Inherited from

BaseNetworkLibrary.constructor

Properties

tcp

tcp: TCPClient;

Defined in: client.network.library.ts:12

udp

udp: UDPClient;

Defined in: client.network.library.ts:9

Accessors

__name

Get Signature

get __name(): string;

Defined in: client.network.library.ts:14

Returns

string

Methods

__init()

__init(context): Promise<void>;

Defined in: client.network.library.ts:18

Parameters

context

InitContext

Returns

Promise<void>

Interfaces

TCPClient

Defined in: tcp.client.network.ts:6

TCPClient Reliable ordered send/receive of packets to a TCP server

Methods

connect()

connect(): Promise<void>;

Defined in: tcp.client.network.ts:25

Initiate a WebSocket connection to the server (e.g. ws://<ip>:<port>).

Returns

Promise<void>

Promise

getReceivedPackets()

getReceivedPackets(): Uint8Array<ArrayBufferLike>[];

Defined in: tcp.client.network.ts:57

Return an array of complete packets that were reassembled from received chunks.

Returns

Uint8Array<ArrayBufferLike>[]

Uint8Array[] — array of packet buffers.

isConnected()

isConnected(): boolean;

Defined in: tcp.client.network.ts:34

Return true when the underlying WebSocket is open.

Returns

boolean

boolean

sendData()

sendData(data): void;

Defined in: tcp.client.network.ts:44

Send a payload to the server.

Parameters

data

Uint8Array

Uint8Array — raw payload bytes.

Returns

void

void

UDPClient

Defined in: udp.client.network.ts:6

UDPClient Fast but less reliable send/receive of packets to a UDP server

Methods

connect()

connect(): Promise<void>;

Defined in: udp.client.network.ts:25

Open a WebSocket for signaling, create an RTCPeerConnection and initiate an SDP offer.

Returns

Promise<void>

Promise

getReceivedPackets()

getReceivedPackets(): Uint8Array<ArrayBufferLike>[];

Defined in: udp.client.network.ts:60

Return an array of complete packets reassembled from received data-channel chunks.

Returns

Uint8Array<ArrayBufferLike>[]

Uint8Array[] — array of packet buffers.

isConnected()

isConnected(): boolean;

Defined in: udp.client.network.ts:37

Return true when the RTCDataChannel is open.

Returns

boolean

boolean

sendData()

sendData(data): void;

Defined in: udp.client.network.ts:47

Send a payload on the data channel.

Parameters

data

Uint8Array

Uint8Array — raw payload bytes.

Returns

void

void