feed-gipeda-0.1.0.1: Simple project template from stack

Safe HaskellNone
LanguageHaskell2010

FeedGipeda

Description

The API part of feed-gipeda. The console client is just a thin wrapper around this.

Synopsis

Documentation

data Endpoint Source

An IP endpoint, or rather some string and some integer delimited by a colon.

Constructors

Endpoint 

Fields

host :: String
 
port :: Int
 

feedGipeda :: Paths -> Command -> Deployment -> ProcessRole -> Verbosity -> IO () Source

The parameters correspond exactly to the command line parameters, to you should read the --help message for more thorough documentation.

feedGipeda determines the appropriate mode of operation (e.g. watching or one-shot). It also works as master or slave node, depending on which endpoints are given. Lastly, verbose will lead to more debug output.

data Paths Source

Important file paths for the master node.

Constructors

Paths 

Fields

configFile :: FilePath

Lists the repositories to clone in YAML markup. See the README.

gipeda :: FilePath

Path to the gipeda executable if not in $PATH.

data Endpoint Source

An IP endpoint, or rather some string and some integer delimited by a colon.

Constructors

Endpoint 

Fields

host :: String
 
port :: Int
 

data Command Source

feed-gipeda can either check config file syntax or build the sites.

Constructors

Check 
Build BuildMode 

data BuildMode Source

Whether feed-gipeda should exit when done regenerating

Constructors

Once

Don't watch the config file or repositories for updates, exit immediately when there are no more commits to benchmark.

WatchForChanges NominalDiffTime

Don't exit; watch config file and repositories for updates.

data Deployment Source

Signifies deployment to a location accessible via SSH.

Constructors

NoDeployment 
Deploy String

A SSH/local directory where to rsync website changes to.

data ProcessRole Source

Whether the current feed-gipeda process is a master node, slave node, or both.