Struct ServerFuture

pub struct ServerFuture<T: RequestHandler> { /* private fields */ }

A Futures based implementation of a DNS server

Implementations

impl<T: RequestHandler> ServerFuture<T>

pub fn new(handler: T) -> Self

Creates a new ServerFuture with the specified Handler.

pub fn with_access( handler: T, denied_networks: &[IpNet], allowed_networks: &[IpNet], ) -> Self

Creates a new ServerFuture with the specified Handler and Access

pub fn register_socket(&mut self, socket: UdpSocket)

Register a UDP socket. Should be bound before calling this function.

pub fn register_socket_std(&mut self, socket: UdpSocket) -> Result<()>

Register a UDP socket. Should be bound before calling this function.

pub fn register_listener(&mut self, listener: TcpListener, timeout: Duration)

Register a TcpListener to the Server. This should already be bound to either an IPv6 or an IPv4 address.

To make the server more resilient to DOS issues, there is a timeout. Care should be taken to not make this too low depending on use cases.

Arguments

• listener - a bound TCP socket
• timeout - timeout duration of incoming requests, any connection that does not send requests within this time period will be closed. In the future it should be possible to create long-lived queries, but these should be from trusted sources only, this would require some type of whitelisting.

pub fn register_listener_std( &mut self, listener: TcpListener, timeout: Duration, ) -> Result<()>

Register a TcpListener to the Server. This should already be bound to either an IPv6 or an IPv4 address.

To make the server more resilient to DOS issues, there is a timeout. Care should be taken to not make this too low depending on use cases.

Arguments

• listener - a bound TCP socket
• timeout - timeout duration of incoming requests, any connection that does not send requests within this time period will be closed. In the future it should be possible to create long-lived queries, but these should be from trusted sources only, this would require some type of whitelisting.

pub fn register_tls_listener_with_tls_config( &mut self, listener: TcpListener, handshake_timeout: Duration, tls_config: Arc<ServerConfig>, ) -> Result<()>

Available on crate feature __tls only.

Register a TlsListener to the Server. The TlsListener should already be bound to either an IPv6 or an IPv4 address.

To make the server more resilient to DOS issues, there is a timeout. Care should be taken to not make this too low depending on use cases.

Arguments

• listener - a bound TCP (needs to be on a different port from standard TCP connections) socket
• timeout - timeout duration of incoming requests, any connection that does not send requests within this time period will be closed. In the future it should be possible to create long-lived queries, but these should be from trusted sources only, this would require some type of whitelisting.
• tls_config - rustls server config

pub fn register_tls_listener( &mut self, listener: TcpListener, timeout: Duration, server_cert_resolver: Arc<dyn ResolvesServerCert>, ) -> Result<()>

Available on crate feature __tls only.

Register a TlsListener to the Server by providing a pkcs12 certificate and key. The TlsListener should already be bound to either an IPv6 or an IPv4 address.

To make the server more resilient to DOS issues, there is a timeout. Care should be taken to not make this too low depending on use cases.

Arguments

• listener - a bound TCP (needs to be on a different port from standard TCP connections) socket
• timeout - timeout duration of incoming requests, any connection that does not send requests within this time period will be closed. In the future it should be possible to create long-lived queries, but these should be from trusted sources only, this would require some type of whitelisting.
• server_cert_resolver - resolver for the certificate and key used to announce to clients

pub fn register_https_listener( &mut self, listener: TcpListener, handshake_timeout: Duration, server_cert_resolver: Arc<dyn ResolvesServerCert>, dns_hostname: Option<String>, http_endpoint: String, ) -> Result<()>

Available on crate feature __https only.

Register a TcpListener for HTTPS (h2) to the Server for supporting DoH (DNS-over-HTTPS). The TcpListener should already be bound to either an IPv6 or an IPv4 address.

To make the server more resilient to DOS issues, there is a timeout. Care should be taken to not make this too low depending on use cases.

Arguments

• listener - a bound TCP (needs to be on a different port from standard TCP connections) socket
• timeout - timeout duration of incoming requests, any connection that does not send requests within this time period will be closed. In the future it should be possible to create long-lived queries, but these should be from trusted sources only, this would require some type of whitelisting.
• server_cert_resolver - resolver for the certificate and key used to announce to clients

pub fn register_quic_listener( &mut self, socket: UdpSocket, _timeout: Duration, server_cert_resolver: Arc<dyn ResolvesServerCert>, dns_hostname: Option<String>, ) -> Result<()>

Available on crate feature __quic only.

Register a UdpSocket to the Server for supporting DoQ (DNS-over-QUIC). The UdpSocket should already be bound to either an IPv6 or an IPv4 address.

To make the server more resilient to DOS issues, there is a timeout. Care should be taken to not make this too low depending on use cases.

Arguments

• listener - a bound TCP (needs to be on a different port from standard TCP connections) socket
• timeout - timeout duration of incoming requests, any connection that does not send requests within this time period will be closed. In the future it should be possible to create long-lived queries, but these should be from trusted sources only, this would require some type of whitelisting.
• server_cert_resolver - resolver for certificate and key used to announce to clients

pub fn register_h3_listener( &mut self, socket: UdpSocket, _timeout: Duration, server_cert_resolver: Arc<dyn ResolvesServerCert>, dns_hostname: Option<String>, ) -> Result<()>

Available on crate feature __h3 only.

Register a UdpSocket to the Server for supporting DoH3 (DNS-over-HTTP/3). The UdpSocket should already be bound to either an IPv6 or an IPv4 address.

To make the server more resilient to DOS issues, there is a timeout. Care should be taken to not make this too low depending on use cases.

Arguments

• listener - a bound TCP (needs to be on a different port from standard TCP connections) socket
• timeout - timeout duration of incoming requests, any connection that does not send requests within this time period will be closed. In the future it should be possible to create long-lived queries, but these should be from trusted sources only, this would require some type of whitelisting.
• server_cert_resolver - resolver for certificate and key used to announce to clients

pub async fn shutdown_gracefully(&mut self) -> Result<(), ProtoError>

Triggers a graceful shutdown the server. All background tasks will stop accepting new connections and the returned future will complete once all tasks have terminated.

pub fn shutdown_token(&self) -> &CancellationToken

Returns a reference to the CancellationToken used to gracefully shut down the server.

Once cancellation is requested, all background tasks will stop accepting new connections, and block_until_done() will complete once all tasks have terminated.

pub async fn block_until_done(&mut self) -> Result<(), ProtoError>

This will run until all background tasks complete. If one or more tasks return an error, one will be chosen as the returned error for this future.