Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Rcon

Hierarchy

  • EventEmitter
    • Rcon

Index

Interfaces

Type aliases

Constructors

Properties

Methods

Type aliases

Static Argument

Argument: boolean | string | number | undefined

Static Pending

Pending: Request<any>[]

Static Queued

Queued: Request<any>[]

Static eventHandler

eventHandler: (event: string, words: Word[]) => void

Type declaration

    • (event: string, words: Word[]): void

    • Parameters

      • event: string
      • words: Word[]

      Returns void

Constructors

constructor

Properties

Private buffer

buffer: Buffer = Buffer.alloc(0)

Private options

options: ConnectionOptions

Private pending

pending: Pending = []

Private queued

queued: Queued = []

Private Optional sequence

sequence: Sequence

Private socket

socket: Socket

Private waitForPriorized

waitForPriorized: boolean = true

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

connect

  • connect(forceReconnect?: boolean): Promise<void>

  • connects to the socket

    Parameters

    • Default value forceReconnect: boolean = true

      if its connected the current connection will be destroyed

    Returns Promise<void>

continueWithQueue

  • continueWithQueue(): void

createCommand

emit

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

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

Private getNextSequence

Private handleEvent

  • handleEvent(packet: Packet): void

Private handlePacket

  • handlePacket(buffer: Buffer): false | true | void

Private handleTimeout

  • handleTimeout(__namedParameters: { request: Request<any>; timeout: number }): void

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private onClose

  • onClose(): void

  • push all pending sequences back to queued after a successfull reconnect all queued packets get resent

    Returns void

Private onData

  • onData(buffer: Buffer): void

Private onError

  • onError(err: Error): void

once

  • once(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...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: (...args: any[]) => void): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

Private sendRequest

  • sendRequest(request: Request): Promise<void>

  • sends a request, either writes it to the socket or pushes it to queue if its currently not writeable

    Parameters

    Returns Promise<void>

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setWaitForPriorized

  • setWaitForPriorized(to: boolean): this

stop

  • stop(): void

Private wrapInPacket

  • wrapInPacket(words: string[]): Packet

write

  • write(buffer: Buffer): Promise<void>

Static listenerCount

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

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static toStrings

Generated using TypeDoc