Copyright	(c) Eric Mertens, 2016
License	ISC
Maintainer	emertens@gmail.com
Safe Haskell	None
Language	Haskell2010

Client.ConnectionState

Contents

Connection state type
Connection predicates
Messages interactions
Timer information

Description

This module is responsible for tracking the state of an individual IRC connection while the client is connected to it. This state includes user information, server settings, channel membership, and more.

This module is more complicated than many of the other modules in the client because it is responsible for interpreting each IRC message from the server and updating the connection state accordingly.

Synopsis

Connection state type

data ConnectionState Source #

Instances

Show ConnectionState Source #
Methods showsPrec :: Int -> ConnectionState -> ShowS # show :: ConnectionState -> String # showList :: [ConnectionState] -> ShowS #

csNick :: Lens' ConnectionState Identifier Source #

csChannels :: Lens' ConnectionState (HashMap Identifier ChannelState) Source #

csSocket :: Lens' ConnectionState NetworkConnection Source #

csModeTypes :: Lens' ConnectionState ModeTypes Source #

csChannelTypes :: Lens' ConnectionState [Char] Source #

csTransaction :: Lens' ConnectionState Transaction Source #

csModes :: Lens' ConnectionState [Char] Source #

csStatusMsg :: Lens' ConnectionState [Char] Source #

csSettings :: Lens' ConnectionState ServerSettings Source #

csUserInfo :: Lens' ConnectionState UserInfo Source #

csUsers :: Lens' ConnectionState (HashMap Identifier (Maybe Text, Maybe Text)) Source #

csUser :: Functor f => Identifier -> LensLike' f ConnectionState (Maybe Text, Maybe Text) Source #

csModeCount :: Lens' ConnectionState Int Source #

csNetworkId :: Lens' ConnectionState NetworkId Source #

csNetwork :: Lens' ConnectionState Text Source #

csNextPingTime :: Lens' ConnectionState (Maybe UTCTime) Source #

csPingStatus :: Lens' ConnectionState PingStatus Source #

newConnectionState :: NetworkId -> Text -> ServerSettings -> NetworkConnection -> ConnectionState Source #

Connection predicates

isChannelIdentifier :: ConnectionState -> Identifier -> Bool Source #

iHaveOp :: Identifier -> ConnectionState -> Bool Source #

Predicate to test if the connection has op in a given channel.

Messages interactions

sendMsg :: ConnectionState -> RawIrcMsg -> IO () Source #

initialMessages :: ConnectionState -> [RawIrcMsg] Source #

applyMessage :: ZonedTime -> IrcMsg -> ConnectionState -> ([RawIrcMsg], ConnectionState) Source #

squelchIrcMsg :: IrcMsg -> Bool Source #

Return True for messages that should be hidden outside of full detail view. These messages are interpreted by the client so the user shouldn't need to see them directly to get the relevant information.

Timer information

data PingStatus Source #

Constructors

PingSent !UTCTime
PingLatency !Double
PingNever

Instances

Show PingStatus Source #
Methods showsPrec :: Int -> PingStatus -> ShowS # show :: PingStatus -> String # showList :: [PingStatus] -> ShowS #

data TimedAction Source #

Constructors

TimedDisconnect
TimedSendPing

Instances

Eq TimedAction Source #
Methods (==) :: TimedAction -> TimedAction -> Bool # (/=) :: TimedAction -> TimedAction -> Bool #
Ord TimedAction Source #
Methods compare :: TimedAction -> TimedAction -> Ordering # (<) :: TimedAction -> TimedAction -> Bool # (<=) :: TimedAction -> TimedAction -> Bool # (>) :: TimedAction -> TimedAction -> Bool # (>=) :: TimedAction -> TimedAction -> Bool # max :: TimedAction -> TimedAction -> TimedAction # min :: TimedAction -> TimedAction -> TimedAction #
Show TimedAction Source #
Methods showsPrec :: Int -> TimedAction -> ShowS # show :: TimedAction -> String # showList :: [TimedAction] -> ShowS #

nextTimedAction :: ConnectionState -> Maybe (UTCTime, TimedAction) Source #