Safe Haskell	None
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 (Either (Cache, GatewayException) Cache)
}
data GatewayException = GatewayExceptionIntent Text
data Cache = Cache {
- cacheCurrentUser :: User
- cacheDMChannels :: Map ChannelId Channel
- cacheGuilds :: Map GuildId Guild
- cacheChannels :: Map ChannelId Channel
- cacheApplication :: PartialApplication
}
startCacheThread :: 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)

data CacheHandle Source #

Constructors

CacheHandle
Fields cacheHandleEvents :: Chan (Either GatewayException EventInternalParse) cacheHandleCache :: MVar (Either (Cache, GatewayException) Cache)

data 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 #

Constructors

Cache
Fields cacheCurrentUser :: User cacheDMChannels :: Map ChannelId Channel cacheGuilds :: Map GuildId Guild cacheChannels :: Map ChannelId Channel cacheApplication :: PartialApplication

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 #

startCacheThread :: 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

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

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

Eq EventInternalParse Source #
Instance details Defined in Discord.Internal.Types.Events Methods (==) :: EventInternalParse -> EventInternalParse -> Bool # (/=) :: EventInternalParse -> EventInternalParse -> Bool #
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 #

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

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