Struct trust_dns_proto::xfer::dns_multiplexer::DnsMultiplexer

pub struct DnsMultiplexer<S, MF, D = Box<dyn DnsStreamHandle>> where
    D: Send + 'static,
    S: DnsClientStream + 'static,
    MF: MessageFinalizer,  { /* fields omitted */ }

A DNS Client implemented over futures-rs.

This Client is generic and capable of wrapping UDP, TCP, and other underlying DNS protocol implementations. This should be used for underlying protocols that do not natively support multiplexed sessions.

Implementations

impl<S, MF> DnsMultiplexer<S, MF, Box<dyn DnsStreamHandle>> where
    S: DnsClientStream + Unpin + 'static,
    MF: MessageFinalizer, 

pub fn new<F>(
    stream: F,
    stream_handle: Box<dyn DnsStreamHandle>,
    signer: Option<Arc<MF>>
) -> DnsMultiplexerConnect<F, S, MF> where
    F: Future<Output = Result<S, ProtoError>> + Send + Unpin + 'static, 

Spawns a new DnsMultiplexer Stream. This uses a default timeout of 5 seconds for all requests.

Arguments

• stream - A stream of bytes that can be used to send/receive DNS messages (see TcpClientStream or UdpClientStream)
• stream_handle - The handle for the stream on which bytes can be sent/received.
• signer - An optional signer for requests, needed for Updates with Sig0, otherwise not needed

pub fn with_timeout<F>(
    stream: F,
    stream_handle: Box<dyn DnsStreamHandle>,
    timeout_duration: Duration,
    signer: Option<Arc<MF>>
) -> DnsMultiplexerConnect<F, S, MF> where
    F: Future<Output = Result<S, ProtoError>> + Send + Unpin + 'static, 

Spawns a new DnsMultiplexer Stream.

Arguments

• stream - A stream of bytes that can be used to send/receive DNS messages (see TcpClientStream or UdpClientStream)
• timeout_duration - All requests may fail due to lack of response, this is the time to wait for a response before canceling the request.
• stream_handle - The handle for the stream on which bytes can be sent/received.
• signer - An optional signer for requests, needed for Updates with Sig0, otherwise not needed

Trait Implementations

impl<S, MF> Display for DnsMultiplexer<S, MF> where
    S: DnsClientStream + 'static,
    MF: MessageFinalizer + Send + Sync + 'static, 

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<S, MF> DnsRequestSender for DnsMultiplexer<S, MF> where
    S: DnsClientStream + Unpin + 'static,
    MF: MessageFinalizer + Send + Sync + 'static, 

type DnsResponseFuture = DnsMultiplexerSerialResponse

A future that resolves to a response serial message

fn send_message<TE: Time>(
    &mut self,
    request: DnsRequest,
    cx: &mut Context<'_>
) -> Self::DnsResponseFuture

Send a message, and return a future of the response

fn error_response<TE: Time>(error: ProtoError) -> Self::DnsResponseFuture

Constructs an error response

fn shutdown(&mut self)

Allows the upstream user to inform the underling stream that it should shutdown.

fn is_shutdown(&self) -> bool

Returns true if the stream has been shutdown with shutdown

impl<S, MF> Stream for DnsMultiplexer<S, MF> where
    S: DnsClientStream + Unpin + 'static,
    MF: MessageFinalizer + Send + Sync + 'static, 

type Item = Result<(), ProtoError>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.