@webvpn/dgram 0.0.1

package/build/index.d.ts

@@ -0,0 +1,184 @@
+import { BindOptions, Socket as DgramSocket, RemoteInfo, SocketOptions, SocketType } from 'dgram';
+import { AddressInfo } from 'net';
+import { EventEmitter } from 'events';
+
+export type WebVPNHandshakePacket = {
+    type: 'udp-socket';
+    socketType: 'udp4' | 'udp6';
+    reuseAddr?: boolean;
+    ipv6Only?: boolean;
+    recvBufferSize?: number;
+    sendBufferSize?: number;
+};
+export type SocketClientPacket = {
+    type: 'addMembership';
+    multicastAddress: string;
+    multicastInterface?: string;
+} | {
+    type: 'addSourceSpecificMembership';
+    sourceAddress: string;
+    groupAddress: string;
+    multicastInterface?: string;
+} | {
+    type: 'bind';
+    uuid?: string;
+    port?: number;
+    address?: string;
+    exclusive?: boolean;
+} | {
+    type: 'close';
+    uuid?: string;
+} | {
+    type: 'connect';
+    uuid?: string;
+    port: number;
+    address?: string;
+} | {
+    type: 'disconnect';
+} | {
+    type: 'dropMembership';
+    multicastAddress: string;
+    multicastInterface?: string;
+} | {
+    type: 'dropSourceSpecificMembership';
+    sourceAddress: string;
+    groupAddress: string;
+    multicastInterface?: string;
+} | {
+    type: 'send';
+    msg: string | readonly any[] | Uint8Array;
+    offset?: number;
+    length?: number;
+    port?: number;
+    address?: string;
+} | {
+    type: 'setBroadcast';
+    flag: boolean;
+} | {
+    type: 'setMulticastInterface';
+    multicastInterface: string;
+} | {
+    type: 'setMulticastLoopback';
+    flag: boolean;
+} | {
+    type: 'setMulticastTTL';
+    ttl: number;
+} | {
+    type: 'setRecvBufferSize';
+    size: number;
+} | {
+    type: 'setSendBufferSize';
+    size: number;
+} | {
+    type: 'setTTL';
+    ttl: number;
+};
+export type SocketServerPacket = {
+    type: 'event-close';
+} | {
+    type: 'event-connect';
+} | {
+    type: 'event-error';
+    exception: string;
+} | {
+    type: 'event-listening';
+    address: {
+        address: string;
+        port: number;
+        family: 'IPv4' | 'IPv6';
+    };
+} | {
+    type: 'event-message';
+    message: Uint8Array;
+    rinfo: {
+        address: string;
+        family: 'IPv4' | 'IPv6';
+        port: number;
+        size: number;
+    };
+} | {
+    type: 'callback-bind';
+    uuid: string;
+    address: {
+        address: string;
+        port: number;
+        family: 'IPv4' | 'IPv6';
+    };
+} | {
+    type: 'callback-close';
+    uuid: string;
+} | {
+    type: 'callback-connect';
+    uuid: string;
+    remoteAddress: {
+        address: string;
+        port: number;
+        family: 'IPv4' | 'IPv6';
+    };
+} | {
+    type: 'callback-send';
+    uuid: string;
+};
+interface EventEmitterOptions {
+    /**
+     * Enables automatic capturing of promise rejection.
+     */
+    captureRejections?: boolean | undefined;
+}
+export declare class Socket extends EventEmitter implements DgramSocket {
+    _webVPN: Promise<{
+        webtransport: WebTransport;
+        reader: ReadableStreamDefaultReader<Uint8Array>;
+        writer: WritableStreamDefaultWriter<Uint8Array>;
+        datagramReader: ReadableStreamDefaultReader<Uint8Array>;
+        datagramWriter: WritableStreamDefaultWriter<Uint8Array>;
+    }>;
+    _type: 'udp4' | 'udp6';
+    _address: {
+        address: string;
+        port: number;
+        family: string;
+    } | undefined;
+    _remoteAddress: {
+        address: string;
+        port: number;
+        family: string;
+    } | undefined;
+    constructor(options: SocketOptions & EventEmitterOptions);
+    addMembership(multicastAddress: string, multicastInterface?: string | undefined): void;
+    address(): AddressInfo;
+    bind(port?: number | undefined, address?: string | undefined, callback?: (() => void) | undefined): this;
+    bind(port?: number | undefined, callback?: (() => void) | undefined): this;
+    bind(callback?: (() => void) | undefined): this;
+    bind(options: BindOptions, callback?: (() => void) | undefined): this;
+    close(callback?: (() => void) | undefined): this;
+    connect(port: number, address?: string, callback?: () => void): void;
+    connect(port: number, callback: () => void): void;
+    disconnect(): void;
+    dropMembership(multicastAddress: string, multicastInterface?: string | undefined): void;
+    getRecvBufferSize(): number;
+    getSendBufferSize(): number;
+    getSendQueueSize(): number;
+    getSendQueueCount(): number;
+    ref(): this;
+    remoteAddress(): AddressInfo;
+    send(msg: string | readonly any[] | Uint8Array, port?: number | undefined, address?: string | undefined, callback?: ((error: Error | null, bytes: number) => void) | undefined): void;
+    send(msg: string | readonly any[] | Uint8Array, port?: number | undefined, callback?: ((error: Error | null, bytes: number) => void) | undefined): void;
+    send(msg: string | readonly any[] | Uint8Array, callback?: ((error: Error | null, bytes: number) => void) | undefined): void;
+    send(msg: string | Uint8Array, offset: number, length: number, port?: number | undefined, address?: string | undefined, callback?: ((error: Error | null, bytes: number) => void) | undefined): void;
+    send(msg: string | Uint8Array, offset: number, length: number, port?: number | undefined, callback?: ((error: Error | null, bytes: number) => void) | undefined): void;
+    send(msg: string | Uint8Array, offset: number, length: number, callback?: ((error: Error | null, bytes: number) => void) | undefined): void;
+    send(msg: unknown, offset?: unknown, length?: unknown, port?: unknown, address?: unknown, callback?: unknown): void;
+    setBroadcast(flag: boolean): void;
+    setMulticastInterface(multicastInterface: string): void;
+    setMulticastLoopback(flag: boolean): boolean;
+    setMulticastTTL(ttl: number): number;
+    setRecvBufferSize(size: number): void;
+    setSendBufferSize(size: number): void;
+    setTTL(ttl: number): number;
+    unref(): this;
+    addSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string | undefined): void;
+    dropSourceSpecificMembership(sourceAddress: string, groupAddress: string, multicastInterface?: string | undefined): void;
+}
+export declare const createSocket: (options: SocketType | SocketOptions, callback?: (msg: Buffer, rinfo: RemoteInfo) => void) => Socket;
+export {};