@agentdance/node-webrtc-sctp 1.0.0

package/dist/association.d.ts

@@ -0,0 +1,167 @@
+import { EventEmitter } from 'node:events';
+import type { DataChannelOptions, DataChannelInfo, DataChannelState, SctpState } from './types.js';
+export declare interface SctpDataChannel {
+    on(event: 'open', listener: () => void): this;
+    on(event: 'message', listener: (data: Buffer | string) => void): this;
+    on(event: 'close', listener: () => void): this;
+    on(event: 'error', listener: (err: Error) => void): this;
+    on(event: 'bufferedamountlow', listener: () => void): this;
+}
+export declare class SctpDataChannel extends EventEmitter {
+    readonly id: number;
+    readonly label: string;
+    readonly protocol: string;
+    readonly ordered: boolean;
+    readonly maxPacketLifeTime: number | undefined;
+    readonly maxRetransmits: number | undefined;
+    readonly negotiated: boolean;
+    private _state;
+    private _assoc;
+    private _ssn;
+    private _bufferedAmount;
+    bufferedAmountLowThreshold: number;
+    constructor(assoc: SctpAssociation, info: DataChannelInfo);
+    get state(): DataChannelState;
+    get readyState(): DataChannelState;
+    get bufferedAmount(): number;
+    /** Send a message through this data channel */
+    send(data: Buffer | string): void;
+    /** Bump and return the next outgoing SSN (used by association for ZWP probes) */
+    _nextSsn(): number;
+    close(): void;
+    /** Called by association when a message arrives */
+    _deliver(ppid: number, data: Buffer): void;
+    /** Called by association when this channel is fully open */
+    _open(): void;
+    /** Called by association when channel is forcibly closed */
+    _close(): void;
+    /** Called when bytes are acknowledged (reduce bufferedAmount) */
+    _onAcked(bytes: number, peerRwnd?: number): void;
+}
+export declare interface SctpAssociation {
+    on(event: 'state', listener: (state: SctpState) => void): this;
+    on(event: 'datachannel', listener: (channel: SctpDataChannel) => void): this;
+    on(event: 'error', listener: (err: Error) => void): this;
+}
+export declare class SctpAssociation extends EventEmitter {
+    private _state;
+    private readonly _localPort;
+    private readonly _remotePort;
+    private readonly _role;
+    private _localTag;
+    private _remoteTag;
+    private _localTsn;
+    private _remoteCumulativeTsn;
+    /** Set of TSNs received out-of-order but not yet cumulatively acknowledged */
+    private _receivedTsns;
+    /** Congestion window (bytes) – controls how many bytes can be in-flight */
+    private _cwnd;
+    /** Slow-start threshold */
+    private _ssthresh;
+    /** Bytes currently in-flight (sent but not yet acknowledged) */
+    private _flightSize;
+    /** Partial bytes acked accumulator for congestion avoidance (RFC 4960 §7.2.2) */
+    private _partialBytesAcked;
+    /** Peer's advertised receive window (from SACK a_rwnd field) */
+    private _peerRwnd;
+    /** Smoothed RTT estimate (ms) */
+    private _srtt;
+    /** RTT variance (ms) */
+    private _rttvar;
+    private _sendQueue;
+    private _pumping;
+    /** TSN → PendingChunk for unacknowledged outgoing chunks */
+    private _pendingChunks;
+    private _retransmitTimer;
+    private _rto;
+    /** Zero-window probe back-off delay (ms) – doubles on each probe attempt */
+    private _zwpDelay;
+    /** Count of SACKs received without new data being ACKed (for fast retransmit) */
+    private _dupSackCount;
+    private _lastCumAcked;
+    /** streamId+ssn key → ReassemblyEntry for multi-fragment messages */
+    private _reassembly;
+    _channels: Map<number, SctpDataChannel>;
+    private _nextChannelId;
+    private _streamReceive;
+    private _sendCallback;
+    /** DATA packets received since last SACK was sent. Every 2nd packet → immediate SACK. */
+    private _dataPacketsSinceAck;
+    private _sackTimer;
+    private _connectResolve;
+    private _connectReject;
+    constructor(opts: {
+        localPort: number;
+        remotePort: number;
+        role: 'client' | 'server';
+    });
+    setSendCallback(fn: (buf: Buffer) => void): void;
+    /** True when peer's receive window is closed (peerRwnd=0 due to flutter uint32 wrap or genuine 0) */
+    get peerWindowClosed(): boolean;
+    connect(timeoutMs?: number): Promise<void>;
+    handleIncoming(buf: Buffer): void;
+    createDataChannel(opts: DataChannelOptions): SctpDataChannel;
+    close(): void;
+    get state(): SctpState;
+    /** Expose congestion/flow state for testing */
+    get cwnd(): number;
+    get flightSize(): number;
+    get peerRwnd(): number;
+    get sendQueueLength(): number;
+    _sendData(streamId: number, ssn: number, ppid: number, data: Buffer, ordered: boolean, channel: SctpDataChannel): void;
+    _closeChannel(id: number): void;
+    private _enqueue;
+    /**
+     * Drain the send queue under cwnd / peerRwnd constraints.
+     * Called after enqueue and after each SACK acknowledgement.
+     *
+     * We call _doPump via setImmediate so that incoming SACKs (which arrive as
+     * UDP packets in separate event-loop ticks) can be processed between pump
+     * cycles, keeping the window accurate and preventing stalls.
+     */
+    private _pump;
+    /**
+     * Purge PR-SCTP messages (maxRetransmits=0 or maxPacketLifeTime expired)
+     * from the head of the send queue when the peer window is zero.
+     * Since no TSN has been assigned yet, we simply discard and notify bufferedAmount.
+     *
+     * Returns the number of complete messages dropped.
+     */
+    private _purgeStalePrSctp;
+    private _doPump;
+    private _transmitFragment;
+    private _setState;
+    private _send;
+    private _sendChunks;
+    private _armRetransmitTimer;
+    private _clearRetransmitTimer;
+    private _doRetransmit;
+    private _abandonChunk;
+    /** Process cumulative TSN advancement and gap ACK blocks from SACK */
+    private _processSack;
+    /** Fast retransmit: resend earliest unacked chunk without waiting for RTO */
+    private _doFastRetransmit;
+    /** RFC 6298 RTO update */
+    private _updateRto;
+    private _sendInit;
+    private _handleInit;
+    private _handleInitAck;
+    private _handleCookieEcho;
+    private _handleCookieAck;
+    private _onConnected;
+    private _handleData;
+    private _reassembleAndDeliver;
+    private _deliverToStream;
+    private _scheduleSack;
+    private _sendSack;
+    private _buildGapBlocks;
+    private _sendForwardTsn;
+    private _handleForwardTsn;
+    private _handleDcep;
+    private _handleDcepOpen;
+    private _handleDcepAck;
+    private _sendDcepOpen;
+    private _sendDcepAck;
+    private _handleChunk;
+}
+//# sourceMappingURL=association.d.ts.map

