Safe Haskell	None
Language	Haskell2010

Simplex.FileTransfer.Protocol

Synopsis

data FileParty
- = FRecipient
- | FSender
data SFileParty (a :: FileParty) where
- SFRecipient :: SFileParty 'FRecipient
- SFSender :: SFileParty 'FSender
data AFileParty = FilePartyI p => AFP (SFileParty p)
class FilePartyI (p :: FileParty) where
- sFileParty :: SFileParty p
data FileCommand (p :: FileParty) where
- FNEW :: FileInfo -> NonEmpty RcvPublicAuthKey -> Maybe BasicAuth -> FileCommand 'FSender
- FADD :: NonEmpty RcvPublicAuthKey -> FileCommand 'FSender
- FPUT :: FileCommand 'FSender
- FDEL :: FileCommand 'FSender
- FGET :: RcvPublicDhKey -> FileCommand 'FRecipient
- FACK :: FileCommand 'FRecipient
- PING :: FileCommand 'FRecipient
data FileCmd = FilePartyI p => FileCmd (SFileParty p) (FileCommand p)
data FileInfo = FileInfo {
- sndKey :: SndPublicAuthKey
- size :: Word32
- digest :: ByteString
}
type XFTPFileId = EntityId
data FileResponse
- = FRSndIds SenderId (NonEmpty RecipientId)
- | FRRcvIds (NonEmpty RecipientId)
- | FRFile RcvPublicDhKey CbNonce
- | FROk
- | FRErr XFTPErrorType
- | FRPong
xftpBlockSize :: Int
toFileParty :: forall (p :: FileParty). SFileParty p -> FileParty
aFileParty :: FileParty -> AFileParty
checkParty :: forall t (p :: FileParty) (p' :: FileParty). (FilePartyI p, FilePartyI p') => t p' -> Either String (t p)
xftpEncodeAuthTransmission :: ProtocolEncoding XFTPVersion XFTPErrorType c => THandleParams XFTPVersion 'TClient -> APrivateAuthKey -> Transmission c -> Either TransportError ByteString
xftpEncodeTransmission :: forall c (p :: TransportPeer). ProtocolEncoding XFTPVersion XFTPErrorType c => THandleParams XFTPVersion p -> Transmission c -> Either TransportError ByteString
xftpDecodeTServer :: THandleParams XFTPVersion 'TServer -> ByteString -> Either XFTPErrorType (SignedTransmissionOrError XFTPErrorType FileCmd)
xftpDecodeTClient :: THandleParams XFTPVersion 'TClient -> ByteString -> Either XFTPErrorType (Transmission (Either XFTPErrorType FileResponse))

Documentation

data FileParty Source #

File protocol clients

Constructors

FRecipient
FSender

Instances

Instances details

FromJSON FileParty Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods parseJSON :: Value -> Parser FileParty parseJSONList :: Value -> Parser [FileParty] omittedField :: Maybe FileParty
ToJSON FileParty Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods toJSON :: FileParty -> Value toEncoding :: FileParty -> Encoding toJSONList :: [FileParty] -> Value toEncodingList :: [FileParty] -> Encoding omitField :: FileParty -> Bool
Show FileParty Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods showsPrec :: Int -> FileParty -> ShowS show :: FileParty -> String showList :: [FileParty] -> ShowS
Eq FileParty Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods (==) :: FileParty -> FileParty -> Bool (/=) :: FileParty -> FileParty -> Bool
TestEquality SFileParty Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods testEquality :: forall (a :: FileParty) (b :: FileParty). SFileParty a -> SFileParty b -> Maybe (a :~: b)

data SFileParty (a :: FileParty) where Source #

Constructors

SFRecipient :: SFileParty 'FRecipient
SFSender :: SFileParty 'FSender

Instances

Instances details

TestEquality SFileParty Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods testEquality :: forall (a :: FileParty) (b :: FileParty). SFileParty a -> SFileParty b -> Maybe (a :~: b)
Show (SFileParty p) Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods showsPrec :: Int -> SFileParty p -> ShowS show :: SFileParty p -> String showList :: [SFileParty p] -> ShowS
Eq (SFileParty p) Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods (==) :: SFileParty p -> SFileParty p -> Bool (/=) :: SFileParty p -> SFileParty p -> Bool

data AFileParty Source #

Constructors

FilePartyI p => AFP (SFileParty p)

class FilePartyI (p :: FileParty) where Source #

Methods

sFileParty :: SFileParty p Source #

Instances

Instances details

FilePartyI 'FRecipient Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods sFileParty :: SFileParty 'FRecipient Source #
FilePartyI 'FSender Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods sFileParty :: SFileParty 'FSender Source #

