avail/avail.files/ManagedFileWrapper

ManagedFileWrapper

class ManagedFileWrapper( val id: UUID, resolverReference: ResolverReference, fileManager: FileManager) : AbstractFileWrapper

A ManagedFileWrapper is an AbstractFileWrapper used by the FileManager to hold an AvailFile that is on the file system of the machine Avail is running. The purpose of this is to enable the FileManager cache to delay establishing the type of the AvailFile until the file type can be read without delaying adding a file object to the FileManager cache.

Author

Richard Arriaga

Parameters

id

The FileManager.fileCache key.

resolverReference

The reference of the target file.

fileManager

The FileManager this ManagedFileWrapper belongs to.

Constructors

ManagedFileWrapper

fun ManagedFileWrapper( id: UUID, resolverReference: ResolverReference, fileManager: FileManager)

Construct a ManagedFileWrapper.

Types

object Companion

Functions

fun close()

Close this ManagedFileWrapper.

conditionallySaveToLocalHistory

fun conditionallySaveToLocalHistory()

Save the tracedActionStack to local history starting from the position at tracedActionStackSavePointer.

open override fun delete(success: (UUID?) -> Unit, failure: (ErrorCode, Throwable?) -> Unit)

Delete the wrapped file from its storage location.

fun execute( fileAction: FileAction, originator: UUID, continuation: () -> Unit)

Update the wrapped AvailFile with the provided FileAction.

notifyOpenFailure

fun notifyOpenFailure(errorCode: ErrorCode, e: Throwable? = null)

Notify the FileRequestHandlers in ManagedFileWrapper.fileRequestQueue that the file action encountered a failure while opening.

fun notifyReady()

Notify this ManagedFileWrapper that the AvailFile has been fully read.

fun provide( registerInterest: Boolean, successHandler: (UUID, String, AvailFile) -> Unit, failureHandler: (ErrorCode, Throwable?) -> Unit)

Provide the raw bytes of the enclosed AvailFile to the requesting consumer.

fun redo(originator: UUID)

If an undo resulted in a revert on the file and no other FileAction has occurred since, redo the previously reverted action.

fun undo(originator: UUID)

Undo the FileAction performed on the file from the TracedAction that is undoStackDepth + 1 from the top of the stack.

Properties

open val error: Throwable? = null

The Throwable if one was encountered when opening the file, null otherwise.

open val errorCode: ErrorCode? = null

The associated ErrorCode if error is not null; null otherwise

open override val file: AvailFile

The AvailFile wrapped by this ManagedFileWrapper.

val id: UUID

The FileManager.fileCache key.

val interestCount: AtomicInteger

The number of clients that actively have this file open.

val isClosed: Boolean

Is the file closed? true indicates it is; false otherwise.

open val isError: Boolean

true indicates that there was an error; false otherwise.

val reference: ResolverReference

The ResolverReference of the target file on disk.