Class: TRecoverableMappedFile

Declaration: CcrmRecoverableMappedFile.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TMappedFile, MRecoverable

Inherited By:

None.

Purpose:

Constructs an initialized recoverable mapped file.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::TRecoverableMappedFile

TRecoverableMappedFile (TStandardTransaction & trans, TFile file, MOpenFile::EPermissionsForMe forMe =MOpenFile::kReadWrite, MOpenFile::EPermissionsForOthers forOthers=MOpenFile::kAllowNone, const TFileRange & rangeToMap =TFileRange::kEntireFile, EModificationVisibility modVisibility =kPublicModifications, EAddressPlacement mappingConstraints =kMapAnywhere)

Interface Category:

API.

Purpose:

Constructor for TRecoverableMappedFile.

Calling Context:

Called to instantiate RecoverableMappedFile.

Parameters:

TStandardTransaction & trans -The transaction in scope.
TFile file -The file to be Mapped.
MOpenFile::EPermissions ForMe forMe=MOpenFile::kReadWrite -Specifies owner's permissions for the file system. The value must be MOpenfile::kReadWrite.
MOpenFile::EPermissionsForOthers forOthers =MOpenFile::kAllowNone -Specifies non-owner's permissions for the file system.
const TFileRange & rangeToMap =TFileRange::kEntireFile -Specifies file range to be mapped.
EModificationVisibility modVisibility =kPublicModifications -Specifies whether modification to the file should be visible or flush.
EAddressPlacement mappingConstraints =kMapAnywhere -Specifies mapping constraints.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::Write

virtual void Write (void * from, unsigned long size)

Interface Category:

API.

Purpose:

Writes the size of the number of bytes from the buffer to the file.

Calling Context:

Called to write the number of bytes from the buffer to the file.

Parameters:

void * from -The buffer pointer.
unsigned long size -The number of bytes to be written.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::SetRange

virtual void SetRange (const TFileRange & newrange, TMemorySurrogate & memory)

Interface Category:

API.

Purpose:

Remaps the file to a new range.

Calling Context:

Called to remap the file.

Parameters:

const TFileRange & newrange -The new map range.
TMemorySurrogate & memory -The MemorySurrogate reference.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::~TRecoverableMappedFile

virtual ~ TRecoverableMappedFile ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy a TRecoverableMappedFile object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::GetMappedAddr

void * GetMappedAddr () const

Interface Category:

API.

Purpose:

Returns the map file address.

Calling Context:

Called to return the map file address.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::GetReadAddress

const void * GetReadAddress (unsigned long offset)

Interface Category:

API.

Purpose:

Returns the region address to read/CopyOut from.

Calling Context:

Called to return the region address to read/CopyOut from.

Parameters:

unsigned long offset -The region offset.

Return Value:

A const void pointer to the region.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::GetWriteAddress

void * GetWriteAddress (unsigned long offset, unsigned long size)

Interface Category:

API.

Purpose:

Returns the region address to write/CopyIn.

Calling Context:

Called to return the region address to write/CopyIn.

Parameters:

unsigned long offset -The region offset.
unsigned long size -The number of bytes to be written.

Return Value:

A void pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::Flush

virtual void Flush ()

Interface Category:

API.

Purpose:

Flushes changes made to the file.

Calling Context:

Called to flush changes made to the file.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecoverableMappedFile::Touch

virtual void Touch (unsigned long offset, unsigned long length)

Interface Category:

API.

Purpose:

Creates a log record for a given region.

Calling Context:

Called to create a log record for a region being updated.

Parameters:

unsigned long offset -The region offset.
unsigned long length -The region length.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.