Trait trust_dns_proto::xfer::DnsRequestSender
source · pub trait DnsRequestSender: Stream<Item = (), Error = ProtoError> + 'static + Display + Send {
type DnsResponseFuture: Future<Item = DnsResponse, Error = ProtoError> + 'static + Send;
fn send_message(&mut self, message: DnsRequest) -> Self::DnsResponseFuture;
fn error_response(error: ProtoError) -> Self::DnsResponseFuture;
fn shutdown(&mut self);
fn is_shutdown(&self) -> bool;
}
Expand description
Types that implement this are capable of sending a serialized DNS message on a stream
The underlying Stream implementation should yield Some(())
whenever it is ready to send a message,
NotReady, if it is not ready to send a message, and Err
or None
in the case that the stream is
done, and should be shutdown.
Required Associated Types
sourcetype DnsResponseFuture: Future<Item = DnsResponse, Error = ProtoError> + 'static + Send
type DnsResponseFuture: Future<Item = DnsResponse, Error = ProtoError> + 'static + Send
A future that resolves to a response serial message
Required Methods
sourcefn send_message(&mut self, message: DnsRequest) -> Self::DnsResponseFuture
fn send_message(&mut self, message: DnsRequest) -> Self::DnsResponseFuture
Send a message, and return a future of the response
Return
A future which will resolve to a SerialMessage response
sourcefn error_response(error: ProtoError) -> Self::DnsResponseFuture
fn error_response(error: ProtoError) -> Self::DnsResponseFuture
Constructs an error response
sourcefn shutdown(&mut self)
fn shutdown(&mut self)
Allows the upstream user to inform the underling stream that it should shutdown.
After this is called, the next time poll
is called on the stream it would be correct to return Ok(Async::Ready(()))
. This is not required though, if there are say outstanding requests that are not yet comlete, then it would be correct to first wait for those results.
sourcefn is_shutdown(&self) -> bool
fn is_shutdown(&self) -> bool
Returns true if the stream has been shutdown with shutdown