Copyright	(c) Ruben Astudillo 2019
License	ISC
Maintainer	ruben.astud@gmail.com
Safe Haskell	None
Language	Haskell2010

Client.State.DCC

Contents

DCC offers
DCC transfer
DCC Update
Transfer a DCCOffer
Parser for DCC request
DCC RESUME functionality
Miscellaneous

Description

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

Synopsis

data DCCState = DCCState {
- _dsOffers :: !(IntMap DCCOffer)
- _dsTransfers :: !(IntMap DCCTransfer)
}
dsOffers :: Lens' DCCState (IntMap DCCOffer)
dsTransfers :: Lens' DCCState (IntMap DCCTransfer)
emptyDCCState :: DCCState
data DCCOffer = DCCOffer {
- _dccNetwork :: !Text
- _dccFromInfo :: !UserInfo
- _dccFromIP :: HostName
- _dccPort :: !PortNumber
- _dccFileName :: FilePath
- _dccSize :: !Word32
- _dccOffset :: !Word32
- _dccStatus :: !ConnectionStatus
}
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
data DCCTransfer = DCCTransfer {
- _dtThread :: !(Maybe (Async ()))
- _dtProgress :: !Word32
}
dtThread :: Lens' DCCTransfer (Maybe (Async ()))
dtProgress :: Lens' DCCTransfer Word32
data ConnectionStatus
- = CorrectlyFinished
- | UserKilled
- | LostConnection
- | Downloading
- | Pending
- | NotExist
data DCCUpdate
- = PercentUpdate !Key !Word32
- | Finished !Key
- | SocketInterrupted !Key
- | UserInterrupted !Key
- | Accept !Key !PortNumber !Word32
supervisedDownload :: FilePath -> Key -> TChan DCCUpdate -> DCCState -> IO DCCState
parseSEND :: Text -> UserInfo -> Text -> Either String DCCOffer
parseACCEPT :: DCCState -> UserInfo -> Text -> Maybe DCCUpdate
resumeMsg :: Word32 -> DCCOffer -> (String, String)
acceptUpdate :: DCCUpdate -> DCCState -> DCCState
getFileOffset :: FilePath -> IO (Maybe Word32)
insertAsNewMax :: DCCOffer -> DCCState -> DCCState
ctcpToTuple :: IrcMsg -> Maybe (UserInfo, Identifier, Text, Text)
statusAtKey :: Key -> DCCState -> ConnectionStatus
reportStopWithStatus :: Key -> ConnectionStatus -> DCCState -> DCCState
isSend :: Text -> Bool

Documentation

data DCCState Source #

Constructors

DCCState
Fields _dsOffers :: !(IntMap DCCOffer) _dsTransfers :: !(IntMap DCCTransfer)

dsOffers :: Lens' DCCState (IntMap DCCOffer) Source #

dsTransfers :: Lens' DCCState (IntMap DCCTransfer) Source #

emptyDCCState :: DCCState Source #

DCC offers

data DCCOffer Source #

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 Source #
Instance details Defined in Client.State.DCC Methods (==) :: DCCOffer -> DCCOffer -> Bool # (/=) :: DCCOffer -> DCCOffer -> Bool #
Show DCCOffer Source #
Instance details Defined in Client.State.DCC Methods showsPrec :: Int -> DCCOffer -> ShowS # show :: DCCOffer -> String # showList :: [DCCOffer] -> ShowS #

dccNetwork :: Lens' DCCOffer Text Source #

dccFromInfo :: Lens' DCCOffer UserInfo Source #

dccFromIP :: Lens' DCCOffer HostName Source #

dccPort :: Lens' DCCOffer PortNumber Source #

dccFileName :: Lens' DCCOffer FilePath Source #

dccSize :: Lens' DCCOffer Word32 Source #

dccOffset :: Lens' DCCOffer Word32 Source #

dccStatus :: Lens' DCCOffer ConnectionStatus Source #

DCC transfer

data DCCTransfer Source #

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 ())) Source #

dtProgress :: Lens' DCCTransfer Word32 Source #

data ConnectionStatus Source #

Status of a connection at certain Key

Constructors

CorrectlyFinished
UserKilled
LostConnection
Downloading
Pending
NotExist

Instances

Eq ConnectionStatus Source #
Instance details Defined in Client.State.DCC Methods (==) :: ConnectionStatus -> ConnectionStatus -> Bool # (/=) :: ConnectionStatus -> ConnectionStatus -> Bool #
Show ConnectionStatus Source #
Instance details Defined in Client.State.DCC Methods showsPrec :: Int -> ConnectionStatus -> ShowS # show :: ConnectionStatus -> String # showList :: [ConnectionStatus] -> ShowS #

DCC Update

data DCCUpdate Source #

Constructors

PercentUpdate !Key !Word32
Finished !Key
SocketInterrupted !Key
UserInterrupted !Key
Accept !Key !PortNumber !Word32

Instances

Eq DCCUpdate Source #
Instance details Defined in Client.State.DCC Methods (==) :: DCCUpdate -> DCCUpdate -> Bool # (/=) :: DCCUpdate -> DCCUpdate -> Bool #
Show DCCUpdate Source #
Instance details Defined in Client.State.DCC Methods showsPrec :: Int -> DCCUpdate -> ShowS # show :: DCCUpdate -> String # showList :: [DCCUpdate] -> ShowS #