Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Server

Telnet server wrapper for a raw TCP server.

Hierarchy

  • EventEmitter
    • Server

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

options

options: OptionMatrix<boolean>

Private server

server: Server

Private sockets

sockets: Map<string, Socket> = new Map()

Map of uuids to telnet sockets.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

close

  • close(cb?: undefined | function): this

  • Close the server, closing all currently connected sockets.

    Parameters

    • Optional cb: undefined | function

      Optinal callback.

    Returns this

emit

  • emit(event: "listening"): boolean
  • emit(event: "error", error: Error): boolean
  • emit(event: "connection", socket: Socket): boolean

  • Parameters

    • event: "listening"

    Returns boolean

  • Parameters

    • event: "error"
    • error: Error

    Returns boolean

  • Parameters

    • event: "connection"
    • socket: Socket

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getSocket

  • getSocket(uuid: string): Socket | undefined

  • Get a telnet socket by UUID.

    Parameters

    • uuid: string

      The uuid of the socket to grab.

    Returns Socket | undefined

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "listening", listener: function): this
  • on(event: "connection", listener: function): this
  • on(event: "error", listener: function): this

  • Parameters

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

        • Returns void

    Returns this

  • Parameters

    • event: "connection"
    • listener: function

        • Parameters

          Returns void

    Returns this

  • Parameters

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

        • Parameters

          • error: Error

          Returns void

    Returns this

once

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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

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

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

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
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc