TahoeLAFS.Storage.Backend

Documentation

class Backend b where

Methods

version :: b -> IO Version

renewLease :: b -> StorageIndex -> [LeaseSecret] -> IO ()

Update the lease expiration time on the shares associated with the given storage index.

createImmutableStorageIndex :: b -> StorageIndex -> Maybe [LeaseSecret] -> AllocateBuckets -> IO AllocationResult

writeImmutableShare :: b -> StorageIndex -> ShareNumber -> Maybe [LeaseSecret] -> ShareData -> Maybe ByteRanges -> IO ()

abortImmutableUpload :: b -> StorageIndex -> ShareNumber -> Maybe [LeaseSecret] -> IO ()

adviseCorruptImmutableShare :: b -> StorageIndex -> ShareNumber -> CorruptionDetails -> IO ()

getImmutableShareNumbers :: b -> StorageIndex -> IO (CBORSet ShareNumber)

readImmutableShare :: b -> StorageIndex -> ShareNumber -> QueryRange -> IO ShareData

readvAndTestvAndWritev

Arguments

:: b

-> StorageIndex

The storage index at which to operate.

-> WriteEnablerSecret

A shared secret which the backend can use to authorize the writes.

-> ReadTestWriteVectors

The reads, tests, and writes to perform.

-> IO ReadTestWriteResult

Read some ranges of all shares held and/or, if test conditions are met, overwrite some ranges of some shares.

readMutableShare :: b -> StorageIndex -> ShareNumber -> QueryRange -> IO ShareData

getMutableShareNumbers :: b -> StorageIndex -> IO (CBORSet ShareNumber)

adviseCorruptMutableShare :: b -> StorageIndex -> ShareNumber -> CorruptionDetails -> IO ()

Instances

Backend FilesystemBackend

Defined in TahoeLAFS.Storage.Backend.Filesystem

Methods

version :: FilesystemBackend -> IO Version

renewLease :: FilesystemBackend -> StorageIndex -> [LeaseSecret] -> IO ()

createImmutableStorageIndex :: FilesystemBackend -> StorageIndex -> Maybe [LeaseSecret] -> AllocateBuckets -> IO AllocationResult

writeImmutableShare :: FilesystemBackend -> StorageIndex -> ShareNumber -> Maybe [LeaseSecret] -> ShareData -> Maybe ByteRanges -> IO ()

abortImmutableUpload :: FilesystemBackend -> StorageIndex -> ShareNumber -> Maybe [LeaseSecret] -> IO ()

adviseCorruptImmutableShare :: FilesystemBackend -> StorageIndex -> ShareNumber -> CorruptionDetails -> IO ()

getImmutableShareNumbers :: FilesystemBackend -> StorageIndex -> IO (CBORSet ShareNumber)

readImmutableShare :: FilesystemBackend -> StorageIndex -> ShareNumber -> QueryRange -> IO ShareData

readvAndTestvAndWritev :: FilesystemBackend -> StorageIndex -> WriteEnablerSecret -> ReadTestWriteVectors -> IO ReadTestWriteResult

readMutableShare :: FilesystemBackend -> StorageIndex -> ShareNumber -> QueryRange -> IO ShareData

getMutableShareNumbers :: FilesystemBackend -> StorageIndex -> IO (CBORSet ShareNumber)

adviseCorruptMutableShare :: FilesystemBackend -> StorageIndex -> ShareNumber -> CorruptionDetails -> IO ()

Backend NullBackend

Defined in TahoeLAFS.Storage.Backend.Null

Methods

version :: NullBackend -> IO Version

renewLease :: NullBackend -> StorageIndex -> [LeaseSecret] -> IO ()

createImmutableStorageIndex :: NullBackend -> StorageIndex -> Maybe [LeaseSecret] -> AllocateBuckets -> IO AllocationResult

writeImmutableShare :: NullBackend -> StorageIndex -> ShareNumber -> Maybe [LeaseSecret] -> ShareData -> Maybe ByteRanges -> IO ()

abortImmutableUpload :: NullBackend -> StorageIndex -> ShareNumber -> Maybe [LeaseSecret] -> IO ()

adviseCorruptImmutableShare :: NullBackend -> StorageIndex -> ShareNumber -> CorruptionDetails -> IO ()