data FileCommand (p :: FileParty) where Source #

Constructors

FNEW :: FileInfo -> NonEmpty RcvPublicAuthKey -> Maybe BasicAuth -> FileCommand 'FSender
FADD :: NonEmpty RcvPublicAuthKey -> FileCommand 'FSender
FPUT :: FileCommand 'FSender
FDEL :: FileCommand 'FSender
FGET :: RcvPublicDhKey -> FileCommand 'FRecipient
FACK :: FileCommand 'FRecipient
PING :: FileCommand 'FRecipient

Instances

Instances details

FilePartyI p => ProtocolEncoding XFTPVersion XFTPErrorType (FileCommand p) Source #

Instance details

Defined in Simplex.FileTransfer.Protocol

Associated Types

type Tag (FileCommand p)
Instance details Defined in Simplex.FileTransfer.Protocol type Tag (FileCommand p)

Methods

encodeProtocol :: Version XFTPVersion -> FileCommand p -> ByteString Source #

protocolP :: Version XFTPVersion -> Tag (FileCommand p) -> Parser (FileCommand p) Source #

fromProtocolError :: ProtocolErrorType -> XFTPErrorType Source #

checkCredentials :: Maybe TAuthorizations -> EntityId -> FileCommand p -> Either XFTPErrorType (FileCommand p) Source #

Show (FileCommand p) Source #

Instance details

Defined in Simplex.FileTransfer.Protocol

Methods

showsPrec :: Int -> FileCommand p -> ShowS

show :: FileCommand p -> String

showList :: [FileCommand p] -> ShowS

type Tag (FileCommand p) Source #

Instance details

Defined in Simplex.FileTransfer.Protocol

type Tag (FileCommand p)

data FileCmd Source #

Constructors

FilePartyI p => FileCmd (SFileParty p) (FileCommand p)

Instances

Instances details

Show FileCmd Source #

Instance details

Defined in Simplex.FileTransfer.Protocol

Methods

showsPrec :: Int -> FileCmd -> ShowS

show :: FileCmd -> String

showList :: [FileCmd] -> ShowS

ProtocolEncoding XFTPVersion XFTPErrorType FileCmd Source #

Instance details

Defined in Simplex.FileTransfer.Protocol

Associated Types

type Tag FileCmd
Instance details Defined in Simplex.FileTransfer.Protocol type Tag FileCmd

Methods

encodeProtocol :: Version XFTPVersion -> FileCmd -> ByteString Source #

protocolP :: Version XFTPVersion -> Tag FileCmd -> Parser FileCmd Source #

fromProtocolError :: ProtocolErrorType -> XFTPErrorType Source #

checkCredentials :: Maybe TAuthorizations -> EntityId -> FileCmd -> Either XFTPErrorType FileCmd Source #

type Tag FileCmd Source #

Instance details

Defined in Simplex.FileTransfer.Protocol

type Tag FileCmd

data FileInfo Source #

Constructors

FileInfo
Fields sndKey :: SndPublicAuthKey size :: Word32 digest :: ByteString

Instances

Instances details

Show FileInfo Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods showsPrec :: Int -> FileInfo -> ShowS show :: FileInfo -> String showList :: [FileInfo] -> ShowS
Encoding FileInfo Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods smpEncode :: FileInfo -> ByteString Source # smpDecode :: ByteString -> Either String FileInfo Source # smpP :: Parser FileInfo Source #
StrEncoding FileInfo Source #
Instance details Defined in Simplex.FileTransfer.Protocol Methods strEncode :: FileInfo -> ByteString Source # strDecode :: ByteString -> Either String FileInfo Source # strP :: Parser FileInfo Source #

type XFTPFileId = EntityId Source #

data FileResponse Source #

Constructors

FRSndIds SenderId (NonEmpty RecipientId)
FRRcvIds (NonEmpty RecipientId)
FRFile RcvPublicDhKey CbNonce
FROk
FRErr XFTPErrorType
FRPong

Instances

Instances details

Show FileResponse Source #

Instance details

Defined in Simplex.FileTransfer.Protocol

Methods

showsPrec :: Int -> FileResponse -> ShowS

show :: FileResponse -> String

showList :: [FileResponse] -> ShowS

Protocol XFTPVersion XFTPErrorType FileResponse Source #

Instance details

Defined in Simplex.FileTransfer.Protocol

Associated Types

type ProtoCommand FileResponse
Instance details Defined in Simplex.FileTransfer.Protocol type ProtoCommand FileResponse = FileCmd
type ProtoType FileResponse
Instance details Defined in Simplex.FileTransfer.Protocol type ProtoType FileResponse = 'PXFTP