Add JS docs for server stop

This commit is contained in:
advplyr 2023-12-28 16:32:21 -06:00
parent 21d0d43edc
commit 9a634e0de5
2 changed files with 11 additions and 2 deletions

View File

@ -284,7 +284,7 @@ class Server {
await this.stop() await this.stop()
Logger.info('Server stopped. Exiting.') Logger.info('Server stopped. Exiting.')
} else { } else {
Logger.info('SIGINT (Ctrl+C) received again. Exiting immediately.') Logger.info('SIGINT (Ctrl+C) received again. Exiting immediately.')
} }
process.exit(0) process.exit(0)
}) })
@ -395,6 +395,10 @@ class Server {
res.sendStatus(200) res.sendStatus(200)
} }
/**
* Gracefully stop server
* Stops watcher and socket server
*/
async stop() { async stop() {
Logger.info('=== Stopping Server ===') Logger.info('=== Stopping Server ===')
await this.watcher.close() await this.watcher.close()

View File

@ -73,10 +73,15 @@ class SocketAuthority {
} }
} }
/**
* Closes the Socket.IO server and disconnect all clients
*
* @param {Function} callback
*/
close(callback) { close(callback) {
Logger.info('[SocketAuthority] Shutting down') Logger.info('[SocketAuthority] Shutting down')
// This will close all open socket connections, and also close the underlying http server // This will close all open socket connections, and also close the underlying http server
if (this.io) if (this.io)
this.io.close(callback) this.io.close(callback)
else else
callback() callback()