iniquity

A re-imagining of the iconic BBS software.

View on GitHub

Class: TelnetServer

lib/telnet.TelnetServer

Table of contents

Constructors

Methods

Constructors

constructor

new TelnetServer(options?)

Parameters

Name Type
options TelnetServerOptions

Defined in

iniquity/src/lib/telnet.ts:35

Methods

getActiveSessions

getActiveSessions(): Session[]

Get all active sessions

Returns

Session[]

Defined in

iniquity/src/lib/telnet.ts:53


getBBSServerInfo

getBBSServerInfo(): Object

Get server info in BBS API format

Returns

Object

Name Type
host string
port number
sessions SessionInfo[]
uptime number

Defined in

iniquity/src/lib/telnet.ts:72


getConnectionCount

getConnectionCount(): number

Get the number of active connections

Returns

number

Defined in

iniquity/src/lib/telnet.ts:46


getServerInfo

getServerInfo(): Object

Get server info

Returns

Object

Name Type
connections number
host string
port number
uptime number

Defined in

iniquity/src/lib/telnet.ts:60


start

start(): Promise<void>

Start the Telnet server

Returns

Promise<void>

Defined in

iniquity/src/lib/telnet.ts:99


stop

stop(): Promise<void>

Stop the Telnet server

Returns

Promise<void>

Defined in

iniquity/src/lib/telnet.ts:143