-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A fast, iteratee-based, epoll-enabled web server for the Snap Framework
--   
--   Snap is a simple and fast web development framework and server written
--   in Haskell. For more information or to download the latest version,
--   you can visit the Snap project website at
--   <a>http://snapframework.com/</a>.
--   
--   The Snap HTTP server is a high performance, epoll-enabled,
--   iteratee-based web server library written in Haskell. Together with
--   the <tt>snap-core</tt> library upon which it depends, it provides a
--   clean and efficient Haskell programming interface to the HTTP
--   protocol.
--   
--   Higher-level facilities for building web applications (like
--   user/session management, component interfaces, data modeling, etc.)
--   are planned but not yet implemented, so this release will mostly be of
--   interest for those who:
--   
--   <ul>
--   <li>need a fast and minimal HTTP API at roughly the same level of
--   abstraction as Java servlets, or</li>
--   <li>are interested in contributing to the Snap Framework project.</li>
--   </ul>
@package snap-server
@version 0.4.2

module System.FastLogger

-- | Holds the state for a logger.
data Logger

-- | Prepares a log message with the time prepended.
timestampedLogEntry :: ByteString -> IO ByteString

-- | Prepares a log message in "combined" format.
combinedLogEntry :: ByteString -> Maybe ByteString -> ByteString -> Int -> Maybe Int64 -> Maybe ByteString -> ByteString -> IO ByteString

-- | Creates a new logger, logging to the given file. If the file argument
--   is "-", then log to stdout; if it's "stderr" then we log to stderr,
--   otherwise we log to a regular file in append mode. The file is closed
--   and re-opened every 15 minutes to facilitate external log rotation.
newLogger :: FilePath -> IO Logger

-- | Sends out a log message verbatim with a newline appended. Note: if you
--   want a fancy log message you'll have to format it yourself (or use
--   <a>combinedLogEntry</a>).
logMsg :: Logger -> ByteString -> IO ()

-- | Kills a logger thread, causing any unwritten contents to be flushed
--   out to disk
stopLogger :: Logger -> IO ()


-- | This module exports the <a>Config</a> datatype which represents
--   partially-specified configurations of "serve" functions which run
--   <a>Snap</a> actions in <a>IO</a>.
module Snap.Http.Server.Config

-- | A record type which represents partial configurations (for
--   <tt>httpServe</tt>) by wrapping all of its fields in a <a>Maybe</a>.
--   Values of this type are usually constructed via its <a>Monoid</a>
--   instance by doing something like:
--   
--   <pre>
--   addListen (ListenHttp "0.0.0.0" 9000) mempty
--   </pre>
--   
--   Any fields which are unspecified in the <a>Config</a> passed to
--   <tt>httpServe</tt> (and this is the norm) are filled in with default
--   values from <a>defaultConfig</a>.
data MonadSnap m => Config m a

-- | A data type to store the bind address and port to listen on.
--   
--   For SSL support, it also stores the path to the certificate in PEM
--   format and the path to the private key in PEM format
data ConfigListen
ListenHttp :: ByteString -> Int -> ConfigListen
ListenHttps :: ByteString -> Int -> FilePath -> FilePath -> ConfigListen

-- | A data type to record which backend event loop should be used when
--   serving data.
data ConfigBackend
ConfigSimpleBackend :: ConfigBackend
ConfigLibEvBackend :: ConfigBackend

-- | Returns a completely empty <a>Config</a>. Equivalent to <a>mempty</a>
--   from <tt>Config'</tt>s <a>Monoid</a> instance.
emptyConfig :: MonadSnap m => Config m a

-- | These are the default values for all the fields in <a>Config</a>.
--   
--   <pre>
--   hostname     = "localhost"
--   listen       = []
--   accessLog    = "log/access.log"
--   errorLog     = "log/error.log"
--   locale       = "en_US"
--   backend      = Nothing (the backend is selected based on compile options)
--   compression  = True
--   verbose      = True
--   errorHandler = prints the error message
--   </pre>
defaultConfig :: MonadSnap m => Config m a

