Safe Haskell	None
Language	Haskell2010

Network.IRC.DCC

Contents

DCC command parsing and encoding
DCC command types

Description

DCC command parsing and encoding module.

Use the CtcpCommand type class to convert between CTCPByteStrings and typed values.

Try converting a CTCPByteString to a DccSend value:

fromCtcp ctcpMessage :: Either String DccSend

Encoding a DccSend value to a CTCPByteString:

toCtcp (Send fileName ip port (Just fileSize))

Synopsis

class CtcpCommand a where
data DccChat
- = Chat !IPv4 !PortNumber
- | ChatWhiteboard !IPv4 !PortNumber
data DccClose = Close
data DccSend
- = Send !Path !IPv4 !PortNumber !(Maybe FileOffset)
- | SendReverseServer !Path !IPv4 !FileOffset !Token
data DccResume
- = Resume !Path !PortNumber !FileOffset
- | ResumeReverse !Path !FileOffset !Token
data DccAccept
- = Accept !Path !PortNumber !FileOffset
- | AcceptReverse !Path !FileOffset !Token
acceptedPosition :: DccAccept -> FileOffset
data DccSendReverseClient = SendReverseClient !Path !IPv4 !PortNumber !FileOffset !Token
resumeFromSend :: DccSend -> FileOffset -> DccResume
matchesSend :: DccAccept -> DccSend -> Bool
data Path
- = Rel PathType (Path Rel File)
- | Abs PathType (Path Abs File)
fromPath :: Path -> Path Rel File
data PathType
- = Simple
- | Quoted
data FileOffset
newtype Token = Token ByteString

DCC command parsing and encoding

class CtcpCommand a where #

CTCP commands that can be parsed and encoded

Minimal complete definition

toCtcp, fromCtcp

Methods

toCtcp :: a -> CTCPByteString #

fromCtcp :: CTCPByteString -> Either String a #

Instances

CtcpCommand DccSendReverseClient #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccSendReverseClient -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccSendReverseClient #
CtcpCommand DccAccept #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccAccept -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccAccept #
CtcpCommand DccResume #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccResume -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccResume #
CtcpCommand DccSend #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccSend -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccSend #
CtcpCommand DccClose #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccClose -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccClose #
CtcpCommand DccChat #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccChat -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccChat #

DCC command types

Messaging commands (DCC CHAT)

data DccChat #

Offer DCC chat session

Constructors

Chat !IPv4 !PortNumber

Text messages exchange

DCC CHAT chat <ip> <port>

ChatWhiteboard !IPv4 !PortNumber

Drawing commands exchange

DCC CHAT wboard <ip> <port>

Instances

Eq DccChat #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: DccChat -> DccChat -> Bool # (/=) :: DccChat -> DccChat -> Bool #
Show DccChat #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> DccChat -> ShowS # show :: DccChat -> String # showList :: [DccChat] -> ShowS #
CtcpCommand DccChat #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccChat -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccChat #

data DccClose #

Signal intent to close DCC chat connection

Constructors

Close

DCC CLOSE

Instances

Eq DccClose #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: DccClose -> DccClose -> Bool # (/=) :: DccClose -> DccClose -> Bool #
Show DccClose #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> DccClose -> ShowS # show :: DccClose -> String # showList :: [DccClose] -> ShowS #
CtcpCommand DccClose #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccClose -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccClose #

File Transfer commands (DCC SEND)

data DccSend #

Offer DCC file transfer

Constructors

Send !Path !IPv4 !PortNumber !(Maybe FileOffset)

As part of the standard DCC protocol, sent by the server

DCC SEND <path> <ip> <port> (<fileSize>)

SendReverseServer !Path !IPv4 !FileOffset !Token

As part of the Reverse DCC protocol, sent by the server

DCC SEND <path> <ip> 0 <fileSize> <token>

Instances

Eq DccSend #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: DccSend -> DccSend -> Bool # (/=) :: DccSend -> DccSend -> Bool #
Show DccSend #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> DccSend -> ShowS # show :: DccSend -> String # showList :: [DccSend] -> ShowS #
CtcpCommand DccSend #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccSend -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccSend #

data DccResume #

Signal intent to resume DCC file transfer at specific position

Constructors

Resume !Path !PortNumber !FileOffset

As part of the standard DCC protocol, sent by the client

DCC RESUME <path> <port> <position>

ResumeReverse !Path !FileOffset !Token

As part of the Reverse DCC protocol, sent by the client

DCC RESUME <path> 0 <position> <token>

Instances

Eq DccResume #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: DccResume -> DccResume -> Bool # (/=) :: DccResume -> DccResume -> Bool #
Show DccResume #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> DccResume -> ShowS # show :: DccResume -> String # showList :: [DccResume] -> ShowS #
CtcpCommand DccResume #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccResume -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccResume #

data DccAccept #

Signal acceptance to resume DCC file transfer at specific position

Constructors

Accept !Path !PortNumber !FileOffset

As part of the standard DCC protocol, sent by the server

DCC ACCEPT <path> <port> <position>

AcceptReverse !Path !FileOffset !Token

As part of the Reverse DCC protocol, sent by the server

DCC ACCEPT <path> 0 <position> <token>

Instances

