Cachix.API.WebSocketSubprotocol

Documentation

data Message cmd

Constructors

Message

Fields

• method :: Text
• command :: cmd
• agent :: Maybe UUID
• id :: UUID

Instances

FromJSON cmd => FromJSON (Message cmd)

Defined in Cachix.API.WebSocketSubprotocol

Methods

parseJSON :: Value -> Parser (Message cmd)

parseJSONList :: Value -> Parser [Message cmd]

omittedField :: Maybe (Message cmd)

ToJSON cmd => ToJSON (Message cmd)

Defined in Cachix.API.WebSocketSubprotocol

Methods

toJSON :: Message cmd -> Value

toEncoding :: Message cmd -> Encoding

toJSONList :: [Message cmd] -> Value

toEncodingList :: [Message cmd] -> Encoding

omitField :: Message cmd -> Bool

Generic (Message cmd)

Defined in Cachix.API.WebSocketSubprotocol

Associated Types

type Rep (Message cmd) :: Type -> Type

Methods

from :: Message cmd -> Rep (Message cmd) x

to :: Rep (Message cmd) x -> Message cmd

Show cmd => Show (Message cmd)

Defined in Cachix.API.WebSocketSubprotocol

Methods

showsPrec :: Int -> Message cmd -> ShowS

show :: Message cmd -> String

showList :: [Message cmd] -> ShowS

Eq cmd => Eq (Message cmd)

Defined in Cachix.API.WebSocketSubprotocol

Methods

(==) :: Message cmd -> Message cmd -> Bool

(/=) :: Message cmd -> Message cmd -> Bool

type Rep (Message cmd)

Defined in Cachix.API.WebSocketSubprotocol

type Rep (Message cmd) = D1 ('MetaData "Message" "Cachix.API.WebSocketSubprotocol" "cachix-api-1.7.3-5QelKZioQAb5fZAnL6kOxB" 'False) (C1 ('MetaCons "Message" 'PrefixI 'True) ((S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 cmd)) :*: (S1 ('MetaSel ('Just "agent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe UUID)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID))))

data Cache

Constructors

Cache

Fields

• cacheName :: Text
• publicKey :: Text
• isPublic :: Bool

Instances

FromJSON Cache

Defined in Cachix.API.WebSocketSubprotocol

Methods

parseJSON :: Value -> Parser Cache

parseJSONList :: Value -> Parser [Cache]

omittedField :: Maybe Cache

ToJSON Cache

Defined in Cachix.API.WebSocketSubprotocol

Methods

toJSON :: Cache -> Value

toEncoding :: Cache -> Encoding

toJSONList :: [Cache] -> Value

toEncodingList :: [Cache] -> Encoding

omitField :: Cache -> Bool

Generic Cache

Defined in Cachix.API.WebSocketSubprotocol

Associated Types

type Rep Cache :: Type -> Type

Methods

from :: Cache -> Rep Cache x

to :: Rep Cache x -> Cache

Show Cache

Defined in Cachix.API.WebSocketSubprotocol

Methods

showsPrec :: Int -> Cache -> ShowS

show :: Cache -> String

showList :: [Cache] -> ShowS

Eq Cache

Defined in Cachix.API.WebSocketSubprotocol

Methods

(==) :: Cache -> Cache -> Bool

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

type Rep Cache

Defined in Cachix.API.WebSocketSubprotocol

type Rep Cache = D1 ('MetaData "Cache" "Cachix.API.WebSocketSubprotocol" "cachix-api-1.7.3-5QelKZioQAb5fZAnL6kOxB" 'False) (C1 ('MetaCons "Cache" 'PrefixI 'True) (S1 ('MetaSel ('Just "cacheName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "publicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "isPublic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

data AgentInformation

Constructors

AgentInformation

Fields

• cache :: Maybe Cache
• id :: UUID

Instances

FromJSON AgentInformation

Defined in Cachix.API.WebSocketSubprotocol

Methods

parseJSON :: Value -> Parser AgentInformation

parseJSONList :: Value -> Parser [AgentInformation]

omittedField :: Maybe AgentInformation

ToJSON AgentInformation

Defined in Cachix.API.WebSocketSubprotocol

Methods

toJSON :: AgentInformation -> Value

toEncoding :: AgentInformation -> Encoding

toJSONList :: [AgentInformation] -> Value

toEncodingList :: [AgentInformation] -> Encoding

omitField :: AgentInformation -> Bool

Generic AgentInformation

Defined in Cachix.API.WebSocketSubprotocol

Associated Types

type Rep AgentInformation :: Type -> Type

Methods

from :: AgentInformation -> Rep AgentInformation x

to :: Rep AgentInformation x -> AgentInformation

Show AgentInformation

Defined in Cachix.API.WebSocketSubprotocol

Methods

showsPrec :: Int -> AgentInformation -> ShowS

show :: AgentInformation -> String

showList :: [AgentInformation] -> ShowS

Eq AgentInformation

Defined in Cachix.API.WebSocketSubprotocol

Methods

(==) :: AgentInformation -> AgentInformation -> Bool

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

type Rep AgentInformation

Defined in Cachix.API.WebSocketSubprotocol

type Rep AgentInformation = D1 ('MetaData "AgentInformation" "Cachix.API.WebSocketSubprotocol" "cachix-api-1.7.3-5QelKZioQAb5fZAnL6kOxB" 'False) (C1 ('MetaCons "AgentInformation" 'PrefixI 'True) (S1 ('MetaSel ('Just "cache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Cache)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID)))

data DeploymentDetails

Constructors

DeploymentDetails

Fields

• storePath :: Text
• id :: UUID
• index :: Int64
• rollbackScript :: Maybe Text

Instances

FromJSON DeploymentDetails

Defined in Cachix.API.WebSocketSubprotocol

Methods

parseJSON :: Value -> Parser DeploymentDetails

parseJSONList :: Value -> Parser [DeploymentDetails]

omittedField :: Maybe DeploymentDetails

ToJSON DeploymentDetails

Defined in Cachix.API.WebSocketSubprotocol

Methods

toJSON :: DeploymentDetails -> Value

toEncoding :: DeploymentDetails -> Encoding

toJSONList :: [DeploymentDetails] -> Value

toEncodingList :: [DeploymentDetails] -> Encoding

omitField :: DeploymentDetails -> Bool

Generic DeploymentDetails

Defined in Cachix.API.WebSocketSubprotocol

Associated Types

type Rep DeploymentDetails :: Type -> Type

Methods

from :: DeploymentDetails -> Rep DeploymentDetails x

to :: Rep DeploymentDetails x -> DeploymentDetails

Show DeploymentDetails

Defined in Cachix.API.WebSocketSubprotocol

Methods

showsPrec :: Int -> DeploymentDetails -> ShowS

show :: DeploymentDetails -> String

showList :: [DeploymentDetails] -> ShowS

Eq DeploymentDetails

Defined in Cachix.API.WebSocketSubprotocol

Methods

(==) :: DeploymentDetails -> DeploymentDetails -> Bool

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

type Rep DeploymentDetails

Defined in Cachix.API.WebSocketSubprotocol

type Rep DeploymentDetails = D1 ('MetaData "DeploymentDetails" "Cachix.API.WebSocketSubprotocol" "cachix-api-1.7.3-5QelKZioQAb5fZAnL6kOxB" 'False) (C1 ('MetaCons "DeploymentDetails" 'PrefixI 'True) ((S1 ('MetaSel ('Just "storePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID)) :*: (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int64) :*: S1 ('MetaSel ('Just "rollbackScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data BackendCommand

Constructors

Deployment DeploymentDetails

AgentRegistered AgentInformation

Instances

FromJSON BackendCommand

Defined in Cachix.API.WebSocketSubprotocol

Methods

parseJSON :: Value -> Parser BackendCommand

parseJSONList :: Value -> Parser [BackendCommand]

omittedField :: Maybe BackendCommand

ToJSON BackendCommand

Defined in Cachix.API.WebSocketSubprotocol

Methods

toJSON :: BackendCommand -> Value

toEncoding :: BackendCommand -> Encoding

toJSONList :: [BackendCommand] -> Value

toEncodingList :: [BackendCommand] -> Encoding

omitField :: BackendCommand -> Bool

Generic BackendCommand

Defined in Cachix.API.WebSocketSubprotocol

Associated Types

type Rep BackendCommand :: Type -> Type

Methods

from :: BackendCommand -> Rep BackendCommand x

to :: Rep BackendCommand x -> BackendCommand

Show BackendCommand

Defined in Cachix.API.WebSocketSubprotocol

Methods

showsPrec :: Int -> BackendCommand -> ShowS

show :: BackendCommand -> String

showList :: [BackendCommand] -> ShowS

Eq BackendCommand

Defined in Cachix.API.WebSocketSubprotocol

Methods

(==) :: BackendCommand -> BackendCommand -> Bool

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

type Rep BackendCommand

Defined in Cachix.API.WebSocketSubprotocol

type Rep BackendCommand = D1 ('MetaData "BackendCommand" "Cachix.API.WebSocketSubprotocol" "cachix-api-1.7.3-5QelKZioQAb5fZAnL6kOxB" 'False) (C1 ('MetaCons "Deployment" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DeploymentDetails)) :+: C1 ('MetaCons "AgentRegistered" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AgentInformation)))

data AgentCommand

Constructors

DeploymentStarted

Fields

• id :: UUID
• time :: UTCTime
• closureSize :: Maybe Int64

DeploymentFinished

Fields

• id :: UUID
• time :: UTCTime
• hasSucceeded :: Bool

Instances

FromJSON AgentCommand

Defined in Cachix.API.WebSocketSubprotocol

Methods

parseJSON :: Value -> Parser AgentCommand

parseJSONList :: Value -> Parser [AgentCommand]

omittedField :: Maybe AgentCommand

ToJSON AgentCommand

Defined in Cachix.API.WebSocketSubprotocol

Methods

toJSON :: AgentCommand -> Value

toEncoding :: AgentCommand -> Encoding

toJSONList :: [AgentCommand] -> Value

toEncodingList :: [AgentCommand] -> Encoding

omitField :: AgentCommand -> Bool

Generic AgentCommand

Defined in Cachix.API.WebSocketSubprotocol

Associated Types

type Rep AgentCommand :: Type -> Type

Methods

from :: AgentCommand -> Rep AgentCommand x

to :: Rep AgentCommand x -> AgentCommand

Show AgentCommand

Defined in Cachix.API.WebSocketSubprotocol

Methods

showsPrec :: Int -> AgentCommand -> ShowS

show :: AgentCommand -> String

showList :: [AgentCommand] -> ShowS

Eq AgentCommand

Defined in Cachix.API.WebSocketSubprotocol

Methods

(==) :: AgentCommand -> AgentCommand -> Bool

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

type Rep AgentCommand

Defined in Cachix.API.WebSocketSubprotocol

type Rep AgentCommand = D1 ('MetaData "AgentCommand" "Cachix.API.WebSocketSubprotocol" "cachix-api-1.7.3-5QelKZioQAb5fZAnL6kOxB" 'False) (C1 ('MetaCons "DeploymentStarted" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID) :*: (S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "closureSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int64)))) :+: C1 ('MetaCons "DeploymentFinished" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UUID) :*: (S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime) :*: S1 ('MetaSel ('Just "hasSucceeded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

parseMessage :: FromJSON cmd => ByteString -> Either Text (Message cmd)

sendMessage :: ToJSON cmd => Connection -> Message cmd -> IO ()

receiveDataConcurrently :: Connection -> (ByteString -> IO ()) -> IO ()

Receive and process messages in parallel.

Note: This will not rethrow the CloseRequest exception!

TODO: use Async.replicateConcurrently

data Log

Constructors

Log

Fields

• line :: Text
• time :: UTCTime

Instances

FromJSON Log

Defined in Cachix.API.WebSocketSubprotocol

Methods

parseJSON :: Value -> Parser Log

parseJSONList :: Value -> Parser [Log]

omittedField :: Maybe Log

ToJSON Log

Defined in Cachix.API.WebSocketSubprotocol

Methods

toJSON :: Log -> Value

toEncoding :: Log -> Encoding

toJSONList :: [Log] -> Value

toEncodingList :: [Log] -> Encoding

omitField :: Log -> Bool

Generic Log

Defined in Cachix.API.WebSocketSubprotocol

Associated Types

type Rep Log :: Type -> Type

Methods

from :: Log -> Rep Log x

to :: Rep Log x -> Log

Show Log

Defined in Cachix.API.WebSocketSubprotocol

Methods

showsPrec :: Int -> Log -> ShowS

show :: Log -> String

showList :: [Log] -> ShowS

type Rep Log

Defined in Cachix.API.WebSocketSubprotocol

type Rep Log = D1 ('MetaData "Log" "Cachix.API.WebSocketSubprotocol" "cachix-api-1.7.3-5QelKZioQAb5fZAnL6kOxB" 'False) (C1 ('MetaCons "Log" 'PrefixI 'True) (S1 ('MetaSel ('Just "line") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))