|
|
Create and map a disk file into memory. This portable class works under both Posix via mmap and under the win32 API. A mapped file can be referenced directly by it's memory segment. One can map and unmap portions of a file on demand, and update changed memory pages mapped from files immediately through sync().
MappedFile (const char *fname, fileaccess_t mode)
| MappedFile |
Open a file for mapping. More than one segment of a file may be mapped into seperate regions of memory.
Parameters:
file | name to access for mapping. |
access | mode to map file. |
MappedFile (const char *fname, pos_t offset, size_t size, fileaccess_t mode)
| MappedFile |
Map a portion or all of a specified file in the specified shared memory access mode. Valid mapping modes include FILE_MAPPED_READ, FILE_MAPPED_WRITE, and FILE_MAPPED_RDWR.
Parameters:
fname | pathname of file to map into memory. |
offset | from start of file to begin mapping in bytes. |
size | of mapped area in bytes. |
mode | to map file. |
~MappedFile ()
| ~MappedFile |
[virtual]
Release a mapped section of memory associated with a file. The mapped area is updated back to disk.
inline void Sync (void)
| Sync |
Synchronize the contents of the mapped portion of memory with the disk file and wait for completion. This assures the memory mapped from the file is written back.
void Sync (char * address, size_t len)
| Sync |
Synchronize a segment of memory mapped from a segment fetch.
Parameters:
memory | address to update. |
size | of segment. |
void Update (size_t offset = 0, size_t len = 0)
| Update |
Map a portion of the memory mapped from the file back to the file and do not wait for completion. This is useful when mapping a database file and updating a single record.
Parameters:
offset | into the mapped region of memory. |
len | of partial region (example, record length). |
void Update (char * address, size_t len)
| Update |
Update a mapped region back to disk as specified by address and length.
Parameters:
address | of segment. |
length | of segment. |
void Release (char * address, size_t len)
| Release |
Release (unmap) a memory segment.
Parameters:
address | of memory segment to release. |
length | of memory segment to release. |
inline char * Fetch (size_t offset = 0)
| Fetch |
Fetch a pointer to an offset within the memory mapped portion of the disk file. This really is used for convience of matching operations between Update and Fetch, as one could simply have accessed the base pointer where the file was mapped directly.
Parameters:
offset | from start of mapped memory. |
char * Fetch (off_t pos, size_t len)
| Fetch |
Fetch and map a portion of a disk file to a logical memory block.
Parameters:
offset | of file segment to map. |
size | of memory segment to map. |
Returns: pointer to memory segment.
MappedFile (const char *fname, fileaccess_t mode)
| MappedFile |
Open a file for mapping. More than one segment of a file may be mapped into seperate regions of memory.
Parameters:
file | name to access for mapping. |
access | mode to map file. |
MappedFile (const char *fname, pos_t offset, size_t size, fileaccess_t mode)
| MappedFile |
Map a portion or all of a specified file in the specified shared memory access mode. Valid mapping modes include FILE_MAPPED_READ, FILE_MAPPED_WRITE, and FILE_MAPPED_RDWR.
Parameters:
fname | pathname of file to map into memory. |
offset | from start of file to begin mapping in bytes. |
size | of mapped area in bytes. |
mode | to map file. |
~MappedFile ()
| ~MappedFile |
[virtual]
Release a mapped section of memory associated with a file. The mapped area is updated back to disk.
inline void Sync (void)
| Sync |
Synchronize the contents of the mapped portion of memory with the disk file and wait for completion. This assures the memory mapped from the file is written back.
void Sync (char * address, size_t len)
| Sync |
Synchronize a segment of memory mapped from a segment fetch.
Parameters:
memory | address to update. |
size | of segment. |
void Update (size_t offset = 0, size_t len = 0)
| Update |
Map a portion of the memory mapped from the file back to the file and do not wait for completion. This is useful when mapping a database file and updating a single record.
Parameters:
offset | into the mapped region of memory. |
len | of partial region (example, record length). |
void Update (char * address, size_t len)
| Update |
Update a mapped region back to disk as specified by address and length.
Parameters:
address | of segment. |
length | of segment. |
void Release (char * address, size_t len)
| Release |
Release (unmap) a memory segment.
Parameters:
address | of memory segment to release. |
length | of memory segment to release. |
inline char * Fetch (size_t offset = 0)
| Fetch |
Fetch a pointer to an offset within the memory mapped portion of the disk file. This really is used for convience of matching operations between Update and Fetch, as one could simply have accessed the base pointer where the file was mapped directly.
Parameters:
offset | from start of mapped memory. |
char * Fetch (off_t pos, size_t len)
| Fetch |
Fetch and map a portion of a disk file to a logical memory block.
Parameters:
offset | of file segment to map. |
size | of memory segment to map. |
Returns: pointer to memory segment.