Safe Haskell	Safe-Inferred
Language	Haskell2010

Discord.Internal.Gateway.EventLoop

Description

Provides logic code for interacting with the Discord websocket gateway. Realistically, this is probably lower level than most people will need

Synopsis

data GatewayHandle = GatewayHandle {
}
newtype GatewayException = GatewayExceptionIntent Text
data LoopState
- = LoopStart
- | LoopClosed
- | LoopReconnect
data SendablesData = SendablesData {
}
connectionLoop :: Auth -> GatewayIntent -> GatewayHandle -> Chan Text -> IO ()
runEventLoop :: GatewayHandle -> SendablesData -> Chan Text -> IO LoopState
getPayloadTimeout :: SendablesData -> Chan Text -> IO (Either ConnectionException GatewayReceivable)
getPayload :: Connection -> Chan Text -> IO (Either ConnectionException GatewayReceivable)
heartbeat :: SendablesData -> IORef (UTCTime, UTCTime) -> IORef Integer -> IO ()
sendHeartbeat :: SendablesData -> IORef (UTCTime, UTCTime) -> Integer -> IO ()
sendableLoop :: Connection -> GatewayHandle -> SendablesData -> Chan Text -> IO ()
dupe :: a -> (a, a)

Documentation

data GatewayHandle Source #

Info the event processing loop needs to

Constructors

GatewayHandle

Fields

gatewayHandleEvents :: Chan (Either GatewayException EventInternalParse)
Realtime events from discord
gatewayHandleUserSendables :: Chan GatewaySendable
Events the user sends to discord
gatewayHandleLastStatus :: IORef (Maybe UpdateStatusOpts)
Recent set status (resent to discord on reconnect)
gatewayHandleLastSequenceId :: IORef Integer
Recent sent event sequence (used to reconnect)
gatewayHandleSessionId :: IORef Text
Which discord server session (used to reconnect)
gatewayHandleHostname :: IORef HostName
Which discord gateway to connect to. This should contain a default value ("gateway.discord.gg") on first connect, but on subsequent Resumes this may contain a different value. This should never contain trailing slashes, or any "wss://" prefixes, since HostNames of this kind are not supported by the websockets library.
gatewayHandleHeartbeatAckTimes :: IORef UTCTime
The last time a heartbeatack was received
gatewayHandleHeartbeatTimes :: IORef (UTCTime, UTCTime)
The last two times a heartbeat was sent

newtype GatewayException Source #

Ways the gateway connection can fail with no possibility of recovery.

Constructors

GatewayExceptionIntent Text

Instances

Instances details

Show GatewayException Source #
Instance details Defined in Discord.Internal.Gateway.EventLoop Methods showsPrec :: Int -> GatewayException -> ShowS # show :: GatewayException -> String # showList :: [GatewayException] -> ShowS #

data LoopState Source #

State of the eventloop

Constructors

LoopStart
LoopClosed
LoopReconnect

Instances

Instances details

Show LoopState Source #
Instance details Defined in Discord.Internal.Gateway.EventLoop Methods showsPrec :: Int -> LoopState -> ShowS # show :: LoopState -> String # showList :: [LoopState] -> ShowS #

data SendablesData Source #

Info the sendableLoop reads when it writes to the websocket

Constructors

SendablesData
Fields sendableConnection :: Connection librarySendables :: Chan GatewaySendableInternal startsendingUsers :: IORef Bool heartbeatInterval :: Integer

connectionLoop :: Auth -> GatewayIntent -> GatewayHandle -> Chan Text -> IO () Source #

Gateway connection infinite loop. Get events from websocket and send them to the library user

 Auth                                                         needed to connect
 GatewayIntent                                                needed to connect
 GatewayHandle (eventsGives,status,usersends,seq,sesh)        needed all over
 log :: Chan (T.Text)                                         needed all over

 sendableConnection                                 set by setup,  need sendableLoop
 librarySendables :: Chan (GatewaySendableInternal) set by setup,  need heartbeat
 heartbeatInterval :: Int                           set by Hello,  need heartbeat

 sequenceId :: Int id of last event received        set by Resume, need heartbeat and reconnect
 sessionId :: Text                                  set by Ready,  need reconnect

runEventLoop :: GatewayHandle -> SendablesData -> Chan Text -> IO LoopState Source #

Process events from discord and write them to the onDiscordEvent Channel

getPayloadTimeout :: SendablesData -> Chan Text -> IO (Either ConnectionException GatewayReceivable) Source #

Blocking wait for next payload from the websocket (returns Reconnect after 1.5*heartbeatInterval seconds)

getPayload :: Connection -> Chan Text -> IO (Either ConnectionException GatewayReceivable) Source #

Blocking wait for next payload from the websocket

heartbeat :: SendablesData -> IORef (UTCTime, UTCTime) -> IORef Integer -> IO () Source #

Infinite loop to send heartbeats to the chan

sendHeartbeat :: SendablesData -> IORef (UTCTime, UTCTime) -> Integer -> IO () Source #

sendableLoop :: Connection -> GatewayHandle -> SendablesData -> Chan Text -> IO () Source #

Infinite loop to send library/user events to discord with the actual websocket connection

dupe :: a -> (a, a) Source #