Copyright	(c) 2017 Michael Walker
License	MIT
Maintainer	Michael Walker <mike@barrucadu.co.uk>
Stability	experimental
Portability	FlexibleInstances, GADTs, GeneralizedNewtypeDeriving, MultiParamTypeClasses
Safe Haskell	None
Language	Haskell2010

Network.IRC.Client.Internal.Types

Contents

The IRC monad
State
Events
Exceptions

Description

Internal types. Most of these are re-exported elsewhere as lenses.

This module is NOT considered to form part of the public interface of this library.

Synopsis

newtype IRC s a = IRC {
- runIRC :: ReaderT (IRCState s) IO a
}
data IRCState s = IRCState {
- _connectionConfig :: ConnectionConfig s
- _userState :: TVar s
- _instanceConfig :: TVar (InstanceConfig s)
- _sendqueue :: TVar (TBMChan (Message ByteString))
- _connectionState :: TVar ConnectionState
- _runningThreads :: TVar (Set ThreadId)
}
data ConnectionConfig s = ConnectionConfig {
- _func :: IO () -> ConduitM (Either ByteString (Event ByteString)) Void IO () -> ConduitM () (Message ByteString) IO () -> IO ()
- _server :: ByteString
- _port :: Int
- _username :: Text
- _realname :: Text
- _password :: Maybe Text
- _flood :: NominalDiffTime
- _timeout :: NominalDiffTime
- _onconnect :: IRC s ()
- _ondisconnect :: Maybe SomeException -> IRC s ()
- _logfunc :: Origin -> ByteString -> IO ()
}
data InstanceConfig s = InstanceConfig {
- _nick :: Text
- _channels :: [Text]
- _version :: Text
- _handlers :: [EventHandler s]
- _ignore :: [(Text, Maybe Text)]
}
data ConnectionState
- = Connected
- | Disconnecting
- | Disconnected
data Origin
- = FromServer
- | FromClient
data EventHandler s where
- EventHandler :: (Event Text -> Maybe b) -> (Source Text -> b -> IRC s ()) -> EventHandler s
data Timeout = Timeout
data Disconnect = Disconnect

The IRC monad

newtype IRC s a Source #

The IRC monad.

Constructors

IRC
Fields runIRC :: ReaderT (IRCState s) IO a

Instances

