Struct trust_dns_server::server::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 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( &mut self, listener: TcpListener, timeout: Duration, certificate_and_key: (Vec<Certificate>, PrivateKey) ) -> Result<()>

Available on crate feature dns-over-rustls 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.
• pkcs12 - certificate used to announce to clients

pub fn register_https_listener( &mut self, listener: TcpListener, _timeout: Duration, certificate_and_key: (Vec<Certificate>, PrivateKey), dns_hostname: Option<String> ) -> Result<()>

Available on crate feature dns-over-https-rustls 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.
• certificate_and_key - certificate and key used to announce to clients

pub fn register_quic_listener( &mut self, socket: UdpSocket, _timeout: Duration, certificate_and_key: (Vec<Certificate>, PrivateKey), dns_hostname: Option<String> ) -> Result<()>

Available on crate feature dns-over-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.
• pkcs12 - certificate used to announce to clients

pub fn graceful( self ) -> (ShutdownSignal, impl Future<Output = Result<(), ProtoError>>)

Returns a signal used for initiating a graceful shutdown of the server and the future used for awaiting completion of the shutdown.

This allows the application to have separate code paths that are responsible for triggering shutdown and awaiting application completion.

pub async fn shutdown_gracefully(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.

This is equivalent to calling Self::graceful, then triggering the graceful shutdown (via [ShutdownSignal::shutdown]) and awaiting completion of the server.

pub async fn block_until_done(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.