Class RCONClient

RCONClient Class

See

https://wiki.vg/RCON for more information

Hierarchy

TypedEventEmitter<RCONClientEvents, this>
- RCONClient

Constructors

constructor

new RCONClient(host: string, password: string, port?: number): RCONClient

Instantiate a new RCONClient instance
Parameters
- host: string
  
  Host for this RCONClient
- password: string
  
  Password used to login
- port: number = 25575
  
  Port to use, defaults to 25575
Returns RCONClient

Overrides (EventEmitter as new () => TypedEmitter<RCONClientEvents>).constructor

Properties

`Private` authRequestId

authRequestId: number

Request ID of the login packet

authenticated

authenticated: boolean

Whether or not this client has been authenticated

connected

connected: boolean

Whether or not this client is connected

`Private` handler

handler: RCONPacketHandler

Packet handler

host

host: string

Host this client is linked to

`Private` password

password: string

Password used to login

port

port: number

Port this client is linked to

`Private` socket

socket: Socket

TCP socket

Methods

addListener

addListener<E>(event: E, listener: RCONClientEvents[E]): RCONClient

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
- listener: RCONClientEvents[E]
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).addListener

connect

connect(): RCONClient

Connect to the Minecraft server

Returns
The RCONClient

Returns RCONClient

disconnect

disconnect(): void

Disconnect the client and end the connection

Returns void

emit

emit<E>(event: E, ...args: Parameters<RCONClientEvents[E]>): boolean

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
- Rest ...args: Parameters<RCONClientEvents[E]>
Returns boolean

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).emit

eventNames

eventNames(): (string | symbol)[]

Returns (string | symbol)[]

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).eventNames

executeCommand

executeCommand(command: string): number

Execute a command on the server

This method isn't deprecated but it's way better to use RCONClient#executeCommandAsync because it handles fragmentation unlike this one

Returns
The request ID (use it to catch the response)
Parameters
- command: string
  
  Command to execute on the server
Returns number

executeCommandAsync

executeCommandAsync(command: string, timeout?: number): Promise<string>

Execute a command and asynchronously get its output

This method handles everything (including fragmentation) so you don't have to worry about it.

Returns
A promise that resolves with the command's output
Parameters
- command: string
  
  Command to execute
- Optional timeout: number
  
  Timeout before the promise is rejected (prevents promise from indefinitely being on pending if something fails), in milliseconds
Returns Promise<string>

getMaxListeners

getMaxListeners(): number

Returns number

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).getMaxListeners

`Private` handleMessage

handleMessage(buffer: Buffer): void

Handle incoming messages
Parameters
- buffer: Buffer
Returns void

listenerCount

listenerCount<E>(event: E): number

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
Returns number

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).listenerCount

listeners

listeners<E>(event: E): RCONClientEvents[E][]

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
Returns RCONClientEvents[E][]

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).listeners

off

off<E>(event: E, listener: RCONClientEvents[E]): RCONClient

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
- listener: RCONClientEvents[E]
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).off

on

on<E>(event: E, listener: RCONClientEvents[E]): RCONClient

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
- listener: RCONClientEvents[E]
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).on

once

once<E>(event: E, listener: RCONClientEvents[E]): RCONClient

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
- listener: RCONClientEvents[E]
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).once

prependListener

prependListener<E>(event: E, listener: RCONClientEvents[E]): RCONClient

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
- listener: RCONClientEvents[E]
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).prependListener

prependOnceListener

prependOnceListener<E>(event: E, listener: RCONClientEvents[E]): RCONClient

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
- listener: RCONClientEvents[E]
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).prependOnceListener

rawListeners

rawListeners<E>(event: E): RCONClientEvents[E][]

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
Returns RCONClientEvents[E][]

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).rawListeners

removeAllListeners

removeAllListeners<E>(event?: E): RCONClient

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- Optional event: E
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).removeAllListeners

removeListener

removeListener<E>(event: E, listener: RCONClientEvents[E]): RCONClient

Type Parameters
- E extends keyof RCONClientEvents
Parameters
- event: E
- listener: RCONClientEvents[E]
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).removeListener

setMaxListeners

setMaxListeners(maxListeners: number): RCONClient

Parameters
- maxListeners: number
Returns RCONClient

Inherited from (EventEmitter as new () => TypedEmitter<RCONClientEvents>).setMaxListeners

`Private` throw

throw(error: Error, isRCON?: boolean): void

Throw an error
Parameters
- error: Error
  
  Error to throw
- Optional isRCON: boolean
  
  Whether or not this error comes from RCON
Returns void

`Private` write

write(buffer: Buffer): void

Write a message to the server
Parameters
- buffer: Buffer
  
  Message to send
Returns void

Generated using TypeDoc