Network.IRC.Client.Types

Types for IRC clients. See also Network.IRC.Conduit and Network.IRC.CTCP.

Type synonyms

type UnicodeEvent = Event Text

type UnicodeSource = Source Text

type UnicodeMessage = Message Text

State

type IRC a = StatefulIRC () a

The IRC monad.

type StatefulIRC s a = ReaderT (IRCState s) IO a

The IRC monad, with state.

data IRCState s

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

• _connState :: TVar ConnectionState

  State of the connection.

data ConnectionState

The state of the connection.

Constructors

Connected

Disconnecting

Disconnected

Instances

Bounded ConnectionState

Methods

minBound :: ConnectionState

maxBound :: ConnectionState

Enum ConnectionState

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

Methods

(==) :: ConnectionState -> ConnectionState -> Bool

(/=) :: ConnectionState -> ConnectionState -> Bool

Ord ConnectionState

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

Methods

readsPrec :: Int -> ReadS ConnectionState

readList :: ReadS [ConnectionState]

readPrec :: ReadPrec ConnectionState

readListPrec :: ReadPrec [ConnectionState]

Show ConnectionState

Methods

showsPrec :: Int -> ConnectionState -> ShowS

show :: ConnectionState -> String

showList :: [ConnectionState] -> ShowS

newIRCState :: MonadIO m => ConnectionConfig s -> InstanceConfig s -> s -> m (IRCState s)

Construct a new IRC state

ircState :: StatefulIRC s (IRCState s)

Access the client state.

getConnectionConfig :: IRCState s -> ConnectionConfig s

Extract the connection configuration from an IRC state

getInstanceConfig :: IRCState s -> TVar (InstanceConfig s)

Extract the instance configuration from an IRC state

getUserState :: IRCState s -> TVar s

Extract the user state from an IRC state

getConnState :: MonadIO m => IRCState s -> m ConnectionState

Extract the connection state from an IRC state.

getInstanceConfig' :: MonadIO m => IRCState s -> m (InstanceConfig s)

Extract the current snapshot of the instance configuration from an IRC state

connectionConfig :: StatefulIRC s (ConnectionConfig s)

Access the connection config

instanceConfigTVar :: StatefulIRC s (TVar (InstanceConfig s))

Access the instance config TVar

instanceConfig :: StatefulIRC s (InstanceConfig s)

Access the instance config as it is right now.

putInstanceConfig :: InstanceConfig s -> StatefulIRC s ()

Overwrite the instance config, even if it has changed since we looked at it.

stateTVar :: StatefulIRC s (TVar s)

Access the user state.

state :: StatefulIRC s s

Access the user state as it is right now.

putState :: s -> StatefulIRC s ()

Set the user state.

data Origin

The origin of a message.

Constructors

FromServer

FromClient

Instances

Eq Origin

Methods

(==) :: Origin -> Origin -> Bool

(/=) :: Origin -> Origin -> Bool

Read Origin

Methods

readsPrec :: Int -> ReadS Origin

readList :: ReadS [Origin]

readPrec :: ReadPrec Origin

readListPrec :: ReadPrec [Origin]

Show Origin

Methods

showsPrec :: Int -> Origin -> ShowS

show :: Origin -> String

showList :: [Origin] -> ShowS

data ConnectionConfig s

The static state of an IRC server connection.

Constructors

ConnectionConfig

Fields

• _func :: Int -> ByteString -> IO () -> Consumer (Either ByteString IrcEvent) IO () -> Producer IO IrcMessage -> IO ()

  Function to connect and start the conduits.

• _sendqueue :: TBMChan IrcMessage

  Message send queue.

• _server :: ByteString

  The server host.

• _port :: Int

  The server port.

• _flood :: NominalDiffTime

  The minimum time between two adjacent messages.

• _onconnect :: StatefulIRC s ()

  Action to run after successfully connecting to the server and setting the nick.

• _ondisconnect :: StatefulIRC s ()

  Action to run if the remote server closes the connection.

• _logfunc :: Origin -> ByteString -> IO ()

  Function to log messages sent to and received from the server.

data InstanceConfig s

The updateable state of an IRC connection.

Constructors

InstanceConfig

Fields

• _nick :: Text

  Client nick

• _username :: Text

  Client username

• _realname :: Text

  Client realname

• _password :: Maybe Text

  Client password

• _channels :: [Text]

  Current channels

