Options
All
  • Public
  • Public/Protected
  • All
Menu

TCP Client

api-version

2

user

Hierarchy

  • ITCPClient

Index

Methods

  • connect(port: number, host: string, connectionListener?: (() => void)): void
  • Conncet to server

    api-version

    2

    user

    Parameters

    • port: number

      port number

    • host: string

      host ip address

    • Optional connectionListener: (() => void)

      listener callback

        • (): void
        • Returns void

    Returns void

  • emit(event: string, ...arg: any[]): boolean
  • emit message example) emit(event: 'close', hadError: boolean): boolean; emit(event: 'connect'): boolean; emit(event: 'data', data: Uint8Array): boolean; emit(event: 'drain'): boolean; emit(event: 'end'): boolean; emit(event: 'error', err: Error): boolean; emit(event: 'lookup', err: Error, address: string, family: string | number, host: string): boolean; emit(event: 'ready'): boolean; emit(event: 'timeout'): boolean;

    api-version

    2

    user

    Parameters

    • event: string

      event name

    • Rest ...arg: any[]

    Returns boolean

  • end(): void
  • on(event: string, listener: ((...args: any[]) => void)): void
  • set linstener example) on(event: string, listener: (...args: any[]) => void): this; on(event: 'close', listener: (hadError: boolean) => void): this; on(event: 'connect', listener: () => void): this; on(event: 'data', listener: (data: Uint8Array) => void): this; on(event: 'drain', listener: () => void): this; on(event: 'end', listener: () => void): this; on(event: 'error', listener: (err: Error) => void): this; on(event: 'lookup', listener: (err: Error, address: string, family: string | number, host: string) => void): this; on(event: 'ready', listener: () => void): this; on(event: 'timeout', 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: string, listener: (...args: any[]) => void): this; once(event: 'close', listener: (hadError: boolean) => void): this; once(event: 'connect', listener: () => void): this; once(event: 'data', listener: (data: Uint8Array) => void): this; once(event: 'drain', listener: () => void): this; once(event: 'end', listener: () => void): this; once(event: 'error', listener: (err: Error) => void): this; once(event: 'lookup', listener: (err: Error, address: string, family: string | number, host: string) => void): this; once(event: 'ready', listener: () => void): this; once(event: 'timeout', 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

  • write(data: Uint8Array): void

Generated using TypeDoc