on master help sign in
Add docs example to setInstallShutdownHandler
commit11030c56db8e863a1de39d36511bf64c067a33e0 authorDmitry Bushev <bushevdv@gmail.com> dateFri 2 Dec 2016, 14:18 (10 years ago) parent4ddd69b
1 file changed+10
warp/Network/Wai/Handler/Warp.hs+10
warp/Network/Wai/Handler/Warp.hs+10
@@ -286,6 +286,16 @@ getGracefulShutdownTimeout = settingsGracefulShutdownTimeout
286286-- handler. The handler should call the first argument,
287287-- which closes the listen socket, at shutdown.
288288--
289+-- Example usage:
290+--
291+-- @
292+-- settings :: IO () -> 'Settings'
293+-- settings shutdownAction = 'setInstallShutdownHandler' shutdownHandler 'defaultSettings'
294+-- __where__
295+-- shutdownHandler closeSocket =
296+-- void $ 'System.Posix.Signals.installHandler' 'System.Posix.Signals.sigTERM' ('System.Posix.Signals.Catch' $ shutdownAction >> closeSocket) 'Nothing'
297+-- @
298+--
289299-- Default: does not install any code.
290300--
291301-- Since 3.0.1