MonadState s (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods get :: IRC s s # put :: s -> IRC s () # state :: (s -> (a, s)) -> IRC s a #
Monad (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods (>>=) :: IRC s a -> (a -> IRC s b) -> IRC s b # (>>) :: IRC s a -> IRC s b -> IRC s b # return :: a -> IRC s a # fail :: String -> IRC s a #
Functor (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods fmap :: (a -> b) -> IRC s a -> IRC s b # (<$) :: a -> IRC s b -> IRC s a #
Applicative (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods pure :: a -> IRC s a # (<>) :: IRC s (a -> b) -> IRC s a -> IRC s b # liftA2 :: (a -> b -> c) -> IRC s a -> IRC s b -> IRC s c # (>) :: IRC s a -> IRC s b -> IRC s b # (<*) :: IRC s a -> IRC s b -> IRC s a #
Alternative (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods empty :: IRC s a # (<\|>) :: IRC s a -> IRC s a -> IRC s a # some :: IRC s a -> IRC s [a] # many :: IRC s a -> IRC s [a] #
MonadPlus (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods mzero :: IRC s a # mplus :: IRC s a -> IRC s a -> IRC s a #
MonadIO (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods liftIO :: IO a -> IRC s a #
MonadThrow (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods throwM :: Exception e => e -> IRC s a #
MonadCatch (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods catch :: Exception e => IRC s a -> (e -> IRC s a) -> IRC s a #
MonadMask (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods mask :: ((forall a. IRC s a -> IRC s a) -> IRC s b) -> IRC s b # uninterruptibleMask :: ((forall a. IRC s a -> IRC s a) -> IRC s b) -> IRC s b # generalBracket :: IRC s a -> (a -> ExitCase b -> IRC s c) -> (a -> IRC s b) -> IRC s (b, c) #
MonadReader (IRCState s) (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods ask :: IRC s (IRCState s) # local :: (IRCState s -> IRCState s) -> IRC s a -> IRC s a # reader :: (IRCState s -> a) -> IRC s a #

State

data IRCState s Source #

The state of an IRC session.

Constructors

IRCState

Fields

_connectionConfig :: ConnectionConfig s
Read-only connection configuration
_userState :: TVar s
Mutable user state
_instanceConfig :: TVar (InstanceConfig s)
Mutable instance configuration in STM
_sendqueue :: TVar (TBMChan (Message ByteString))
Message send queue.
_connectionState :: TVar ConnectionState
State of the connection.
_runningThreads :: TVar (Set ThreadId)
Threads which will be killed when the client disconnects.

Instances

MonadReader (IRCState s) (IRC s) Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods ask :: IRC s (IRCState s) # local :: (IRCState s -> IRCState s) -> IRC s a -> IRC s a # reader :: (IRCState s -> a) -> IRC s a #

data ConnectionConfig s Source #

The static state of an IRC server connection.

Constructors

ConnectionConfig

Fields

_func :: IO () -> ConduitM (Either ByteString (Event ByteString)) Void IO () -> ConduitM () (Message ByteString) IO () -> IO ()
Function to connect and start the conduits.
_server :: ByteString
The server host.
_port :: Int
The server port.
_username :: Text
Client username; sent to the server during the initial set-up.
_realname :: Text
Client realname; sent to the server during the initial set-up.
_password :: Maybe Text
Client password; sent to the server during the initial set-up.
_flood :: NominalDiffTime
The minimum time between two adjacent messages.
_timeout :: NominalDiffTime
The maximum time between received messages from the server. If no messages arrive from the server for this period, the client is sent a Timeout exception and disconnects.
_onconnect :: IRC s ()
Action to run after sending the PASS and USER commands to the server. The default behaviour is to send the NICK command.
_ondisconnect :: Maybe SomeException -> IRC s ()
Action to run after disconnecting from the server, both by local choice and by losing the connection. This is run after tearing down the connection. If the connection terminated due to an exception, it is given. The default behaviour is to reconnect if a timeout, otherwise rethrow any exception.
_logfunc :: Origin -> ByteString -> IO ()
Function to log messages sent to and received from the server.

data InstanceConfig s Source #

The updateable state of an IRC connection.

Constructors

InstanceConfig

Fields

_nick :: Text
Client nick
_channels :: [Text]
Current channels: this list both determines the channels to join on connect, and is modified by the default event handlers when channels are joined or parted.
_version :: Text
The version is sent in response to the CTCP "VERSION" request by the default event handlers.
_handlers :: [EventHandler s]
The registered event handlers. The order in this list is the order in which they are executed.
_ignore :: [(Text, Maybe Text)]
List of nicks (optionally restricted to channels) to ignore messages from. Nothing ignores globally.

data ConnectionState Source #

The state of the connection.

Constructors

Connected
Disconnecting
Disconnected

Instances

Bounded ConnectionState Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods minBound :: ConnectionState # maxBound :: ConnectionState #
Enum ConnectionState Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods succ :: ConnectionState -> ConnectionState # pred :: ConnectionState -> ConnectionState # toEnum :: Int -> ConnectionState # fromEnum :: ConnectionState -> Int # enumFrom :: ConnectionState -> [ConnectionState] # enumFromThen :: ConnectionState -> ConnectionState -> [ConnectionState] # enumFromTo :: ConnectionState -> ConnectionState -> [ConnectionState] # enumFromThenTo :: ConnectionState -> ConnectionState -> ConnectionState -> [ConnectionState] #
Eq ConnectionState Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods (==) :: ConnectionState -> ConnectionState -> Bool # (/=) :: ConnectionState -> ConnectionState -> Bool #
Ord ConnectionState Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods compare :: ConnectionState -> ConnectionState -> Ordering # (<) :: ConnectionState -> ConnectionState -> Bool # (<=) :: ConnectionState -> ConnectionState -> Bool # (>) :: ConnectionState -> ConnectionState -> Bool # (>=) :: ConnectionState -> ConnectionState -> Bool # max :: ConnectionState -> ConnectionState -> ConnectionState # min :: ConnectionState -> ConnectionState -> ConnectionState #
Read ConnectionState Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods readsPrec :: Int -> ReadS ConnectionState # readList :: ReadS [ConnectionState] # readPrec :: ReadPrec ConnectionState # readListPrec :: ReadPrec [ConnectionState] #
Show ConnectionState Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods showsPrec :: Int -> ConnectionState -> ShowS # show :: ConnectionState -> String # showList :: [ConnectionState] -> ShowS #

data Origin Source #

The origin of a message.

Constructors

FromServer
FromClient

Instances

Bounded Origin Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods minBound :: Origin # maxBound :: Origin #
Enum Origin Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods succ :: Origin -> Origin # pred :: Origin -> Origin # toEnum :: Int -> Origin # fromEnum :: Origin -> Int # enumFrom :: Origin -> [Origin] # enumFromThen :: Origin -> Origin -> [Origin] # enumFromTo :: Origin -> Origin -> [Origin] # enumFromThenTo :: Origin -> Origin -> Origin -> [Origin] #
Eq Origin Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods (==) :: Origin -> Origin -> Bool # (/=) :: Origin -> Origin -> Bool #
Ord Origin Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods compare :: Origin -> Origin -> Ordering # (<) :: Origin -> Origin -> Bool # (<=) :: Origin -> Origin -> Bool # (>) :: Origin -> Origin -> Bool # (>=) :: Origin -> Origin -> Bool # max :: Origin -> Origin -> Origin # min :: Origin -> Origin -> Origin #
Read Origin Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods readsPrec :: Int -> ReadS Origin # readList :: ReadS [Origin] # readPrec :: ReadPrec Origin # readListPrec :: ReadPrec [Origin] #
Show Origin Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods showsPrec :: Int -> Origin -> ShowS # show :: Origin -> String # showList :: [Origin] -> ShowS #

Events

data EventHandler s where Source #

A function which handles an event.

Constructors

EventHandler :: (Event Text -> Maybe b) -> (Source Text -> b -> IRC s ()) -> EventHandler s

Exceptions

data Timeout Source #

Exception thrown to kill the client if the timeout elapses with nothing received from the server.

Constructors

Timeout

Instances

Bounded Timeout Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods minBound :: Timeout # maxBound :: Timeout #
Enum Timeout Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods succ :: Timeout -> Timeout # pred :: Timeout -> Timeout # toEnum :: Int -> Timeout # fromEnum :: Timeout -> Int # enumFrom :: Timeout -> [Timeout] # enumFromThen :: Timeout -> Timeout -> [Timeout] # enumFromTo :: Timeout -> Timeout -> [Timeout] # enumFromThenTo :: Timeout -> Timeout -> Timeout -> [Timeout] #
Eq Timeout Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods (==) :: Timeout -> Timeout -> Bool # (/=) :: Timeout -> Timeout -> Bool #
Ord Timeout Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods compare :: Timeout -> Timeout -> Ordering # (<) :: Timeout -> Timeout -> Bool # (<=) :: Timeout -> Timeout -> Bool # (>) :: Timeout -> Timeout -> Bool # (>=) :: Timeout -> Timeout -> Bool # max :: Timeout -> Timeout -> Timeout # min :: Timeout -> Timeout -> Timeout #
Read Timeout Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods readsPrec :: Int -> ReadS Timeout # readList :: ReadS [Timeout] # readPrec :: ReadPrec Timeout # readListPrec :: ReadPrec [Timeout] #
Show Timeout Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods showsPrec :: Int -> Timeout -> ShowS # show :: Timeout -> String # showList :: [Timeout] -> ShowS #
Exception Timeout Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods toException :: Timeout -> SomeException # fromException :: SomeException -> Maybe Timeout # displayException :: Timeout -> String #

data Disconnect Source #

Exception thrown to all managed threads when the client disconnects.

Constructors

Disconnect

Instances

Bounded Disconnect Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods minBound :: Disconnect # maxBound :: Disconnect #
Enum Disconnect Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods succ :: Disconnect -> Disconnect # pred :: Disconnect -> Disconnect # toEnum :: Int -> Disconnect # fromEnum :: Disconnect -> Int # enumFrom :: Disconnect -> [Disconnect] # enumFromThen :: Disconnect -> Disconnect -> [Disconnect] # enumFromTo :: Disconnect -> Disconnect -> [Disconnect] # enumFromThenTo :: Disconnect -> Disconnect -> Disconnect -> [Disconnect] #
Eq Disconnect Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods (==) :: Disconnect -> Disconnect -> Bool # (/=) :: Disconnect -> Disconnect -> Bool #
Ord Disconnect Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods compare :: Disconnect -> Disconnect -> Ordering # (<) :: Disconnect -> Disconnect -> Bool # (<=) :: Disconnect -> Disconnect -> Bool # (>) :: Disconnect -> Disconnect -> Bool # (>=) :: Disconnect -> Disconnect -> Bool # max :: Disconnect -> Disconnect -> Disconnect # min :: Disconnect -> Disconnect -> Disconnect #
Read Disconnect Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods readsPrec :: Int -> ReadS Disconnect # readList :: ReadS [Disconnect] # readPrec :: ReadPrec Disconnect # readListPrec :: ReadPrec [Disconnect] #
Show Disconnect Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods showsPrec :: Int -> Disconnect -> ShowS # show :: Disconnect -> String # showList :: [Disconnect] -> ShowS #
Exception Disconnect Source #
Instance details Defined in Network.IRC.Client.Internal.Types Methods toException :: Disconnect -> SomeException # fromException :: SomeException -> Maybe Disconnect # displayException :: Disconnect -> String #