Eq DccAccept #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: DccAccept -> DccAccept -> Bool # (/=) :: DccAccept -> DccAccept -> Bool #
Show DccAccept #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> DccAccept -> ShowS # show :: DccAccept -> String # showList :: [DccAccept] -> ShowS #
CtcpCommand DccAccept #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccAccept -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccAccept #

acceptedPosition :: DccAccept -> FileOffset #

data DccSendReverseClient #

Tell the server to start a DCC file transfer and where it should send the data to.

Constructors

SendReverseClient !Path !IPv4 !PortNumber !FileOffset !Token

As part of the Reverse DCC protocol, sent by the client

DCC SEND <path> <ip> <port> <fileSize> <token>

Instances

Eq DccSendReverseClient #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: DccSendReverseClient -> DccSendReverseClient -> Bool # (/=) :: DccSendReverseClient -> DccSendReverseClient -> Bool #
Show DccSendReverseClient #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> DccSendReverseClient -> ShowS # show :: DccSendReverseClient -> String # showList :: [DccSendReverseClient] -> ShowS #
CtcpCommand DccSendReverseClient #
Instance details Defined in Network.IRC.DCC.Internal Methods toCtcp :: DccSendReverseClient -> CTCPByteString # fromCtcp :: CTCPByteString -> Either String DccSendReverseClient #

Constructors from other commands

resumeFromSend :: DccSend -> FileOffset -> DccResume #

Try resuming a file offer

Protocol variant checks

matchesSend :: DccAccept -> DccSend -> Bool #

Check if a DccSend and a DccAccept command are part of the same negotiation.

Helper Types

data Path #

Constructors

Rel PathType (Path Rel File)
Abs PathType (Path Abs File)

Instances

Eq Path #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Show Path #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #

fromPath :: Path -> Path Rel File #

data PathType #

Constructors

Simple	A file path without spaces
Quoted	A file path that can include spaces and will be quoted when serialized

Instances

Eq PathType #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: PathType -> PathType -> Bool # (/=) :: PathType -> PathType -> Bool #
Show PathType #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> PathType -> ShowS # show :: PathType -> String # showList :: [PathType] -> ShowS #

data FileOffset #

Instances

Bounded FileOffset #
Instance details Defined in Network.IRC.DCC.Internal Methods minBound :: FileOffset # maxBound :: FileOffset #
Enum FileOffset #
Instance details Defined in Network.IRC.DCC.Internal Methods succ :: FileOffset -> FileOffset # pred :: FileOffset -> FileOffset # toEnum :: Int -> FileOffset # fromEnum :: FileOffset -> Int # enumFrom :: FileOffset -> [FileOffset] # enumFromThen :: FileOffset -> FileOffset -> [FileOffset] # enumFromTo :: FileOffset -> FileOffset -> [FileOffset] # enumFromThenTo :: FileOffset -> FileOffset -> FileOffset -> [FileOffset] #
Eq FileOffset #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: FileOffset -> FileOffset -> Bool # (/=) :: FileOffset -> FileOffset -> Bool #
Integral FileOffset #
Instance details Defined in Network.IRC.DCC.Internal Methods quot :: FileOffset -> FileOffset -> FileOffset # rem :: FileOffset -> FileOffset -> FileOffset # div :: FileOffset -> FileOffset -> FileOffset # mod :: FileOffset -> FileOffset -> FileOffset # quotRem :: FileOffset -> FileOffset -> (FileOffset, FileOffset) # divMod :: FileOffset -> FileOffset -> (FileOffset, FileOffset) # toInteger :: FileOffset -> Integer #
Num FileOffset #
Instance details Defined in Network.IRC.DCC.Internal Methods (+) :: FileOffset -> FileOffset -> FileOffset # (-) :: FileOffset -> FileOffset -> FileOffset # (*) :: FileOffset -> FileOffset -> FileOffset # negate :: FileOffset -> FileOffset # abs :: FileOffset -> FileOffset # signum :: FileOffset -> FileOffset # fromInteger :: Integer -> FileOffset #
Ord FileOffset #
Instance details Defined in Network.IRC.DCC.Internal Methods compare :: FileOffset -> FileOffset -> Ordering # (<) :: FileOffset -> FileOffset -> Bool # (<=) :: FileOffset -> FileOffset -> Bool # (>) :: FileOffset -> FileOffset -> Bool # (>=) :: FileOffset -> FileOffset -> Bool # max :: FileOffset -> FileOffset -> FileOffset # min :: FileOffset -> FileOffset -> FileOffset #
Real FileOffset #
Instance details Defined in Network.IRC.DCC.Internal Methods toRational :: FileOffset -> Rational #
Show FileOffset #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> FileOffset -> ShowS # show :: FileOffset -> String # showList :: [FileOffset] -> ShowS #

newtype Token #

An identifier for knowing which negotiation a request belongs to

Constructors

Token ByteString

Instances

Eq Token #
Instance details Defined in Network.IRC.DCC.Internal Methods (==) :: Token -> Token -> Bool # (/=) :: Token -> Token -> Bool #
Show Token #
Instance details Defined in Network.IRC.DCC.Internal Methods showsPrec :: Int -> Token -> ShowS # show :: Token -> String # showList :: [Token] -> ShowS #