Properties

An instance of the EntryPoint class is provided as an argument to the protocol's required init function.

That instance contains the necessary methods to make Kuzzle aware of user connections, and to pass API requests to Kuzzle.


Properties

Properties Type Description
config
object
Link to the server section of Kuzzle's configuration file. Custom configuration for the protocol can be found at the following path:
entryPoint.config.protocols.<protocol unique name>
httpServer
object
Kuzzle's HTTP server
isShuttingDown
boolean
If true, then this Kuzzle node is shutting down, and it will kill itself once all ongoing requests are finished. This flag should be checked regularly and the network protocol should not accept any new request when it is active