Mellon.Web.Client

This module provides client-side actions for interacting with the server-side MellonAPI.

The client actions are implemented on top of the Network.HTTP.Client and Servant.Client modules.

Client actions

These actions take a Manager and a BaseUrl, and should then be run in an ExceptT transformer stack to produce a result. For example, assuming the service endpoint is http://localhost:8081/:

> let baseUrl = BaseUrl Http "localhost" 8081 ""
> manager <- newManager defaultManagerSettings
> runExceptT $ putState Locked manager baseUrl
Right Locked

getTime :: ClientM Time

Get the server's time. This action is provided chiefly to verify the accuracy of the server's clock.

getState :: ClientM State

Get the current state of the server's Controller.

putState :: State -> ClientM State

Lock or unlock the server's Controller.

Server types

Re-exported for convenience.

data State

Mimics State, but provides JSON conversions. (Avoids orphan instances.)

Constructors

Locked

Unlocked !UTCTime

Instances

Eq State

Methods

(==) :: State -> State -> Bool

(/=) :: State -> State -> Bool

Data State

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> State -> c State

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c State

toConstr :: State -> Constr

dataTypeOf :: State -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c State)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c State)

gmapT :: (forall b. Data b => b -> b) -> State -> State

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> State -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> State -> r

gmapQ :: (forall d. Data d => d -> u) -> State -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> State -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> State -> m State

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> State -> m State

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> State -> m State

Read State

Methods

readsPrec :: Int -> ReadS State

readList :: ReadS [State]

readPrec :: ReadPrec State

readListPrec :: ReadPrec [State]

Show State

Methods

showsPrec :: Int -> State -> ShowS

show :: State -> String

showList :: [State] -> ShowS

Generic State

Associated Types

type Rep State :: * -> *

Methods

from :: State -> Rep State x

to :: Rep State x -> State

ToJSON State

Methods

toJSON :: State -> Value

toEncoding :: State -> Encoding

toJSONList :: [State] -> Value

toEncodingList :: [State] -> Encoding

FromJSON State

Methods

parseJSON :: Value -> Parser State

parseJSONList :: Value -> Parser [State]

ToHtml State

Methods

toHtml :: Monad m => State -> HtmlT m ()

toHtmlRaw :: Monad m => State -> HtmlT m ()

ToSample State

Methods

toSamples :: Proxy * State -> [(Text, State)]

ToSchema State

Methods

declareNamedSchema :: proxy State -> Declare (Definitions Schema) NamedSchema

type Rep State

type Rep State = D1 * (MetaData "State" "Mellon.Web.Server.API" "mellon-web-0.8.0.4-nI2XFGAXSY8Lq0q42Dav5" False) ((:+:) * (C1 * (MetaCons "Locked" PrefixI False) (U1 *)) (C1 * (MetaCons "Unlocked" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * UTCTime))))

newtype Time

A newtype wrapper around UTCTime, for serving HTML without orphan instances.

Constructors

Time UTCTime

Instances

Eq Time

Methods

(==) :: Time -> Time -> Bool

(/=) :: Time -> Time -> Bool

Data Time

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Time -> c Time

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Time

toConstr :: Time -> Constr

dataTypeOf :: Time -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Time)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Time)

gmapT :: (forall b. Data b => b -> b) -> Time -> Time

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Time -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Time -> r

gmapQ :: (forall d. Data d => d -> u) -> Time -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Time -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Time -> m Time

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Time -> m Time

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Time -> m Time

Ord Time

Methods

compare :: Time -> Time -> Ordering

(<) :: Time -> Time -> Bool

(<=) :: Time -> Time -> Bool

(>) :: Time -> Time -> Bool

(>=) :: Time -> Time -> Bool

max :: Time -> Time -> Time

min :: Time -> Time -> Time

Read Time

Methods

readsPrec :: Int -> ReadS Time

readList :: ReadS [Time]

readPrec :: ReadPrec Time

readListPrec :: ReadPrec [Time]

Show Time

Methods

showsPrec :: Int -> Time -> ShowS

show :: Time -> String

showList :: [Time] -> ShowS

Generic Time

Associated Types

type Rep Time :: * -> *

Methods

from :: Time -> Rep Time x

to :: Rep Time x -> Time

ToJSON Time

Methods

toJSON :: Time -> Value

toEncoding :: Time -> Encoding

toJSONList :: [Time] -> Value

toEncodingList :: [Time] -> Encoding

FromJSON Time

Methods

parseJSON :: Value -> Parser Time

parseJSONList :: Value -> Parser [Time]

ToHtml Time

Methods

toHtml :: Monad m => Time -> HtmlT m ()

toHtmlRaw :: Monad m => Time -> HtmlT m ()

ToSample Time

Methods

toSamples :: Proxy * Time -> [(Text, Time)]

ToSchema Time

Methods

declareNamedSchema :: proxy Time -> Declare (Definitions Schema) NamedSchema

type Rep Time

type Rep Time = D1 * (MetaData "Time" "Mellon.Web.Server.API" "mellon-web-0.8.0.4-nI2XFGAXSY8Lq0q42Dav5" True) (C1 * (MetaCons "Time" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * UTCTime)))