getImmutableShareNumbers :: NullBackend -> StorageIndex -> IO (CBORSet ShareNumber)

readImmutableShare :: NullBackend -> StorageIndex -> ShareNumber -> QueryRange -> IO ShareData

readvAndTestvAndWritev :: NullBackend -> StorageIndex -> WriteEnablerSecret -> ReadTestWriteVectors -> IO ReadTestWriteResult

readMutableShare :: NullBackend -> StorageIndex -> ShareNumber -> QueryRange -> IO ShareData

getMutableShareNumbers :: NullBackend -> StorageIndex -> IO (CBORSet ShareNumber)

adviseCorruptMutableShare :: NullBackend -> StorageIndex -> ShareNumber -> CorruptionDetails -> IO ()

Backend (IORef MemoryBackend)

Defined in TahoeLAFS.Storage.Backend.Memory

Methods

version :: IORef MemoryBackend -> IO Version

renewLease :: IORef MemoryBackend -> StorageIndex -> [LeaseSecret] -> IO ()

createImmutableStorageIndex :: IORef MemoryBackend -> StorageIndex -> Maybe [LeaseSecret] -> AllocateBuckets -> IO AllocationResult

writeImmutableShare :: IORef MemoryBackend -> StorageIndex -> ShareNumber -> Maybe [LeaseSecret] -> ShareData -> Maybe ByteRanges -> IO ()

abortImmutableUpload :: IORef MemoryBackend -> StorageIndex -> ShareNumber -> Maybe [LeaseSecret] -> IO ()

adviseCorruptImmutableShare :: IORef MemoryBackend -> StorageIndex -> ShareNumber -> CorruptionDetails -> IO ()

getImmutableShareNumbers :: IORef MemoryBackend -> StorageIndex -> IO (CBORSet ShareNumber)

readImmutableShare :: IORef MemoryBackend -> StorageIndex -> ShareNumber -> QueryRange -> IO ShareData

readvAndTestvAndWritev :: IORef MemoryBackend -> StorageIndex -> WriteEnablerSecret -> ReadTestWriteVectors -> IO ReadTestWriteResult

readMutableShare :: IORef MemoryBackend -> StorageIndex -> ShareNumber -> QueryRange -> IO ShareData

getMutableShareNumbers :: IORef MemoryBackend -> StorageIndex -> IO (CBORSet ShareNumber)

adviseCorruptMutableShare :: IORef MemoryBackend -> StorageIndex -> ShareNumber -> CorruptionDetails -> IO ()

data WriteImmutableError

Constructors

MissingUploadSecret

ShareSizeMismatch

ImmutableShareAlreadyWritten

ShareNotAllocated

IncorrectUploadSecret

IncorrectWriteEnablerSecret

Instances

Eq WriteImmutableError

Defined in TahoeLAFS.Storage.Backend

Methods

(==) :: WriteImmutableError -> WriteImmutableError -> Bool

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

Ord WriteImmutableError

Defined in TahoeLAFS.Storage.Backend

Methods

compare :: WriteImmutableError -> WriteImmutableError -> Ordering

(<) :: WriteImmutableError -> WriteImmutableError -> Bool

(<=) :: WriteImmutableError -> WriteImmutableError -> Bool

(>) :: WriteImmutableError -> WriteImmutableError -> Bool

(>=) :: WriteImmutableError -> WriteImmutableError -> Bool

max :: WriteImmutableError -> WriteImmutableError -> WriteImmutableError

min :: WriteImmutableError -> WriteImmutableError -> WriteImmutableError

Show WriteImmutableError

Defined in TahoeLAFS.Storage.Backend

Methods

showsPrec :: Int -> WriteImmutableError -> ShowS

show :: WriteImmutableError -> String

showList :: [WriteImmutableError] -> ShowS

Exception WriteImmutableError

Defined in TahoeLAFS.Storage.Backend

Methods

toException :: WriteImmutableError -> SomeException

fromException :: SomeException -> Maybe WriteImmutableError

displayException :: WriteImmutableError -> String

writeMutableShare :: Backend b => b -> StorageIndex -> ShareNumber -> WriteEnablerSecret -> ShareData -> Maybe ByteRanges -> IO ()

withUploadSecret :: Maybe [LeaseSecret] -> (UploadSecret -> IO a) -> IO a