Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
Signed-off-by: Lucio Franco <luciofranco14@gmail.com>
  • Loading branch information
LucioFranco authored and seanmonstar committed May 19, 2020
1 parent c8a5dbd commit caecd5d
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/server.rs
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,15 @@ where
self.serve_incoming2(incoming)
}

/// dox
/// Setup this `Server` with a specific stream of incoming connections and a
/// signal to initiate graceful shutdown.
///
/// This can be used for Unix Domain Sockets, or TLS, etc.
///
/// When the signal completes, the server will start the graceful shutdown
/// process.
///
/// Returns a `Future` that can be executed on any runtime.
pub fn serve_incoming_with_graceful_shutdown<I>(
self,
incoming: I,
Expand Down

0 comments on commit caecd5d

Please sign in to comment.