Safe Haskell	None
Language	Haskell98

Keter.Common

Description

Provides logging, versioning and some type aliases

Synopsis

type Appname = Text
data Plugin = Plugin {
- pluginGetEnv :: Appname -> Object -> IO [(Text, Text)]
}
type Plugins = [Plugin]
class ToCurrent a where
- type Previous a
- toCurrent :: Previous a -> a
type Port = Int
type Host = CI Text
type HostBS = CI ByteString
getAppname :: FilePath -> Text
data LogMessage
- = ProcessCreated FilePath
- | InvalidBundle FilePath SomeException
- | ProcessDidNotStart FilePath
- | ExceptionThrown Text SomeException
- | RemovingPort Int
- | UnpackingBundle FilePath
- | TerminatingApp Text
- | FinishedReloading Text
- | TerminatingOldProcess AppId
- | RemovingOldFolder FilePath
- | ReceivedInotifyEvent Text
- | ProcessWaiting FilePath
- | OtherMessage Text
- | ErrorStartingBundle Text SomeException
- | SanityChecksPassed
- | ReservingHosts AppId (Set Host)
- | ForgetingReservations AppId (Set Host)
- | ActivatingApp AppId (Set Host)
- | DeactivatingApp AppId (Set Host)
- | ReactivatingApp AppId (Set Host) (Set Host)
- | WatchedFile Text FilePath
- | ReloadFrom (Maybe String) String
- | Terminating String
- | LaunchInitial
- | LaunchCli
- | StartWatching
- | StartListening
- | BindCli AddrInfo
- | ReceivedCliConnection SockAddr
- | KillingApp Port Text
- | ProxyException Request SomeException
data KeterException
- = CannotParsePostgres FilePath
- | ExitCodeFailure FilePath ExitCode
- | NoPortsAvailable
- | InvalidConfigFile ParseException
- | InvalidKeterConfigFile !FilePath !ParseException
- | CannotReserveHosts !AppId !(Map Host AppId)
- | FileNotExecutable !FilePath
- | ExecutableNotFound !FilePath
- | EnsureAliveShouldBeBiggerThenZero {
  - keterExceptionGot :: !Int
  }
logEx :: Q Exp
data AppId
- = AIBuiltin
- | AINamed !Appname
data SSLConfig
- = SSLFalse
- | SSLTrue
- | SSL !FilePath !(Vector FilePath) !FilePath

Documentation

type Appname = Text Source #

Name of the application. Should just be the basename of the application file.

data Plugin Source #

Constructors

Plugin
Fields pluginGetEnv :: Appname -> Object -> IO [(Text, Text)]

type Plugins = [Plugin] Source #

class ToCurrent a where Source #

Used for versioning data types.

Associated Types

type Previous a Source #

Methods

toCurrent :: Previous a -> a Source #

Instances

Instances details

ToCurrent RedirectConfig Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous RedirectConfig Source # Methods toCurrent :: Previous RedirectConfig -> RedirectConfig Source #
ToCurrent StaticFilesConfig Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous StaticFilesConfig Source # Methods toCurrent :: Previous StaticFilesConfig -> StaticFilesConfig Source #
ToCurrent KeterConfig Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous KeterConfig Source # Methods toCurrent :: Previous KeterConfig -> KeterConfig Source #
ToCurrent BundleConfig Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous BundleConfig Source # Methods toCurrent :: Previous BundleConfig -> BundleConfig Source #
ToCurrent a => ToCurrent (Maybe a) Source #
Instance details Defined in Keter.Common Associated Types type Previous (Maybe a) Source # Methods toCurrent :: Previous (Maybe a) -> Maybe a Source #
ToCurrent (WebAppConfig ()) Source #
Instance details Defined in Keter.Config.V10 Associated Types type Previous (WebAppConfig ()) Source # Methods toCurrent :: Previous (WebAppConfig ()) -> WebAppConfig () Source #

type Port = Int Source #

A port for an individual app to listen on.

type Host = CI Text Source #

A virtual host we want to serve content from.

type HostBS = CI ByteString Source #

getAppname :: FilePath -> Text Source #

data LogMessage Source #

Constructors

