Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Packet

A Packet is a wrapped Method that can be timed-out or canceled whilst it travels over the wire.

Hierarchy

  • EventEmitter
    • Packet

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

cancel

  • cancel(): void

  • Aborts sending the message, if it has not been sent yet.

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

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

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getState

getTimeout

  • getTimeout(defaultTimeout: number): number

  • Returns the packet's timeout duration, or the default if undefined.

    Parameters

    • defaultTimeout: number

    Returns number

id

  • id(): number

  • Returns the randomly-assigned numeric ID of the packet.

    Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

on

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

once

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

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

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setSequenceNumber

  • setSequenceNumber(x: number): this

  • Sets the sequence number on the outgoing packet.

    Parameters

    • x: number

    Returns this

setState

setTimeout

  • setTimeout(duration: number): void

  • Sets the timeout duration on the packet. It defaults to the socket's timeout duration.

    Parameters

    • duration: number

    Returns void

toJSON

Static listenerCount

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

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc