Safe Haskell	Safe-Inferred
Language	Haskell2010

Discord.Internal.Gateway

Description

Provides a rather raw interface to the websocket events through a real-time Chan

Synopsis

data GatewayHandle = GatewayHandle {
}
data CacheHandle = CacheHandle {
- cacheHandleEvents :: Chan (Either GatewayException EventInternalParse)
- cacheHandleCache :: MVar Cache
}
newtype GatewayException = GatewayExceptionIntent Text
data Cache = Cache {
- cacheCurrentUser :: !User
- cacheDMChannels :: !(Map ChannelId Channel)
- cacheGuilds :: !(Map GuildId (Maybe (Guild, Maybe GuildCreateData)))
- cacheChannels :: !(Map ChannelId Channel)
- cacheApplication :: !FullApplication
}
initializeCache :: User -> FullApplication -> CacheHandle -> IO ()
startCacheThread :: Bool -> Chan Text -> IO (CacheHandle, ThreadId)
startGatewayThread :: Auth -> GatewayIntent -> CacheHandle -> Chan Text -> IO (GatewayHandle, ThreadId)
data Auth
data EventInternalParse
data GatewayIntent

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

data CacheHandle Source #

Internal handle for cacheLoop to manage the cache

Constructors

CacheHandle
Fields cacheHandleEvents :: Chan (Either GatewayException EventInternalParse) Read gateway events cacheHandleCache :: MVar Cache Current cache.

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 Cache Source #

Cached data from gateway. Set RunDiscordOpts.discordEnableCache=true to enable all the fields

Constructors

Cache
Fields cacheCurrentUser :: !User Filled before onStart handler cacheDMChannels :: !(Map ChannelId Channel) Filled over time cacheGuilds :: !(Map GuildId (Maybe (Guild, Maybe GuildCreateData))) Filled over time cacheChannels :: !(Map ChannelId Channel) Filled over time cacheApplication :: !FullApplication Filled before onStart handler

Instances

Instances details

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

initializeCache :: User -> FullApplication -> CacheHandle -> IO () Source #

Internally used to setup the first cache

startCacheThread :: Bool -> Chan Text -> IO (CacheHandle, ThreadId) Source #

Starts a thread for the cache

startGatewayThread :: Auth -> GatewayIntent -> CacheHandle -> Chan Text -> IO (GatewayHandle, ThreadId) Source #

Create a Chan for websockets. This creates a thread that writes all the received EventsInternalParse to the Chan

data Auth Source #

Authorization token for the Discord API

Instances

Instances details

Read Auth Source #
Instance details Defined in Discord.Internal.Types.Prelude Methods readsPrec :: Int -> ReadS Auth # readList :: ReadS [Auth] # readPrec :: ReadPrec Auth # readListPrec :: ReadPrec [Auth] #
Show Auth Source #
Instance details Defined in Discord.Internal.Types.Prelude Methods showsPrec :: Int -> Auth -> ShowS # show :: Auth -> String # showList :: [Auth] -> ShowS #
Eq Auth Source #
Instance details Defined in Discord.Internal.Types.Prelude Methods (==) :: Auth -> Auth -> Bool # (/=) :: Auth -> Auth -> Bool #
Ord Auth Source #
Instance details Defined in Discord.Internal.Types.Prelude Methods compare :: Auth -> Auth -> Ordering # (<) :: Auth -> Auth -> Bool # (<=) :: Auth -> Auth -> Bool # (>) :: Auth -> Auth -> Bool # (>=) :: Auth -> Auth -> Bool # max :: Auth -> Auth -> Auth # min :: Auth -> Auth -> Auth #

data EventInternalParse Source #

Internal Event representation. Each matches to the corresponding constructor of Event.

An application should never have to use those directly

Instances

Instances details

Read EventInternalParse Source #
Instance details Defined in Discord.Internal.Types.Events Methods readsPrec :: Int -> ReadS EventInternalParse # readList :: ReadS [EventInternalParse] # readPrec :: ReadPrec EventInternalParse # readListPrec :: ReadPrec [EventInternalParse] #
Show EventInternalParse Source #
Instance details Defined in Discord.Internal.Types.Events Methods showsPrec :: Int -> EventInternalParse -> ShowS # show :: EventInternalParse -> String # showList :: [EventInternalParse] -> ShowS #
Eq EventInternalParse Source #
Instance details Defined in Discord.Internal.Types.Events Methods (==) :: EventInternalParse -> EventInternalParse -> Bool # (/=) :: EventInternalParse -> EventInternalParse -> Bool #

data GatewayIntent Source #

Gateway intents to subrscribe to

Details of which intent englobs what data is avalilable at the official Discord documentation

Instances

Instances details

Read GatewayIntent Source #
Instance details Defined in Discord.Internal.Types.Gateway Methods readsPrec :: Int -> ReadS GatewayIntent # readList :: ReadS [GatewayIntent] # readPrec :: ReadPrec GatewayIntent # readListPrec :: ReadPrec [GatewayIntent] #
Show GatewayIntent Source #
Instance details Defined in Discord.Internal.Types.Gateway Methods showsPrec :: Int -> GatewayIntent -> ShowS # show :: GatewayIntent -> String # showList :: [GatewayIntent] -> ShowS #
Default GatewayIntent Source #
Instance details Defined in Discord.Internal.Types.Gateway Methods def :: GatewayIntent #
Eq GatewayIntent Source #
Instance details Defined in Discord.Internal.Types.Gateway Methods (==) :: GatewayIntent -> GatewayIntent -> Bool # (/=) :: GatewayIntent -> GatewayIntent -> Bool #
Ord GatewayIntent Source #
Instance details Defined in Discord.Internal.Types.Gateway Methods compare :: GatewayIntent -> GatewayIntent -> Ordering # (<) :: GatewayIntent -> GatewayIntent -> Bool # (<=) :: GatewayIntent -> GatewayIntent -> Bool # (>) :: GatewayIntent -> GatewayIntent -> Bool # (>=) :: GatewayIntent -> GatewayIntent -> Bool # max :: GatewayIntent -> GatewayIntent -> GatewayIntent # min :: GatewayIntent -> GatewayIntent -> GatewayIntent #