on master help sign in
Update documentation for graceful shutdown timeout
commitfce31039a0ccb6f99758755eafe772c1932d9882 authorReid Draper <reiddraper@gmail.com> dateThu 19 May 2016, 13:23 (10 years ago) parentaebd8d4
2 files changed+6
warp/Network/Wai/Handler/Warp.hs+4 warp/Network/Wai/Handler/Warp/Settings.hs+2
warp/Network/Wai/Handler/Warp.hs+4
@@ -247,6 +247,8 @@ getOnException :: Settings -> Maybe Request -> SomeException -> IO ()
247247getOnException = settingsOnException
248248
249249-- | Get the graceful shutdown timeout
250+--
251+-- Since 3.2.8
250252getGracefulShutdownTimeout :: Settings -> Maybe Int
251253getGracefulShutdownTimeout = settingsGracefulShutdownTimeout
252254
@@ -356,6 +358,8 @@ setLogger lgr y = y { settingsLogger = lgr }
356358-- | Set the graceful shutdown timeout. A timeout of `Nothing' will
357359-- wait indefinitely, and a number, if provided, will be treated as seconds
358360-- to wait for requests to finish, before shutting down the server entirely.
361+--
362+-- Since 3.2.8
359363setGracefulShutdownTimeout :: Maybe Int
360364 -> Settings -> Settings
361365setGracefulShutdownTimeout time y = y { settingsGracefulShutdownTimeout = time }
warp/Network/Wai/Handler/Warp/Settings.hs+2
@@ -104,6 +104,8 @@ data Settings = Settings
104104 , settingsGracefulShutdownTimeout :: Maybe Int
105105 -- ^ An optional timeout to limit the time (in seconds) waiting for
106106 -- a graceful shutdown of the web server.
107+ --
108+ -- Since 3.2.8
107109 }
108110
109111-- | Specify usage of the PROXY protocol.