Options
All
  • Public
  • Public/Protected
  • All
Menu

TCP Server

api-version

2

user

Hierarchy

  • ITCPServer

Index

Methods

  • broadCast(data: Uint8Array): void
  • close(): void
  • emit(event: string, ...args: any[]): boolean
  • emit message example) emit(event: 'close'): boolean; emit(event: 'connection', socket: Socket): boolean; emit(event: 'error', err: Error): boolean; emit(event: 'listening'): boolean;

    api-version

    2

    user

    Parameters

    • event: string

      event name

    • Rest ...args: any[]

      emit data

    Returns boolean

    Return Fulfills with true if the request has been operated successfully, otherwise false.

  • listen(port: number, listeningListener?: (() => void)): void
  • Start a server listening for connections

    api-version

    2

    user

    Parameters

    • port: number

      port number

    • Optional listeningListener: (() => void)

      listening callback

        • (): void
        • Returns void

    Returns void

  • on(event: string, listener: ((...args: any[]) => void)): void
  • set linstener example) on(event: string, listener: (...args: any[]) => void): this; on(event: 'close', listener: () => void): this; on(event: 'connection', listener: (socket: Socket) => void): this; on(event: 'error', listener: (err: Error) => void): this; on(event: 'listening', listener: () => void): this;

    api-version

    2

    user

    Parameters

    • event: string

      event name

    • listener: ((...args: any[]) => void)

      listening callback

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

  • once(event: string, listener: ((...args: any[]) => void)): void
  • set linstener example) once(event: 'close', listener: () => void): this; once(event: 'connection', listener: (socket: Socket) => void): this; once(event: 'error', listener: (err: Error) => void): this; once(event: 'listening', listener: () => void): this;

    api-version

    2

    user

    Parameters

    • event: string

      event name

    • listener: ((...args: any[]) => void)

      listening callback

        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

Generated using TypeDoc