-- | Completes a partial <a>Config</a> by filling in the unspecified values
--   with the default values from <a>defaultConfig</a>. Also, if no
--   listeners are specified, adds a http listener on 0.0.0.0:8000
completeConfig :: MonadSnap m => Config m a -> Config m a

-- | This returns a <a>Config</a> gotten from parsing the options specified
--   on the command-line.
--   
--   The <a>Config</a> parameter is just for specifying any default values
--   which are to override those in <a>defaultConfig</a>. This is so the
--   usage message can accurately inform the user what the default values
--   for the options are. In most cases, you will probably just end up
--   passing <a>mempty</a> for this parameter.
--   
--   On Unix systems, the locale is read from the <tt>LANG</tt> environment
--   variable.
commandLineConfig :: MonadSnap m => Config m a -> IO (Config m a)
getHostname :: MonadSnap m => Config m a -> Maybe ByteString
getListen :: MonadSnap m => Config m a -> [ConfigListen]
getAccessLog :: MonadSnap m => Config m a -> Maybe (Maybe FilePath)
getErrorLog :: MonadSnap m => Config m a -> Maybe (Maybe FilePath)
getLocale :: MonadSnap m => Config m a -> Maybe String
getBackend :: MonadSnap m => Config m a -> Maybe ConfigBackend
getCompression :: MonadSnap m => Config m a -> Maybe Bool
getVerbose :: MonadSnap m => Config m a -> Maybe Bool
getErrorHandler :: MonadSnap m => Config m a -> Maybe (SomeException -> m ())
getDefaultTimeout :: MonadSnap m => Config m a -> Maybe Int
getOther :: MonadSnap m => Config m a -> Maybe a
setHostname :: MonadSnap m => ByteString -> Config m a -> Config m a
addListen :: MonadSnap m => ConfigListen -> Config m a -> Config m a
setAccessLog :: MonadSnap m => Maybe FilePath -> Config m a -> Config m a
setErrorLog :: MonadSnap m => Maybe FilePath -> Config m a -> Config m a
setLocale :: MonadSnap m => String -> Config m a -> Config m a
setBackend :: MonadSnap m => ConfigBackend -> Config m a -> Config m a
setCompression :: MonadSnap m => Bool -> Config m a -> Config m a
setVerbose :: MonadSnap m => Bool -> Config m a -> Config m a
setErrorHandler :: MonadSnap m => (SomeException -> m ()) -> Config m a -> Config m a
setDefaultTimeout :: MonadSnap m => Int -> Config m a -> Config m a
setOther :: MonadSnap m => a -> Config m a -> Config m a
instance Eq ConfigBackend
instance Show ConfigBackend
instance MonadSnap m => Monoid (OptionData m a)
instance MonadSnap m => Monoid (Config m a)
instance MonadSnap m => Show (Config m a)
instance Show ConfigListen


-- | The Snap HTTP server is a high performance, epoll-enabled,
--   iteratee-based web server library written in Haskell. Together with
--   the <tt>snap-core</tt> library upon which it depends, it provides a
--   clean and efficient Haskell programming interface to the HTTP
--   protocol.
module Snap.Http.Server

-- | Starts serving HTTP requests using the given handler. Uses only the
--   basic settings from the given config; error handling and compression
--   are ignored. This function never returns; to shut down the HTTP
--   server, kill the controlling thread.
simpleHttpServe :: MonadSnap m => Config m a -> Snap () -> IO ()

-- | Starts serving HTTP requests using the given handler, with settings
--   from the <a>Config</a> passed in. This function never returns; to shut
--   down the HTTP server, kill the controlling thread.
httpServe :: Config Snap () -> Snap () -> IO ()

-- | Starts serving HTTP using the given handler. The configuration is read
--   from the options given on the command-line, as returned by
--   <a>commandLineConfig</a>. This function never returns; to shut down
--   the HTTP server, kill the controlling thread.
quickHttpServe :: Snap () -> IO ()

-- | A short string describing the Snap server version
snapServerVersion :: ByteString

-- | Given a string like "en_US", this sets the locale to "en_US.UTF-8".
--   This doesn't work on Windows.
setUnicodeLocale :: String -> IO ()