Class TCPServer

Handles tcp tunnels and maintains a list of connections

Hierarchy

TCPServer

Index

Constructors

Properties

connections server

Methods

getConnectedIds getTunnelFromId handleConnection

Constructors

constructor

new TCPServer(connections?: {
[id: string]: BotTunnel;
}): TCPServer
creates a tcp server on port from server config and registers passed in ids with their corresponding bot tunnels

when a robot connects, bind it to the server
Parameters
- connections: {
  [id: string]: BotTunnel;
  } = {}
  
  bot connections in a id:BotTunnel array
  - [id: string]: BotTunnel
Returns TCPServer
- Defined in src/server/api/tcp-interface.ts:268

Properties

`Private` connections

connections: {
[id: string]: BotTunnel;
} = {}

bot connections in a id:BotTunnel array

Type declaration

[id: string]: BotTunnel

`Private` server

server: Server

Methods

getConnectedIds

getConnectedIds(): string[]
get a list of connected ids

Returns
- list of id keys
Returns string[]
- Defined in src/server/api/tcp-interface.ts:335

getTunnelFromId

getTunnelFromId(id: string): BotTunnel
get the robot tunnel based on the robot id string

Returns
- tcp tunnel
Parameters
- id: string
  
  id string
Returns BotTunnel
- Defined in src/server/api/tcp-interface.ts:327

`Private` handleConnection

handleConnection(socket: Socket): void
When a robot connects, add the tunnel to the robot connections at its id

assign a random id to new robots
Parameters
- socket: Socket
  
  the incoming connection socket information
Returns void
- Defined in src/server/api/tcp-interface.ts:286

Generated using TypeDoc