Struct dropshot::HttpServer

pub struct HttpServer { /* fields omitted */ }

A thin wrapper around a Hyper Server object that exposes some interfaces that we find useful (e.g., close()). TODO-cleanup: this mechanism should probably do better with types. In particular, once you call run(), you shouldn't be able to call it again (i.e., it should consume self). But you should be able to close() it. Once you've called close(), you shouldn't be able to call it again.

Implementations

impl HttpServer

pub fn local_addr(&self) -> SocketAddr

pub fn close(self)

pub fn run(&mut self) -> JoinHandle<Result<(), Error>>

pub async fn wait_for_shutdown<'_>(
    &'_ mut self,
    join_handle: JoinHandle<Result<(), Error>>
) -> Result<(), String>

pub fn new(
    config: &ConfigDropshot,
    api: ApiDescription,
    private: Arc<dyn Any + Send + Sync + 'static>,
    log: &Logger
) -> Result<HttpServer, Error>

Set up an HTTP server bound on the specified address that runs registered handlers. You must invoke run() on the returned instance of HttpServer (and await the result) to actually start the server. You can call close() to begin a graceful shutdown of the server, which will be complete when the run() Future is resolved. TODO-cleanup We should be able to take a reference to the ApiDescription. We currently can't because we need to hang onto the router.

pub fn app_private(&self) -> Arc<dyn Any + Send + Sync + 'static>