Skip to main content

DefaultServer

The DefaultServer is the main underlying class that's responsible for receiving messages from the networks, constructing the plugin chain for incoming queries, and routing responses back to the client.

Usage​

The DefaultServer's only required parameter is an array of networks (see networks for more information on network interfaces). However, you can also optionally provide a defaultHandler which will be executed if the server reaches the end of the plugin chain and no response has been generated, as well as a custom Router if the default router doesn't suit your needs.

By default, the defaultHandler will respond with an NXDOMAIN response.

new DefaultServer({
    networks,
    defaultHandler: (req, res, next) => {
        res.errors.refused();
    }
});

Multithreaded Support​

DefaultServer also has support for multithreading via Node.js's cluster mode.

To enable multithreading, simply pass in the boolean multithreaded parameter to the constructor of the DefaultServer class.

multithreading.ts
new DefaultServer({
    networks,
    multithreaded: true,
});
warning

Multithreading may not work properly with all plugins. Cluster mode recreates the server in each thread and load balances between them, so each thread will have its own copy of the server and its own local state. As such, workloads that depend on changing record sets should rely on external storage plugins like the Redis store plugin.