Safe Haskell	Safe-Inferred
Language	Haskell2010

Lighthouse.Protocol

Contents

Client -> server messages
Server -> client messages
Orphan instances

Synopsis

data ClientRequest
- = DisplayRequest {
  - crDisplay :: Display
  }
- | StreamRequest
data ClientMessage = ClientMessage {
- cRequestId :: Int
- cVerb :: Text
- cPath :: [Text]
- cAuthentication :: Authentication
- cPayload :: Object
}
encodeRequest :: Int -> Authentication -> ClientRequest -> ClientMessage
data ServerEvent
- = ServerErrorEvent {
  - seCode :: Int
  - seWarnings :: [Text]
  - seError :: Maybe Text
  }
- | ServerInputEvent {
  - seEvent :: InputEvent
  }
- | ServerUnknownEvent {
  - sePayload :: Object
  }
data InputEvent = InputEvent {
- keSource :: Int
- keInput :: Input
- keIsDown :: Bool
}
data Input
- = KeyInput {
  - iKey :: Int
  }
- | ControllerInput {
  - iButton :: Int
  }
data ServerMessage = ServerMessage {
- sRNum :: Int
- sReqId :: Maybe Int
- sWarnings :: [Text]
- sResponse :: Maybe Text
- sPayload :: Maybe Object
}
decodeEvent :: ServerMessage -> Either Text ServerEvent

Client -> server messages

data ClientRequest Source #

High-level client -> server message structure.

Constructors

DisplayRequest
Fields crDisplay :: Display
StreamRequest

Instances

Instances details

Show ClientRequest Source #
Instance details Defined in Lighthouse.Protocol Methods showsPrec :: Int -> ClientRequest -> ShowS # show :: ClientRequest -> String # showList :: [ClientRequest] -> ShowS #
Eq ClientRequest Source #
Instance details Defined in Lighthouse.Protocol Methods (==) :: ClientRequest -> ClientRequest -> Bool # (/=) :: ClientRequest -> ClientRequest -> Bool #

data ClientMessage Source #

Low-level client -> server message structure.

Constructors

ClientMessage
Fields cRequestId :: Int cVerb :: Text cPath :: [Text] cAuthentication :: Authentication cPayload :: Object

Instances

Instances details

Show ClientMessage Source #
Instance details Defined in Lighthouse.Protocol Methods showsPrec :: Int -> ClientMessage -> ShowS # show :: ClientMessage -> String # showList :: [ClientMessage] -> ShowS #
Eq ClientMessage Source #
Instance details Defined in Lighthouse.Protocol Methods (==) :: ClientMessage -> ClientMessage -> Bool # (/=) :: ClientMessage -> ClientMessage -> Bool #
MPSerializable ClientMessage Source #
Instance details Defined in Lighthouse.Protocol Methods mpSerialize :: ClientMessage -> Object Source #
Serializable ClientMessage Source #
Instance details Defined in Lighthouse.Protocol Methods serialize :: ClientMessage -> ByteString Source #

encodeRequest :: Int -> Authentication -> ClientRequest -> ClientMessage Source #

Encodes a ClientRequest to a ClientMessage.

Server -> client messages

data ServerEvent Source #

High-level server -> client message structure.

Constructors

ServerErrorEvent
Fields seCode :: Int seWarnings :: [Text] seError :: Maybe Text
ServerInputEvent
Fields seEvent :: InputEvent
ServerUnknownEvent
Fields sePayload :: Object

Instances

Instances details

Show ServerEvent Source #
Instance details Defined in Lighthouse.Protocol Methods showsPrec :: Int -> ServerEvent -> ShowS # show :: ServerEvent -> String # showList :: [ServerEvent] -> ShowS #
Eq ServerEvent Source #
Instance details Defined in Lighthouse.Protocol Methods (==) :: ServerEvent -> ServerEvent -> Bool # (/=) :: ServerEvent -> ServerEvent -> Bool #

data InputEvent Source #

A key event emitted via the web interface.

Constructors

InputEvent
Fields keSource :: Int keInput :: Input keIsDown :: Bool

Instances

Instances details

Show InputEvent Source #
Instance details Defined in Lighthouse.Protocol Methods showsPrec :: Int -> InputEvent -> ShowS # show :: InputEvent -> String # showList :: [InputEvent] -> ShowS #
Eq InputEvent Source #
Instance details Defined in Lighthouse.Protocol Methods (==) :: InputEvent -> InputEvent -> Bool # (/=) :: InputEvent -> InputEvent -> Bool #
MPDeserializable InputEvent Source #
Instance details Defined in Lighthouse.Protocol Methods mpDeserialize :: Object -> Either Text InputEvent Source #

data Input Source #

An input via the web interface.

Constructors

KeyInput
Fields iKey :: Int
ControllerInput
Fields iButton :: Int

Instances

Instances details

Show Input Source #
Instance details Defined in Lighthouse.Protocol Methods showsPrec :: Int -> Input -> ShowS # show :: Input -> String # showList :: [Input] -> ShowS #
Eq Input Source #
Instance details Defined in Lighthouse.Protocol Methods (==) :: Input -> Input -> Bool # (/=) :: Input -> Input -> Bool #

data ServerMessage Source #

Low-level server -> client message structure.

Constructors

ServerMessage
Fields sRNum :: Int sReqId :: Maybe Int sWarnings :: [Text] sResponse :: Maybe Text sPayload :: Maybe Object

Instances

Instances details

Show ServerMessage Source #
Instance details Defined in Lighthouse.Protocol Methods showsPrec :: Int -> ServerMessage -> ShowS # show :: ServerMessage -> String # showList :: [ServerMessage] -> ShowS #
Eq ServerMessage Source #
Instance details Defined in Lighthouse.Protocol Methods (==) :: ServerMessage -> ServerMessage -> Bool # (/=) :: ServerMessage -> ServerMessage -> Bool #
MPDeserializable ServerMessage Source #
Instance details Defined in Lighthouse.Protocol Methods mpDeserialize :: Object -> Either Text ServerMessage Source #
Deserializable ServerMessage Source #
Instance details Defined in Lighthouse.Protocol Methods deserialize :: ByteString -> Either Text ServerMessage Source #

decodeEvent :: ServerMessage -> Either Text ServerEvent Source #

Decodes a ServerMessage to a ServerEvent.

Orphan instances

MPSerializable Display Source #
Instance details Methods mpSerialize :: Display -> Object Source #