@companion-module/base
    Preparing search index...

    Interface SharedUdpSocket

    interface SharedUdpSocket {
        addListener<T extends keyof SharedUdpSocketEvents>(
            event: T,
            fn: (
                ...args: ArgumentMap<SharedUdpSocketEvents>[Extract<
                    T,
                    keyof SharedUdpSocketEvents,
                >],
            ) => void,
            context?: any,
        ): this;
        bind(port: number, address?: string, callback?: () => void): void;
        close(callback?: () => void): void;
        emit<T extends keyof SharedUdpSocketEvents>(
            event: T,
            ...args: ArgumentMap<SharedUdpSocketEvents>[Extract<
                T,
                keyof SharedUdpSocketEvents,
            >],
        ): boolean;
        eventNames(): (keyof SharedUdpSocketEvents)[];
        listenerCount(event: keyof SharedUdpSocketEvents): number;
        listeners<T extends keyof SharedUdpSocketEvents>(
            event: T,
        ): (
            (
                ...args: ArgumentMap<SharedUdpSocketEvents>[Extract<
                    T,
                    keyof SharedUdpSocketEvents,
                >],
            ) => void
        )[];
        off<T extends keyof SharedUdpSocketEvents>(
            event: T,
            fn?: (
                ...args: ArgumentMap<SharedUdpSocketEvents>[Extract<
                    T,
                    keyof SharedUdpSocketEvents,
                >],
            ) => void,
            context?: any,
            once?: boolean,
        ): this;
        on<T extends keyof SharedUdpSocketEvents>(
            event: T,
            fn: (
                ...args: ArgumentMap<SharedUdpSocketEvents>[Extract<
                    T,
                    keyof SharedUdpSocketEvents,
                >],
            ) => void,
            context?: any,
        ): this;
        once<T extends keyof SharedUdpSocketEvents>(
            event: T,
            fn: (
                ...args: ArgumentMap<SharedUdpSocketEvents>[Extract<
                    T,
                    keyof SharedUdpSocketEvents,
                >],
            ) => void,
            context?: any,
        ): this;
        removeAllListeners(event?: keyof SharedUdpSocketEvents): this;
        removeListener<T extends keyof SharedUdpSocketEvents>(
            event: T,
            fn?: (
                ...args: ArgumentMap<SharedUdpSocketEvents>[Extract<
                    T,
                    keyof SharedUdpSocketEvents,
                >],
            ) => void,
            context?: any,
            once?: boolean,
        ): this;
        send(
            bufferOrList:
                | string
                | Buffer<ArrayBufferLike>
                | number[]
                | DataView<ArrayBufferLike>,
            port: number,
            address: string,
            callback?: () => void,
        ): void;
        send(
            buffer: string | Buffer<ArrayBufferLike> | DataView<ArrayBufferLike>,
            offset: number,
            length: number,
            port: number,
            address: string,
            callback?: () => void,
        ): void;
    }

    Hierarchy

    Index

    Methods

    • Bind to the shared socket. Until you call this, the shared socket will be inactive

      Parameters

      • port: number

        Port number to listen on

      • Optionaladdress: string

        (Unused) Local address to listen on

      • Optionalcallback: () => void

        Added to the listening event. Called once the socket is listening

      Returns void

    • Close your reference to the shared socket.

      Parameters

      • Optionalcallback: () => void

        Called once the socket has closed

      Returns void

    • Return an array listing the events for which the emitter has registered listeners.

      Returns (keyof SharedUdpSocketEvents)[]

    • Return the number of listeners listening to a given event.

      Parameters

      Returns number

    • Return the listeners registered for a given event.

      Type Parameters

      Parameters

      • event: T

      Returns (
          (
              ...args: ArgumentMap<SharedUdpSocketEvents>[Extract<
                  T,
                  keyof SharedUdpSocketEvents,
              >],
          ) => void
      )[]

    • Type Parameters

      Parameters

      Returns this

    • Add a one-time listener for a given event.

      Type Parameters

      Parameters

      Returns this

    • Remove all listeners, or those of the specified event.

      Parameters

      • Optionalevent: keyof SharedUdpSocketEvents

      Returns this

    • Remove the listeners of a given event.

      Type Parameters

      Parameters

      Returns this

    • Send a message from the shared socket

      Parameters

      • bufferOrList: string | Buffer<ArrayBufferLike> | number[] | DataView<ArrayBufferLike>

        Data to send

      • port: number

        Target port number

      • address: string

        Target address

      • Optionalcallback: () => void

        Callback to execute once the data has been sent

      Returns void

    • Send a message from the shared socket

      Parameters

      • buffer: string | Buffer<ArrayBufferLike> | DataView<ArrayBufferLike>

        Data to send

      • offset: number

        Offset in the buffer to start sending from

      • length: number

        Length of the data to send. Limited to the length of the bufer

      • port: number

        Target port number

      • address: string

        Target address

      • Optionalcallback: () => void

        Callback to execute once the data has been sent

      Returns void