Class: TelnetServer
lib/telnet.TelnetServer
Table of contents
Constructors
Methods
- getActiveSessions
- getBBSServerInfo
- getConnectionCount
- getServerInfo
- handleWebSocketConnection
- start
- stop
Constructors
constructor
• new TelnetServer(options?)
Parameters
| Name | Type |
|---|---|
options |
TelnetServerOptions |
Defined in
Methods
getActiveSessions
▸ getActiveSessions(): Session[]
Get all active sessions
Returns
Session[]
Defined in
getBBSServerInfo
▸ getBBSServerInfo(): Object
Get server info in BBS API format
Returns
Object
| Name | Type |
|---|---|
host |
string |
port |
number |
sessions |
SessionInfo[] |
uptime |
number |
Defined in
getConnectionCount
▸ getConnectionCount(): number
Get the number of active connections
Returns
number
Defined in
getServerInfo
▸ getServerInfo(): Object
Get server info
Returns
Object
| Name | Type |
|---|---|
connections |
number |
host |
string |
port |
number |
uptime |
number |
Defined in
handleWebSocketConnection
▸ handleWebSocketConnection(ws, remoteAddress?): void
Handle a new WebSocket connection (same BBS session as TCP, different transport). Call this from the HTTP server’s WebSocket upgrade handler so web/desktop clients get a session.
Parameters
| Name | Type |
|---|---|
ws |
WebSocket |
remoteAddress? |
string |
Returns
void
Defined in
start
▸ start(): Promise<void>
Start the Telnet server
Returns
Promise<void>
Defined in
stop
▸ stop(): Promise<void>
Stop the Telnet server
Returns
Promise<void>