Socket | typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Socket

Hierarchy

Index

Properties

Methods

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string, listener: Function): this
  • addListener(event: "close", listener: function): this
  • addListener(event: "error", listener: function): this
  • addListener(event: "listening", listener: function): this
  • addListener(event: "message", listener: function): this

  • events.EventEmitter

    1. close
    2. error
    3. listening
    4. message

    Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    Returns this

addMembership

  • addMembership(multicastAddress: string, multicastInterface?: string): void

  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

address

  • Returns AddressInfo

bind

  • bind(port?: number, address?: string, callback?: function): void
  • bind(options: BindOptions, callback?: Function): void

  • Parameters

    • Optional port: number
    • Optional address: string
    • Optional callback: function
        • (): void

        • Returns void

    Returns void

  • Parameters

    Returns void

close

  • close(callback?: any): void

  • Parameters

    • Optional callback: any

    Returns void

dropMembership

  • dropMembership(multicastAddress: string, multicastInterface?: string): void

  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close"): boolean
  • emit(event: "error", err: Error): boolean
  • emit(event: "listening"): boolean
  • emit(event: "message", msg: Buffer, rinfo: AddressInfo): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "error"
    • err: Error

    Returns boolean

  • Parameters

    • event: "listening"

    Returns boolean

  • Parameters

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string, listener: Function): this
  • on(event: "close", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: "listening", listener: function): this
  • on(event: "message", listener: function): this

  • Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    Returns this

once

  • once(event: string, listener: Function): this
  • once(event: "close", listener: function): this
  • once(event: "error", listener: function): this
  • once(event: "listening", listener: function): this
  • once(event: "message", listener: function): this

  • Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    Returns this

prependListener

  • prependListener(event: string, listener: Function): this
  • prependListener(event: "close", listener: function): this
  • prependListener(event: "error", listener: function): this
  • prependListener(event: "listening", listener: function): this
  • prependListener(event: "message", listener: function): this

  • Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    Returns this

prependOnceListener

  • prependOnceListener(event: string, listener: Function): this
  • prependOnceListener(event: "close", listener: function): this
  • prependOnceListener(event: "error", listener: function): this
  • prependOnceListener(event: "listening", listener: function): this
  • prependOnceListener(event: "message", listener: function): this

  • Parameters

    • event: string
    • listener: Function

    Returns this

  • Parameters

    • event: "close"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    • event: "listening"
    • listener: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    Returns this

ref

  • ref(): this

  • Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: Function): this

send

  • send(msg: Buffer | String | any[], port: number, address: string, callback?: function): void
  • send(msg: Buffer | String | any[], offset: number, length: number, port: number, address: string, callback?: function): void

  • Parameters

    • msg: Buffer | String | any[]
    • port: number
    • address: string
    • Optional callback: function
        • (error: Error, bytes: number): void

        • Parameters

          • error: Error
          • bytes: number

          Returns void

    Returns void

  • Parameters

    • msg: Buffer | String | any[]
    • offset: number
    • length: number
    • port: number
    • address: string
    • Optional callback: function
        • (error: Error, bytes: number): void

        • Parameters

          • error: Error
          • bytes: number

          Returns void

    Returns void

setBroadcast

  • setBroadcast(flag: boolean): void

  • Parameters

    • flag: boolean

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

setMulticastLoopback

  • setMulticastLoopback(flag: boolean): void

  • Parameters

    • flag: boolean

    Returns void

setMulticastTTL

  • setMulticastTTL(ttl: number): void

  • Parameters

    • ttl: number

    Returns void

setTTL

  • setTTL(ttl: number): void

  • Parameters

    • ttl: number

    Returns void

unref

  • unref(): this

  • Returns this

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc