Safe Haskell	None
Language	Haskell2010

Hasura.GraphQL.Transport.WebSocket.Protocol

Description

This file contains types for both the websocket protocols (Apollo) and (graphql-ws) | See Apollo: https://github.com/apollographql/subscriptions-transport-ws/blob/master/PROTOCOL.md | See graphql-ws: https://github.com/enisdenjo/graphql-ws/blob/master/PROTOCOL.md

Synopsis

data WSSubProtocol
- = Apollo
- | GraphQLWS
showSubProtocol :: WSSubProtocol -> String
toWSSubProtocol :: String -> WSSubProtocol
newtype OperationId = OperationId {
- unOperationId :: Text
}
unsafeMkOperationId :: Text -> OperationId
data ServerMsgType
- = SMT_GQL_CONNECTION_KEEP_ALIVE
- | SMT_GQL_CONNECTION_ERROR
- | SMT_GQL_DATA
- | SMT_GQL_NEXT
- | SMT_GQL_PING
- | SMT_GQL_PONG
- | SMT_GQL_CONNECTION_ACK
- | SMT_GQL_ERROR
- | SMT_GQL_COMPLETE
data ConnParams = ConnParams {
- _cpHeaders :: Maybe (HashMap Text Text)
}
data StartMsg = StartMsg {
- _smId :: !OperationId
- _smPayload :: !GQLReqUnparsed
}
data StopMsg = StopMsg {
- _stId :: OperationId
}
data PingPongPayload = PingPongPayload {
- _smMessage :: !(Maybe Text)
}
keepAliveMessage :: PingPongPayload
data SubscribeMsg = SubscribeMsg {
- _subId :: !OperationId
- _subPayload :: !GQLReqUnparsed
}
data ClientMsg
- = CMConnInit !(Maybe ConnParams)
- | CMStart !StartMsg
- | CMStop !StopMsg
- | CMConnTerm
- | CMPing !(Maybe PingPongPayload)
- | CMPong !(Maybe PingPongPayload)
data DataMsg = DataMsg {
- _dmId :: !OperationId
- _dmPayload :: !GQResponse
}
data ErrorMsg = ErrorMsg {
- _emId :: !OperationId
- _emPayload :: !Value
}
newtype CompletionMsg = CompletionMsg {
- unCompletionMsg :: OperationId
}
newtype ConnErrMsg = ConnErrMsg {
- unConnErrMsg :: Text
}
data ServerErrorMsg = ServerErrorMsg {
- unServerErrorMsg :: Text
}
data ServerMsg
- = SMConnAck
- | SMConnKeepAlive
- | SMConnErr !ConnErrMsg
- | SMData !DataMsg
- | SMErr !ErrorMsg
- | SMComplete !CompletionMsg
- | SMNext !DataMsg
- | SMPing !(Maybe PingPongPayload)
- | SMPong !(Maybe PingPongPayload)
data ServerErrorCode
- = ProtocolError1002
- | GenericError4400 !String
- | Unauthorized4401
- | Forbidden4403
- | ConnectionInitTimeout4408
- | NonUniqueSubscription4409 !OperationId
- | TooManyRequests4429
encodeServerErrorMsg :: ServerErrorCode -> ByteString
encodeServerMsg :: ServerMsg -> ByteString
data WSConnInitTimerStatus
- = Running
- | Done
type WSConnInitTimer = (TVar WSConnInitTimerStatus, TMVar ())
getWSTimerState :: WSConnInitTimer -> IO WSConnInitTimerStatus
getNewWSTimer :: Seconds -> IO WSConnInitTimer

Documentation

data WSSubProtocol Source #

Constructors

Apollo
GraphQLWS

Instances

Instances details

Eq WSSubProtocol Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: WSSubProtocol -> WSSubProtocol -> Bool # (/=) :: WSSubProtocol -> WSSubProtocol -> Bool #
Show WSSubProtocol Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> WSSubProtocol -> ShowS # show :: WSSubProtocol -> String # showList :: [WSSubProtocol] -> ShowS #

showSubProtocol :: WSSubProtocol -> String Source #

toWSSubProtocol :: String -> WSSubProtocol Source #

newtype OperationId Source #

Constructors

OperationId
Fields unOperationId :: Text

Instances

Instances details

Eq OperationId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: OperationId -> OperationId -> Bool # (/=) :: OperationId -> OperationId -> Bool #
Show OperationId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> OperationId -> ShowS # show :: OperationId -> String # showList :: [OperationId] -> ShowS #
IsString OperationId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods fromString :: String -> OperationId #
Hashable OperationId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods hashWithSalt :: Int -> OperationId -> Int hash :: OperationId -> Int
FromJSON OperationId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods parseJSON :: Value -> Parser OperationId parseJSONList :: Value -> Parser [OperationId]
ToJSON OperationId Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods toJSON :: OperationId -> Value toEncoding :: OperationId -> Encoding toJSONList :: [OperationId] -> Value toEncodingList :: [OperationId] -> Encoding

unsafeMkOperationId :: Text -> OperationId Source #

data ServerMsgType Source #

Constructors

SMT_GQL_CONNECTION_KEEP_ALIVE
SMT_GQL_CONNECTION_ERROR
SMT_GQL_DATA
SMT_GQL_NEXT
SMT_GQL_PING
SMT_GQL_PONG
SMT_GQL_CONNECTION_ACK
SMT_GQL_ERROR
SMT_GQL_COMPLETE

Instances

Instances details

Eq ServerMsgType Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: ServerMsgType -> ServerMsgType -> Bool # (/=) :: ServerMsgType -> ServerMsgType -> Bool #
Show ServerMsgType Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> ServerMsgType -> ShowS # show :: ServerMsgType -> String # showList :: [ServerMsgType] -> ShowS #
ToJSON ServerMsgType Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods toJSON :: ServerMsgType -> Value toEncoding :: ServerMsgType -> Encoding toJSONList :: [ServerMsgType] -> Value toEncodingList :: [ServerMsgType] -> Encoding

data ConnParams Source #

Constructors

ConnParams
Fields _cpHeaders :: Maybe (HashMap Text Text)

Instances

Instances details

Eq ConnParams Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: ConnParams -> ConnParams -> Bool # (/=) :: ConnParams -> ConnParams -> Bool #
Show ConnParams Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> ConnParams -> ShowS # show :: ConnParams -> String # showList :: [ConnParams] -> ShowS #
FromJSON ConnParams Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods parseJSON :: Value -> Parser ConnParams parseJSONList :: Value -> Parser [ConnParams]
ToJSON ConnParams Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods toJSON :: ConnParams -> Value toEncoding :: ConnParams -> Encoding toJSONList :: [ConnParams] -> Value toEncodingList :: [ConnParams] -> Encoding

data StartMsg Source #

Constructors

StartMsg
Fields _smId :: !OperationId _smPayload :: !GQLReqUnparsed

Instances

Instances details

Eq StartMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: StartMsg -> StartMsg -> Bool # (/=) :: StartMsg -> StartMsg -> Bool #
Show StartMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> StartMsg -> ShowS # show :: StartMsg -> String # showList :: [StartMsg] -> ShowS #
FromJSON StartMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods parseJSON :: Value -> Parser StartMsg parseJSONList :: Value -> Parser [StartMsg]
ToJSON StartMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods toJSON :: StartMsg -> Value toEncoding :: StartMsg -> Encoding toJSONList :: [StartMsg] -> Value toEncodingList :: [StartMsg] -> Encoding

data StopMsg Source #

Constructors

StopMsg
Fields _stId :: OperationId

Instances

Instances details

Eq StopMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: StopMsg -> StopMsg -> Bool # (/=) :: StopMsg -> StopMsg -> Bool #
Show StopMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> StopMsg -> ShowS # show :: StopMsg -> String # showList :: [StopMsg] -> ShowS #
FromJSON StopMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods parseJSON :: Value -> Parser StopMsg parseJSONList :: Value -> Parser [StopMsg]
ToJSON StopMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods toJSON :: StopMsg -> Value toEncoding :: StopMsg -> Encoding toJSONList :: [StopMsg] -> Value toEncodingList :: [StopMsg] -> Encoding

data PingPongPayload Source #

Constructors

PingPongPayload
Fields _smMessage :: !(Maybe Text)

Instances

Instances details

Eq PingPongPayload Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: PingPongPayload -> PingPongPayload -> Bool # (/=) :: PingPongPayload -> PingPongPayload -> Bool #
Show PingPongPayload Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> PingPongPayload -> ShowS # show :: PingPongPayload -> String # showList :: [PingPongPayload] -> ShowS #
FromJSON PingPongPayload Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods parseJSON :: Value -> Parser PingPongPayload parseJSONList :: Value -> Parser [PingPongPayload]
ToJSON PingPongPayload Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods toJSON :: PingPongPayload -> Value toEncoding :: PingPongPayload -> Encoding toJSONList :: [PingPongPayload] -> Value toEncodingList :: [PingPongPayload] -> Encoding

keepAliveMessage :: PingPongPayload Source #

data SubscribeMsg Source #

Constructors

SubscribeMsg
Fields _subId :: !OperationId _subPayload :: !GQLReqUnparsed

data ClientMsg Source #

Constructors

CMConnInit !(Maybe ConnParams)
CMStart !StartMsg
CMStop !StopMsg
CMConnTerm
CMPing !(Maybe PingPongPayload)
CMPong !(Maybe PingPongPayload)

Instances

Instances details

Eq ClientMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: ClientMsg -> ClientMsg -> Bool # (/=) :: ClientMsg -> ClientMsg -> Bool #
Show ClientMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> ClientMsg -> ShowS # show :: ClientMsg -> String # showList :: [ClientMsg] -> ShowS #
FromJSON ClientMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods parseJSON :: Value -> Parser ClientMsg parseJSONList :: Value -> Parser [ClientMsg]

data DataMsg Source #

Constructors

DataMsg
Fields _dmId :: !OperationId _dmPayload :: !GQResponse

data ErrorMsg Source #

Constructors

ErrorMsg
Fields _emId :: !OperationId _emPayload :: !Value

Instances

Instances details

Eq ErrorMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: ErrorMsg -> ErrorMsg -> Bool # (/=) :: ErrorMsg -> ErrorMsg -> Bool #
Show ErrorMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> ErrorMsg -> ShowS # show :: ErrorMsg -> String # showList :: [ErrorMsg] -> ShowS #

newtype CompletionMsg Source #

Constructors

CompletionMsg
Fields unCompletionMsg :: OperationId

Instances

Instances details

Eq CompletionMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: CompletionMsg -> CompletionMsg -> Bool # (/=) :: CompletionMsg -> CompletionMsg -> Bool #
Show CompletionMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> CompletionMsg -> ShowS # show :: CompletionMsg -> String # showList :: [CompletionMsg] -> ShowS #
FromJSON CompletionMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods parseJSON :: Value -> Parser CompletionMsg parseJSONList :: Value -> Parser [CompletionMsg]
ToJSON CompletionMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods toJSON :: CompletionMsg -> Value toEncoding :: CompletionMsg -> Encoding toJSONList :: [CompletionMsg] -> Value toEncodingList :: [CompletionMsg] -> Encoding

newtype ConnErrMsg Source #

Constructors

ConnErrMsg
Fields unConnErrMsg :: Text

Instances

Instances details

Eq ConnErrMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: ConnErrMsg -> ConnErrMsg -> Bool # (/=) :: ConnErrMsg -> ConnErrMsg -> Bool #
Show ConnErrMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> ConnErrMsg -> ShowS # show :: ConnErrMsg -> String # showList :: [ConnErrMsg] -> ShowS #
IsString ConnErrMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods fromString :: String -> ConnErrMsg #
FromJSON ConnErrMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods parseJSON :: Value -> Parser ConnErrMsg parseJSONList :: Value -> Parser [ConnErrMsg]
ToJSON ConnErrMsg Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods toJSON :: ConnErrMsg -> Value toEncoding :: ConnErrMsg -> Encoding toJSONList :: [ConnErrMsg] -> Value toEncodingList :: [ConnErrMsg] -> Encoding

data ServerErrorMsg Source #

Constructors

ServerErrorMsg
Fields unServerErrorMsg :: Text

data ServerMsg Source #

Constructors

SMConnAck
SMConnKeepAlive
SMConnErr !ConnErrMsg
SMData !DataMsg
SMErr !ErrorMsg
SMComplete !CompletionMsg
SMNext !DataMsg
SMPing !(Maybe PingPongPayload)
SMPong !(Maybe PingPongPayload)

data ServerErrorCode Source #

This is sent from the server to the client while closing the websocket on encountering an error.

Constructors

ProtocolError1002
GenericError4400 !String
Unauthorized4401
Forbidden4403
ConnectionInitTimeout4408
NonUniqueSubscription4409 !OperationId
TooManyRequests4429

Instances

Instances details

Show ServerErrorCode Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> ServerErrorCode -> ShowS # show :: ServerErrorCode -> String # showList :: [ServerErrorCode] -> ShowS #

encodeServerErrorMsg :: ServerErrorCode -> ByteString Source #

encodeServerMsg :: ServerMsg -> ByteString Source #

data WSConnInitTimerStatus Source #

Constructors

Running
Done

Instances

Instances details

Eq WSConnInitTimerStatus Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods (==) :: WSConnInitTimerStatus -> WSConnInitTimerStatus -> Bool # (/=) :: WSConnInitTimerStatus -> WSConnInitTimerStatus -> Bool #
Show WSConnInitTimerStatus Source #
Instance details Defined in Hasura.GraphQL.Transport.WebSocket.Protocol Methods showsPrec :: Int -> WSConnInitTimerStatus -> ShowS # show :: WSConnInitTimerStatus -> String # showList :: [WSConnInitTimerStatus] -> ShowS #

type WSConnInitTimer = (TVar WSConnInitTimerStatus, TMVar ()) Source #

getWSTimerState :: WSConnInitTimer -> IO WSConnInitTimerStatus Source #

getNewWSTimer :: Seconds -> IO WSConnInitTimer Source #