Safe Haskell	Safe-Inferred
Language	Haskell2010

Simplex.FileTransfer.Server.Store

Documentation

data FSType Source #

Constructors

FSMemory
FSPostgres

data SFSType :: FSType -> Type where Source #

Constructors

SFSMemory :: SFSType 'FSMemory
SFSPostgres :: SFSType 'FSPostgres

class FileStoreClass s where Source #

Minimal complete definition

newFileStore, closeFileStore, addFile, setFilePath, addRecipient, deleteFile, blockFile, deleteRecipient, getFile, ackFile, expiredFiles, getUsedStorage, getFileCount

Associated Types

type FileStoreConfig s Source #

Methods

newFileStore :: FileStoreConfig s -> IO s Source #

closeFileStore :: s -> IO () Source #

addFile :: s -> SenderId -> FileInfo -> RoundedFileTime -> ServerEntityStatus -> IO (Either XFTPErrorType ()) Source #

setFilePath :: s -> SenderId -> FilePath -> IO (Either XFTPErrorType ()) Source #

addRecipient :: s -> SenderId -> FileRecipient -> IO (Either XFTPErrorType ()) Source #

deleteFile :: s -> SenderId -> IO (Either XFTPErrorType ()) Source #

deleteFiles :: s -> [SenderId] -> IO () Source #

blockFile :: s -> SenderId -> BlockingInfo -> Bool -> IO (Either XFTPErrorType ()) Source #

deleteRecipient :: s -> RecipientId -> FileRec -> IO () Source #

getFile :: s -> SFileParty p -> XFTPFileId -> IO (Either XFTPErrorType (FileRec, APublicAuthKey)) Source #

ackFile :: s -> RecipientId -> IO (Either XFTPErrorType ()) Source #

expiredFiles :: s -> Int64 -> Int -> IO [(SenderId, Maybe FilePath, Word32)] Source #

getUsedStorage :: s -> IO Int64 Source #

getFileCount :: s -> IO Int Source #

Instances

Instances details

FileStoreClass STMFileStore Source #

Instance details

Defined in Simplex.FileTransfer.Server.Store

Associated Types

type FileStoreConfig STMFileStore Source #

Methods

newFileStore :: FileStoreConfig STMFileStore -> IO STMFileStore Source #

closeFileStore :: STMFileStore -> IO () Source #

addFile :: STMFileStore -> SenderId -> FileInfo -> RoundedFileTime -> ServerEntityStatus -> IO (Either XFTPErrorType ()) Source #

setFilePath :: STMFileStore -> SenderId -> FilePath -> IO (Either XFTPErrorType ()) Source #

addRecipient :: STMFileStore -> SenderId -> FileRecipient -> IO (Either XFTPErrorType ()) Source #

deleteFile :: STMFileStore -> SenderId -> IO (Either XFTPErrorType ()) Source #

deleteFiles :: STMFileStore -> [SenderId] -> IO () Source #

blockFile :: STMFileStore -> SenderId -> BlockingInfo -> Bool -> IO (Either XFTPErrorType ()) Source #

deleteRecipient :: STMFileStore -> RecipientId -> FileRec -> IO () Source #

getFile :: forall (p :: FileParty). STMFileStore -> SFileParty p -> XFTPFileId -> IO (Either XFTPErrorType (FileRec, APublicAuthKey)) Source #

ackFile :: STMFileStore -> RecipientId -> IO (Either XFTPErrorType ()) Source #

expiredFiles :: STMFileStore -> Int64 -> Int -> IO [(SenderId, Maybe FilePath, Word32)] Source #

getUsedStorage :: STMFileStore -> IO Int64 Source #

getFileCount :: STMFileStore -> IO Int Source #

data FileRec Source #

Constructors

FileRec
Fields senderId :: SenderId fileInfo :: FileInfo filePath :: TVar (Maybe FilePath) recipientIds :: TVar (Set RecipientId) createdAt :: RoundedFileTime fileStatus :: TVar ServerEntityStatus

data FileRecipient Source #

Constructors

FileRecipient RecipientId APublicAuthKey

Instances

Instances details

Show FileRecipient Source #
Instance details Defined in Simplex.FileTransfer.Server.Store Methods showsPrec :: Int -> FileRecipient -> ShowS show :: FileRecipient -> String showList :: [FileRecipient] -> ShowS
StrEncoding FileRecipient Source #
Instance details Defined in Simplex.FileTransfer.Server.Store Methods strEncode :: FileRecipient -> ByteString Source # strDecode :: ByteString -> Either String FileRecipient Source # strP :: Parser FileRecipient Source #

data STMFileStore Source #

Constructors

STMFileStore
Fields files :: TMap SenderId FileRec recipients :: TMap RecipientId (SenderId, RcvPublicAuthKey) stmStoreLog :: TVar (Maybe (StoreLog 'WriteMode))

Instances

Instances details

FileStoreClass STMFileStore Source #
Instance details Defined in Simplex.FileTransfer.Server.Store Associated Types type FileStoreConfig STMFileStore Source # Methods newFileStore :: FileStoreConfig STMFileStore -> IO STMFileStore Source # closeFileStore :: STMFileStore -> IO () Source # addFile :: STMFileStore -> SenderId -> FileInfo -> RoundedFileTime -> ServerEntityStatus -> IO (Either XFTPErrorType ()) Source # setFilePath :: STMFileStore -> SenderId -> FilePath -> IO (Either XFTPErrorType ()) Source # addRecipient :: STMFileStore -> SenderId -> FileRecipient -> IO (Either XFTPErrorType ()) Source # deleteFile :: STMFileStore -> SenderId -> IO (Either XFTPErrorType ()) Source # deleteFiles :: STMFileStore -> [SenderId] -> IO () Source # blockFile :: STMFileStore -> SenderId -> BlockingInfo -> Bool -> IO (Either XFTPErrorType ()) Source # deleteRecipient :: STMFileStore -> RecipientId -> FileRec -> IO () Source # getFile :: forall (p :: FileParty). STMFileStore -> SFileParty p -> XFTPFileId -> IO (Either XFTPErrorType (FileRec, APublicAuthKey)) Source # ackFile :: STMFileStore -> RecipientId -> IO (Either XFTPErrorType ()) Source # expiredFiles :: STMFileStore -> Int64 -> Int -> IO [(SenderId, Maybe FilePath, Word32)] Source # getUsedStorage :: STMFileStore -> IO Int64 Source # getFileCount :: STMFileStore -> IO Int Source #
type FileStoreConfig STMFileStore Source #
Instance details Defined in Simplex.FileTransfer.Server.Store type FileStoreConfig STMFileStore = ()

type RoundedFileTime = RoundedSystemTime 3600 Source #

fileTimePrecision :: Int64 Source #