Client.State.Network

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.

Connection state

data NetworkState

State tracked for each IRC connection

Constructors

NetworkState

Fields

• _csNetworkId :: !NetworkId

  network connection identifier

• _csChannels :: !(HashMap Identifier ChannelState)

  joined channels

• _csSocket :: !NetworkConnection

  network socket

• _csModeTypes :: !ModeTypes

  channel mode meanings

• _csChannelTypes :: ![Char]

  channel identifier prefixes

• _csTransaction :: !Transaction

  state for multi-message sequences

• _csModes :: ![Char]

  modes for the connected user

• _csStatusMsg :: ![Char]

  modes that prefix statusmsg channel names

• _csSettings :: !ServerSettings

  settings used for this connection

• _csUserInfo :: !UserInfo

  usermask used by the server for this connection

• _csUsers :: !(HashMap Identifier UserAndHost)

  user and hostname for other nicks

• _csModeCount :: !Int

  maximum mode changes per MODE command

• _csNetwork :: !Text

  name of network connection

• _csNextPingTime :: !(Maybe UTCTime)

  time for next ping event

• _csPingStatus :: !PingStatus

  state of ping timer

• _csLastReceived :: !(Maybe UTCTime)

  time of last message received

• _csMessageHooks :: ![Text]

  names of message hooks to apply to this connection

• _csAuthenticationState :: !AuthenticateState

Instances

Show NetworkState

Methods

showsPrec :: Int -> NetworkState -> ShowS

show :: NetworkState -> String

showList :: [NetworkState] -> ShowS

data AuthenticateState

State of the authentication transaction

Constructors

AS_None

no active transaction

AS_PlainStarted

PLAIN mode initiated

AS_EcdsaStarted

ECDSA-NIST mode initiated

AS_EcdsaWaitChallenge

ECDSA_NIST user sent waiting for challenge

Instances

Show AuthenticateState

Methods

showsPrec :: Int -> AuthenticateState -> ShowS

show :: AuthenticateState -> String

showList :: [AuthenticateState] -> ShowS

newNetworkState

Arguments

:: NetworkId

unique network ID

-> Text

network name

-> ServerSettings

server settings

-> NetworkConnection

active network connection

-> PingStatus

initial ping status

-> NetworkState

new network state

Construct a new network state using the given settings and default values as specified by the IRC specification.

Lenses

csNick :: Lens' NetworkState Identifier

csChannels :: Lens' NetworkState (HashMap Identifier ChannelState)

csSocket :: Lens' NetworkState NetworkConnection

csModeTypes :: Lens' NetworkState ModeTypes

csChannelTypes :: Lens' NetworkState [Char]

csTransaction :: Lens' NetworkState Transaction

csModes :: Lens' NetworkState [Char]

csStatusMsg :: Lens' NetworkState [Char]

csSettings :: Lens' NetworkState ServerSettings

csUserInfo :: Lens' NetworkState UserInfo

csUsers :: Lens' NetworkState (HashMap Identifier UserAndHost)

csUser :: Functor f => Identifier -> LensLike' f NetworkState (Maybe UserAndHost)

csModeCount :: Lens' NetworkState Int

csNetworkId :: Lens' NetworkState NetworkId

csNetwork :: Lens' NetworkState Text

csNextPingTime :: Lens' NetworkState (Maybe UTCTime)

csPingStatus :: Lens' NetworkState PingStatus

csLastReceived :: Lens' NetworkState (Maybe UTCTime)

csMessageHooks :: Lens' NetworkState [Text]

csAuthenticationState :: Lens' NetworkState AuthenticateState

User information

data UserAndHost

Pair of username and hostname. Empty strings represent missing information.

Constructors

UserAndHost !Text !Text

username hostname

Instances

Show UserAndHost

Methods

showsPrec :: Int -> UserAndHost -> ShowS

show :: UserAndHost -> String

showList :: [UserAndHost] -> ShowS

Cross-message state

data Transaction

Constructors

NoTransaction

NamesTransaction [Text]

BanTransaction [(Text, MaskListEntry)]

WhoTransaction [UserInfo]

Instances

Show Transaction

Methods

showsPrec :: Int -> Transaction -> ShowS

show :: Transaction -> String

showList :: [Transaction] -> ShowS

Connection predicates

isChannelIdentifier :: NetworkState -> Identifier -> Bool

iHaveOp :: Identifier -> NetworkState -> Bool

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

Messages interactions

sendMsg :: NetworkState -> RawIrcMsg -> IO ()

Transmit a RawIrcMsg on the connection associated with the given network. For PRIVMSG and NOTICE overlong commands are detected and transmitted as multiple messages.

initialMessages :: NetworkState -> [RawIrcMsg]

applyMessage :: ZonedTime -> IrcMsg -> NetworkState -> ([RawIrcMsg], NetworkState)

squelchIrcMsg :: IrcMsg -> Bool

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

Status of the ping timer

Constructors

PingSent !UTCTime

ping sent waiting for pong

PingLatency !Double

latency in seconds for last ping

PingNever

no ping sent

PingConnecting !Int !(Maybe UTCTime)

number of attempts, last known connection time

Instances

Show PingStatus

Methods

showsPrec :: Int -> PingStatus -> ShowS

show :: PingStatus -> String

showList :: [PingStatus] -> ShowS

_PingConnecting :: Prism' PingStatus (Int, Maybe UTCTime)

data TimedAction

Timer-based events

Constructors

TimedDisconnect

terminate the connection due to timeout

TimedSendPing

transmit a ping to the server

Instances

Eq TimedAction

Methods

(==) :: TimedAction -> TimedAction -> Bool

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

Ord TimedAction

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

Methods

showsPrec :: Int -> TimedAction -> ShowS

show :: TimedAction -> String

showList :: [TimedAction] -> ShowS

nextTimedAction :: NetworkState -> Maybe (UTCTime, TimedAction)

Compute the earliest timed action for a connection, if any

applyTimedAction :: TimedAction -> NetworkState -> IO NetworkState

Apply the given TimedAction to a connection state.

Moderation

useChanServ

Arguments

:: Identifier

channel

-> NetworkState

network state

-> Bool

chanserv available

sendModeration

Arguments

:: Identifier

channel

-> [RawIrcMsg]

commands

-> NetworkState

network state

-> IO NetworkState

Used to send commands that require ops to perform. If this channel is one that the user has chanserv access and ops are needed then ops are requested and the commands are queued, otherwise send them directly.

sendTopic

Arguments

:: Identifier

channel

-> Text

topic

-> NetworkState

network state

-> IO ()