Client.State.DCC

This module provides ADTs and functions to deal with DCC SEND/ACCEPT request and how start such transfers.

Documentation

data DCCState

Constructors

DCCState

Fields

• _dsOffers :: !(IntMap DCCOffer)
• _dsTransfers :: !(IntMap DCCTransfer)

dsOffers :: Lens' DCCState (IntMap DCCOffer)

dsTransfers :: Lens' DCCState (IntMap DCCTransfer)

emptyDCCState :: DCCState

DCC offers

data DCCOffer

All the necessary information to start the download

Constructors

DCCOffer

Fields

• _dccNetwork :: !Text
• _dccFromInfo :: !UserInfo
• _dccFromIP :: HostName

  String of the IPv4 representation

• _dccPort :: !PortNumber
• _dccFileName :: FilePath

  Guaranteed to be just the name

• _dccSize :: !Word32

  Size of the whole file, per protocol restricted to 32-bits

• _dccOffset :: !Word32

  Byte from where the transmission starts

• _dccStatus :: !ConnectionStatus

Instances

Eq DCCOffer

Defined in Client.State.DCC

Methods

(==) :: DCCOffer -> DCCOffer -> Bool

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

Show DCCOffer

Defined in Client.State.DCC

Methods

showsPrec :: Int -> DCCOffer -> ShowS

show :: DCCOffer -> String

showList :: [DCCOffer] -> ShowS

dccNetwork :: Lens' DCCOffer Text

dccFromInfo :: Lens' DCCOffer UserInfo

dccFromIP :: Lens' DCCOffer HostName

dccPort :: Lens' DCCOffer PortNumber

dccFileName :: Lens' DCCOffer FilePath

dccSize :: Lens' DCCOffer Word32

dccOffset :: Lens' DCCOffer Word32

dccStatus :: Lens' DCCOffer ConnectionStatus

DCC transfer

data DCCTransfer

Structure with information of a download accepted via "/dcc accept" or "/dcc resume"

Constructors

DCCTransfer

Fields

• _dtThread :: !(Maybe (Async ()))

  If Nothing, the thread was killed and stopped.

• _dtProgress :: !Word32

  Percentage of progress

dtThread :: Lens' DCCTransfer (Maybe (Async ()))

dtProgress :: Lens' DCCTransfer Word32

data ConnectionStatus

Status of a connection at certain Key

Constructors

CorrectlyFinished

UserKilled

LostConnection

Downloading

Pending

NotExist

Instances

Eq ConnectionStatus

Defined in Client.State.DCC

Methods

(==) :: ConnectionStatus -> ConnectionStatus -> Bool

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

Show ConnectionStatus

Defined in Client.State.DCC

Methods

showsPrec :: Int -> ConnectionStatus -> ShowS

show :: ConnectionStatus -> String

showList :: [ConnectionStatus] -> ShowS

DCC Update

data DCCUpdate

Constructors

PercentUpdate !Key !Word32

Finished !Key

SocketInterrupted !Key

UserInterrupted !Key

Accept !Key !PortNumber !Word32

Instances

Eq DCCUpdate

Defined in Client.State.DCC

Methods

(==) :: DCCUpdate -> DCCUpdate -> Bool

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

Show DCCUpdate

Defined in Client.State.DCC

Methods

showsPrec :: Int -> DCCUpdate -> ShowS

show :: DCCUpdate -> String

showList :: [DCCUpdate] -> ShowS

Transfer a DCCOffer

supervisedDownload :: FilePath -> Key -> TChan DCCUpdate -> DCCState -> IO DCCState

Launch a supervisor thread for downloading the offer referred by Key and return the DCCState accordingly.

Parser for DCC request

parseSEND :: Text -> UserInfo -> Text -> Either String DCCOffer

Parse a "DCC SEND" command.

parseACCEPT :: DCCState -> UserInfo -> Text -> Maybe DCCUpdate

Parse a "DCC RESUME" command.

DCC RESUME functionality

resumeMsg

Arguments

:: Word32

offset

-> DCCOffer

offer

-> (String, String)

(target, txt)

Craft a CTCP message indicating we want to resume a download at the offset.

acceptUpdate :: DCCUpdate -> DCCState -> DCCState

Modify the DCCState following the corresponding DCCUpdate

Miscellaneous

getFileOffset :: FilePath -> IO (Maybe Word32)

insertAsNewMax :: DCCOffer -> DCCState -> DCCState

ctcpToTuple :: IrcMsg -> Maybe (UserInfo, Identifier, Text, Text)

statusAtKey :: Key -> DCCState -> ConnectionStatus

Check the status of a download at Key by checking the invariants at DCCState

reportStopWithStatus :: Key -> ConnectionStatus -> DCCState -> DCCState

This function can only be called after a cancel has been issued on the supervisor thread at Key

isSend :: Text -> Bool

Check if the payload of a DCC CTCP message is SEND