ServerShutdown | API Documentation

Hierarchy

ServerShutdown

Index

Modules

Interfaces

Constructors

constructor

Methods

Constructors

constructor

new ServerShutdown(): ServerShutdown

- Defined in server-shutdown.d.ts:7
Creates an instance of ServerShutdown

Returns ServerShutdown

Methods

forceShutdown

forceShutdown(callback?: function): void

- Defined in server-shutdown.d.ts:42
Shutdown all the servers registered with all connections forcefully disconnected.

Parameters
- Optional callback: function
  - - (): void
    - Returns void
Returns void

registerAdapter

registerAdapter(name: string, adapter: IAdapter): void

- Defined in server-shutdown.d.ts:18
Register a server adapter with the system. Name should be a string and adapter is an object that contains a close(server, callback) function that is responsible for closing the server and a socketClose(socket) function that is responsible for destroying the sockets the server creates.

Parameters
- name: string
  
  The unique name of the adapter
- adapter: IAdapter
  
  The adapter instance
Returns void

registerServer

registerServer(server: IServer): void
registerServer(server: IServer, adapterName: string): void

- Defined in server-shutdown.d.ts:24
Registers a http server with the library.

Parameters
- server: IServer
  
  The server instance
Returns void
- Defined in server-shutdown.d.ts:30
Registers a server with the library with an adapter name used to set the type of server being registered.

Parameters
- server: IServer
  
  The server instance
- adapterName: string
Returns void

shutdown

shutdown(callback?: function): void

- Defined in server-shutdown.d.ts:36
Shutdown all the registered servers.

Parameters
- Optional callback: function
  
  The callback called once all connections are disconnected and servers are closed.
  - - (): void
    - Returns void
Returns void

Generated using TypeDoc