Class WebServer

HTTP web game server.

PS4 instructions: the specifications of the constructor, port(), start(), and stop() may not be changed.

Hierarchy

WebServer

Index

Constructors

constructor

Accessors

port

Methods

start
stop

Constructors

constructor

new WebServer(board: Board, requestedPort: number): WebServer

Make a new web game server using board that listens for connections on port.

throws

Error if an error occurs starting the server

Parameters
- board: Board
  
  shared game board
- requestedPort: number
Returns WebServer

http.Server object representing the running web server

Accessors

port

get port(): number

Returns number

the actual port that server is listening at. (May be different than the requestedPort used in the constructor, since if requestedPort = 0 then an arbitrary available port is chosen instead.) Requires that start() has already been called and completed.

Methods

start

start(): Promise<void>

Start this server.

Returns Promise<void>

stop

stop(): void

Stop this server. Once stopped, this server cannot be restarted.

Returns void

Generated using TypeDoc