ProcessCreated FilePath
InvalidBundle FilePath SomeException
ProcessDidNotStart FilePath
ExceptionThrown Text SomeException
RemovingPort Int
UnpackingBundle FilePath
TerminatingApp Text
FinishedReloading Text
TerminatingOldProcess AppId
RemovingOldFolder FilePath
ReceivedInotifyEvent Text
ProcessWaiting FilePath
OtherMessage Text
ErrorStartingBundle Text SomeException
SanityChecksPassed
ReservingHosts AppId (Set Host)
ForgetingReservations AppId (Set Host)
ActivatingApp AppId (Set Host)
DeactivatingApp AppId (Set Host)
ReactivatingApp AppId (Set Host) (Set Host)
WatchedFile Text FilePath
ReloadFrom (Maybe String) String
Terminating String
LaunchInitial
LaunchCli
StartWatching
StartListening
BindCli AddrInfo
ReceivedCliConnection SockAddr
KillingApp Port Text
ProxyException Request SomeException

Instances

Instances details

Show LogMessage Source #
Instance details Defined in Keter.Common Methods showsPrec :: Int -> LogMessage -> ShowS # show :: LogMessage -> String # showList :: [LogMessage] -> ShowS #

data KeterException Source #

Instances

Instances details

Show KeterException Source #
Instance details Defined in Keter.Common Methods showsPrec :: Int -> KeterException -> ShowS # show :: KeterException -> String # showList :: [KeterException] -> ShowS #
Exception KeterException Source #
Instance details Defined in Keter.Common Methods toException :: KeterException -> SomeException # fromException :: SomeException -> Maybe KeterException # displayException :: KeterException -> String #

logEx :: Q Exp Source #

data AppId Source #

Constructors

AIBuiltin
AINamed !Appname

Instances

Instances details

Eq AppId Source #
Instance details Defined in Keter.Common Methods (==) :: AppId -> AppId -> Bool # (/=) :: AppId -> AppId -> Bool #
Ord AppId Source #
Instance details Defined in Keter.Common Methods compare :: AppId -> AppId -> Ordering # (<) :: AppId -> AppId -> Bool # (<=) :: AppId -> AppId -> Bool # (>) :: AppId -> AppId -> Bool # (>=) :: AppId -> AppId -> Bool # max :: AppId -> AppId -> AppId # min :: AppId -> AppId -> AppId #
Show AppId Source #
Instance details Defined in Keter.Common Methods showsPrec :: Int -> AppId -> ShowS # show :: AppId -> String # showList :: [AppId] -> ShowS #

data SSLConfig Source #

Constructors

SSLFalse
SSLTrue
SSL !FilePath !(Vector FilePath) !FilePath

Instances

Instances details

Eq SSLConfig Source #
Instance details Defined in Keter.Common Methods (==) :: SSLConfig -> SSLConfig -> Bool # (/=) :: SSLConfig -> SSLConfig -> Bool #
Ord SSLConfig Source #
Instance details Defined in Keter.Common Methods compare :: SSLConfig -> SSLConfig -> Ordering # (<) :: SSLConfig -> SSLConfig -> Bool # (<=) :: SSLConfig -> SSLConfig -> Bool # (>) :: SSLConfig -> SSLConfig -> Bool # (>=) :: SSLConfig -> SSLConfig -> Bool # max :: SSLConfig -> SSLConfig -> SSLConfig # min :: SSLConfig -> SSLConfig -> SSLConfig #
Show SSLConfig Source #
Instance details Defined in Keter.Common Methods showsPrec :: Int -> SSLConfig -> ShowS # show :: SSLConfig -> String # showList :: [SSLConfig] -> ShowS #
ToJSON SSLConfig Source #
Instance details Defined in Keter.Common Methods toJSON :: SSLConfig -> Value # toEncoding :: SSLConfig -> Encoding # toJSONList :: [SSLConfig] -> Value # toEncodingList :: [SSLConfig] -> Encoding #
FromJSON SSLConfig Source #
Instance details Defined in Keter.Common Methods parseJSON :: Value -> Parser SSLConfig # parseJSONList :: Value -> Parser [SSLConfig] #
ParseYamlFile SSLConfig Source #
Instance details Defined in Keter.Common Methods parseYamlFile :: BaseDir -> Value -> Parser SSLConfig Source #

CannotParsePostgres FilePath
ExitCodeFailure FilePath ExitCode
NoPortsAvailable
InvalidConfigFile ParseException
InvalidKeterConfigFile !FilePath !ParseException
CannotReserveHosts !AppId !(Map Host AppId)
FileNotExecutable !FilePath
ExecutableNotFound !FilePath
EnsureAliveShouldBeBiggerThenZero
Fields keterExceptionGot :: !Int