Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXMappedFile Class Reference

Memory mapped file. More...

#include <FXMappedFile.h>

Inheritance diagram for FX::FXMappedFile:
FX::FXIODevice FX::FXIO

Public Member Functions

 FXMappedFile ()
 Construct a memory map.
 
FXptr open (const FXString &filename, FXuint m=FXIO::Reading, FXuint perm=FXIO::AllReadWrite, FXlong len=0, FXlong off=0)
 Open a file, and map a view of it into memory; the offset must be a multiple of the page size.
 
virtual FXbool isSerial () const override
 Return true if serial access only.
 
FXptr data () const
 Return pointer to memory area.
 
FXival length () const
 Obtain length of the map.
 
FXlong offset () const
 Obtain offset of the map.
 
virtual FXlong size () override
 Return size.
 
virtual FXbool flush () override
 Flush to disk.
 
virtual FXbool close () override
 Close file, and also the map.
 
virtual ~FXMappedFile ()
 Destroy the map.
 
- Public Member Functions inherited from FX::FXIODevice
 FXIODevice ()
 Construct.
 
 FXIODevice (FXInputHandle h)
 Construct device and attach existing handle h.
 
FXInputHandle handle () const
 Return handle.
 
virtual FXbool isOpen () const override
 Return true if open.
 
virtual FXuint mode () const override
 Return access mode.
 
virtual FXbool mode (FXuint m) override
 Change access mode of open device.
 
virtual FXuint perms () const override
 Return permissions.
 
virtual FXbool perms (FXuint p) override
 Set permissions.
 
virtual FXbool attach (FXInputHandle h)
 Attach existing device handle, taking ownership of the handle.
 
virtual FXbool detach ()
 Detach device handle.
 
virtual FXival readBlock (void *ptr, FXival count) override
 Read block of bytes, returning number of bytes read.
 
virtual FXival writeBlock (const void *ptr, FXival count) override
 Write block of bytes, returning number of bytes written.
 
virtual FXlong truncate (FXlong sz) override
 Truncate file.
 
virtual FXint eof () override
 Test if we're at the end; -1 if error.
 
virtual ~FXIODevice ()
 Destroy and close.
 
- Public Member Functions inherited from FX::FXIO
virtual FXlong position () const
 Get current file position.
 
virtual FXlong position (FXlong offset, FXuint from=FXIO::Begin)
 Change file position, returning new position from start.
 
FXbool readChar (FXchar &ch)
 Read character.
 
FXbool writeChar (FXchar ch)
 Write character.
 
virtual ~FXIO ()
 Destroy and close.
 

Static Public Member Functions

static FXival granularity ()
 Return memory mapping granularity.
 
- Static Public Member Functions inherited from FX::FXIODevice
static FXbool valid (FXInputHandle hnd)
 Check handle validity.
 

Additional Inherited Members

- Public Types inherited from FX::FXIO
enum  {
  NoAccess = 0, ReadOnly = 1, WriteOnly = 2, ReadWrite = ReadOnly|WriteOnly,
  Append = 4, Truncate = 8, Create = 16, Exclusive = 32,
  NonBlocking = 64, Executable = 128, OwnHandle = 256, NoAccessTime = 512,
  Inheritable = 1024, Reading = ReadOnly, Writing = ReadWrite|Create|Truncate
}
 Access modes. More...
 
enum  { Begin = 0, Current = 1, End = 2 }
 Positioning modes. More...
 
enum  {
  OtherExec = 0x00001, OtherWrite = 0x00002, OtherRead = 0x00004, OtherReadWrite = OtherRead|OtherWrite,
  OtherFull = OtherReadWrite|OtherExec, GroupExec = 0x00008, GroupWrite = 0x00010, GroupRead = 0x00020,
  GroupReadWrite = GroupRead|GroupWrite, GroupFull = GroupReadWrite|GroupExec, OwnerExec = 0x00040, OwnerWrite = 0x00080,
  OwnerRead = 0x00100, OwnerReadWrite = OwnerRead|OwnerWrite, OwnerFull = OwnerReadWrite|OwnerExec, AllRead = OtherRead|GroupRead|OwnerRead,
  AllWrite = OtherWrite|GroupWrite|OwnerWrite, AllExec = OtherExec|GroupExec|OwnerExec, AllReadWrite = AllRead|AllWrite, AllFull = AllReadWrite|AllExec,
  Hidden = 0x00200, Directory = 0x00400, File = 0x00800, SymLink = 0x01000,
  SetUser = 0x02000, SetGroup = 0x04000, Sticky = 0x08000, Character = 0x10000,
  Block = 0x20000, Socket = 0x40000, Fifo = 0x80000, Device = Character|Block
}
 Permissions. More...
 
enum  { Error = -1, Again = -2, Broken = -3 }
 Error return codes for readBlock() and writeBlock() More...
 
- Protected Attributes inherited from FX::FXIODevice
FXInputHandle device
 

Detailed Description

Memory mapped file.


The documentation for this class was generated from the following file:

Copyright © 1997-2026 Jeroen van der Zijp