package/dist/association.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"association.d.ts","sourceRoot":"","sources":["../src/association.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAkB3C,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,SAAS,EACV,MAAM,YAAY,CAAC;AAiEpB,MAAM,CAAC,OAAO,WAAW,eAAe;IACtC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAC9C,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,KAAK,IAAI,GAAG,IAAI,CAAC;IACtE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAC/C,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;IACzD,EAAE,CAAC,KAAK,EAAE,mBAAmB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CAC5D;AAED,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,MAAM,CAAkB;IAChC,OAAO,CAAC,IAAI,CAAK;IAGjB,OAAO,CAAC,eAAe,CAAK;IAC5B,0BAA0B,SAAK;gBAEnB,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,eAAe;IAmBzD,IAAI,KAAK,IAAI,gBAAgB,CAE5B;IAED,IAAI,UAAU,IAAI,gBAAgB,CAEjC;IAED,IAAI,cAAc,IAAI,MAAM,CAQ3B;IAED,+CAA+C;IAC/C,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAoBjC,iFAAiF;IACjF,QAAQ,IAAI,MAAM;IAMlB,KAAK,IAAI,IAAI;IAOb,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAS1C,4DAA4D;IAC5D,KAAK,IAAI,IAAI;IAKb,4DAA4D;IAC5D,MAAM,IAAI,IAAI;IAOd,iEAAiE;IACjE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,SAAI,GAAG,IAAI;CAW5C;AAID,MAAM,CAAC,OAAO,WAAW,eAAe;IACtC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,GAAG,IAAI,CAAC;IAC/D,EAAE,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IAC7E,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;CAC1D;AAOD,qBAAa,eAAgB,SAAQ,YAAY;IAC/C,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAG5C,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,UAAU,CAAK;IAGvB,OAAO,CAAC,SAAS,CAAK;IAGtB,OAAO,CAAC,oBAAoB,CAAK;IACjC,8EAA8E;IAC9E,OAAO,CAAC,aAAa,CAAqB;IAG1C,2EAA2E;IAC3E,OAAO,CAAC,KAAK,CAAgB;IAC7B,2BAA2B;IAC3B,OAAO,CAAC,SAAS,CAAoB;IACrC,gEAAgE;IAChE,OAAO,CAAC,WAAW,CAAK;IACxB,iFAAiF;IACjF,OAAO,CAAC,kBAAkB,CAAK;IAC/B,gEAAgE;IAChE,OAAO,CAAC,SAAS,CAAc;IAC/B,iCAAiC;IACjC,OAAO,CAAC,KAAK,CAAqB;IAClC,wBAAwB;IACxB,OAAO,CAAC,OAAO,CAAqB;IAGpC,OAAO,CAAC,UAAU,CAAwB;IAC1C,OAAO,CAAC,QAAQ,CAAS;IAGzB,4DAA4D;IAC5D,OAAO,CAAC,cAAc,CAAmC;IACzD,OAAO,CAAC,gBAAgB,CAA6B;IACrD,OAAO,CAAC,IAAI,CAAkB;IAC9B,4EAA4E;IAC5E,OAAO,CAAC,SAAS,CAAO;IACxB,iFAAiF;IACjF,OAAO,CAAC,aAAa,CAAK;IAC1B,OAAO,CAAC,aAAa,CAAK;IAG1B,qEAAqE;IACrE,OAAO,CAAC,WAAW,CAAsC;IAGzD,SAAS,+BAAsC;IAC/C,OAAO,CAAC,cAAc,CAAS;IAG/B,OAAO,CAAC,cAAc,CAAyC;IAG/D,OAAO,CAAC,aAAa,CAAsC;IAG3D,yFAAyF;IACzF,OAAO,CAAC,oBAAoB,CAAK;IAGjC,OAAO,CAAC,UAAU,CAA6B;IAG/C,OAAO,CAAC,eAAe,CAA2B;IAClD,OAAO,CAAC,cAAc,CAAqC;gBAE/C,IAAI,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAA;KAAE;IAatF,eAAe,CAAC,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAIhD,qGAAqG;IACrG,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAEK,OAAO,CAAC,SAAS,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BhD,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAqBjC,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,GAAG,eAAe;IAuC5D,KAAK,IAAI,IAAI;IAgBb,IAAI,KAAK,IAAI,SAAS,CAAwB;IAE9C,+CAA+C;IAC/C,IAAI,IAAI,IAAI,MAAM,CAAuB;IACzC,IAAI,UAAU,IAAI,MAAM,CAA6B;IACrD,IAAI,QAAQ,IAAI,MAAM,CAA2B;IACjD,IAAI,eAAe,IAAI,MAAM,CAAmC;IAIhE,SAAS,CACP,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,eAAe,GACvB,IAAI;IAqCP,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAU/B,OAAO,CAAC,QAAQ;IAIhB;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK;IAYb;;;;;;OAMG;IACH,OAAO,CAAC,iBAAiB;IAoCzB,OAAO,CAAC,OAAO;IAmFf,OAAO,CAAC,iBAAiB;IAoCzB,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,WAAW;IA4CnB,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,qBAAqB;IAO7B,OAAO,CAAC,aAAa;IAyHrB,OAAO,CAAC,aAAa;IAcrB,sEAAsE;IACtE,OAAO,CAAC,YAAY;IAqJpB,6EAA6E;IAC7E,OAAO,CAAC,iBAAiB;IAsBzB,0BAA0B;IAC1B,OAAO,CAAC,UAAU;IAalB,OAAO,CAAC,SAAS;IAejB,OAAO,CAAC,WAAW;IAoCnB,OAAO,CAAC,cAAc;IAwBtB,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,YAAY;IAUpB,OAAO,CAAC,WAAW;IA8BnB,OAAO,CAAC,qBAAqB;IAmD7B,OAAO,CAAC,gBAAgB;IAgExB,OAAO,CAAC,aAAa;IA2BrB,OAAO,CAAC,SAAS;IAsBjB,OAAO,CAAC,eAAe;IA8BvB,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,eAAe;IA0BvB,OAAO,CAAC,cAAc;IAMtB,OAAO,CAAC,aAAa;IAyCrB,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,YAAY;CA2DrB"}