• _ctcpVer :: Text

  Response to CTCP VERSION

• _eventHandlers :: [EventHandler s]

  The registered event handlers

• _ignore :: [(Text, Maybe Text)]

  List of nicks (optionally restricted to channels) to ignore messages from. No channel = global.

Events

data EventType

Types of events which can be caught.

Constructors

EEverything

Match all events

ENothing

Match no events

EPrivmsg

ENotice

ECTCP

ENick

EJoin

EPart

EQuit

EMode

ETopic

EInvite

EKick

EPing

ENumeric

Instances

Eq EventType

Methods

(==) :: EventType -> EventType -> Bool

(/=) :: EventType -> EventType -> Bool

Show EventType

Methods

showsPrec :: Int -> EventType -> ShowS

show :: EventType -> String

showList :: [EventType] -> ShowS

data EventHandler s

A function which handles an event.

Constructors

EventHandler

Fields

• _description :: Text

  A description of the event handler.

• _matchType :: EventType

  Which type to be triggered by

• _eventFunc :: UnicodeEvent -> StatefulIRC s ()

  The function to call.

eventType :: Event a -> EventType

Get the type of an event.

Re-exported

data Event a :: * -> *

A decoded IRC message + source.

Constructors

Event

Fields

• _raw :: ByteString

  The message as a bytestring.

• _source :: Source a

  The source of the message (user, channel, or server).

• _message :: Message a

  The decoded message. This will never be a RawMsg.

Instances

Functor Event

Methods

fmap :: (a -> b) -> Event a -> Event b

(<$) :: a -> Event b -> Event a

Eq (NickName a) => Eq (Event a)

Methods

(==) :: Event a -> Event a -> Bool

(/=) :: Event a -> Event a -> Bool

Show (NickName a) => Show (Event a)

Methods

showsPrec :: Int -> Event a -> ShowS

show :: Event a -> String

showList :: [Event a] -> ShowS

data Source a :: * -> *

The source of an IRC message.

Constructors

User (NickName a)

The message comes directly from a user.

Channel (ChannelName a) (NickName a)

The message comes from a user in a channel.

Server (ServerName a)

The message comes directly from the server.

Instances

Functor Source

Methods

fmap :: (a -> b) -> Source a -> Source b

(<$) :: a -> Source b -> Source a

Eq (NickName a) => Eq (Source a)

Methods

(==) :: Source a -> Source a -> Bool

(/=) :: Source a -> Source a -> Bool

Show (NickName a) => Show (Source a)

Methods

showsPrec :: Int -> Source a -> ShowS

show :: Source a -> String

showList :: [Source a] -> ShowS

data Message a :: * -> *

A decoded IRC message.

Constructors

Privmsg (Target a) (Either CTCPByteString a)

A message, either from a user or to a channel the client is in. CTCPs are distinguished by starting and ending with a \001 (SOH).

Notice (Target a) (Either CTCPByteString a)

Like a privmsg, but should not provoke an automatic response.

Nick (NickName a)

Someone has updated their nick.

Join (ChannelName a)

Someone has joined a channel.

Part (ChannelName a) (Reason a)

Someone has left a channel.

Quit (Reason a)

Someone has left the network.

Mode (Target a) IsModeSet [ModeFlag a] [ModeArg a]

Someone has set some channel modes or user modes.

Topic (ChannelName a) a

Someone has set the topic of a channel.

Invite (ChannelName a) (NickName a)

The client has been invited to a channel.

Kick (ChannelName a) (NickName a) (Reason a)

Someone has been kicked from a channel.

Ping (ServerName a) (Maybe (ServerName a))

The client has received a server ping, and should send a pong asap.

Pong (ServerName a)

A pong sent to the named server.

Numeric Int [NumericArg a]

One of the many server numeric responses.

RawMsg a

Never produced by decoding, but can be used to send arbitrary bytestrings to the IRC server. Naturally, this should only be used when you are confident that the produced bytestring will be a valid IRC message.

Instances

Functor Message

Methods

fmap :: (a -> b) -> Message a -> Message b

(<$) :: a -> Message b -> Message a

Eq (Target a) => Eq (Message a)

Methods

(==) :: Message a -> Message a -> Bool

(/=) :: Message a -> Message a -> Bool

Show (Target a) => Show (Message a)

Methods

showsPrec :: Int -> Message a -> ShowS

show :: Message a -> String

showList :: [Message a] -> ShowS