Logo Search packages:      
Sourcecode: pwlib version File versions  Download package

PMemoryFile Class Reference

#include <memfile.h>

Inheritance diagram for PMemoryFile:

PFile PChannel PObject

List of all members.

Detailed Description

This class is used to allow a block of memory to substitute for a disk file.

Definition at line 62 of file memfile.h.

Miscellaneous functions

void AbortCommandString ()
BOOL SendCommandString (const PString &command)
BOOL SetBufferSize (PINDEX newSize)
virtual BOOL Shutdown (ShutdownValue option)
enum  ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }

File manipulation functions

BOOL Access (OpenMode mode)
BOOL Copy (const PFilePath &newname, BOOL force=FALSE)
BOOL Exists () const
BOOL Move (const PFilePath &newname, BOOL force=FALSE)
BOOL Remove (BOOL force=FALSE)
BOOL Rename (const PString &newname, BOOL force=FALSE)
static BOOL Access (const PFilePath &name, OpenMode mode)
static BOOL Copy (const PFilePath &oldname, const PFilePath &newname, BOOL force=FALSE)
static BOOL Exists (const PFilePath &name)
static BOOL Move (const PFilePath &oldname, const PFilePath &newname, BOOL force=FALSE)
static BOOL Remove (const PFilePath &name, BOOL force=FALSE)
static BOOL Rename (const PFilePath &oldname, const PString &newname, BOOL force=FALSE)

Comparison functions

virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
bool operator!= (const PObject &obj) const
bool operator< (const PObject &obj) const
bool operator<= (const PObject &obj) const
bool operator== (const PObject &obj) const
bool operator> (const PObject &obj) const
bool operator>= (const PObject &obj) const
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }

Run Time Type functions

virtual const char * GetClass (unsigned=0) const
virtual BOOL InternalIsDescendant (const char *clsName) const
BOOL IsClass (const char *cls) const
static const char * Class ()

Error functions

Errors GetErrorCode (ErrorGroup group=NumErrorGroups) const
int GetErrorNumber (ErrorGroup group=NumErrorGroups) const
virtual PString GetErrorText (ErrorGroup group=NumErrorGroups) const
enum  ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
enum  Errors {
  NoError, NotFound, FileExists, DiskFull,
  AccessDenied, DeviceInUse, BadParameter, NoMemory,
  NotOpen, Timeout, Interrupted, BufferTooSmall,
  Miscellaneous, ProtocolFailure, NumNormalisedErrors
static PString GetErrorText (Errors lastError, int osError=0)

File channel functions

const PFilePathGetFilePath () const
BOOL GetInfo (PFileInfo &info)
BOOL IsEndOfFile () const
virtual BOOL Open (const PFilePath &name, OpenMode mode=ReadWrite, int opts=ModeDefault)
virtual BOOL Open (OpenMode mode=ReadWrite, int opts=ModeDefault)
void SetFilePath (const PString &path)
BOOL SetPermissions (int permissions)
enum  FilePositionOrigin { Start = SEEK_SET, Current = SEEK_CUR, End = SEEK_END }
 Options for the origin in setting the file position. More...
static BOOL GetInfo (const PFilePath &name, PFileInfo &info)
static BOOL SetPermissions (const PFilePath &name, int permissions)

I/O functions

virtual void PrintOn (ostream &strm) const
virtual void ReadFrom (istream &strm)
ostream & operator<< (ostream &strm, const PObject &obj)
istream & operator>> (istream &strm, PObject &obj)

Scattered read/write functions

virtual BOOL Read (const VectorOfSlice &slices)
virtual BOOL Write (const VectorOfSlice &slices)
typedef std::vector< SliceVectorOfSlice

Public Types

enum  PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }
enum  OpenMode { ReadOnly, WriteOnly, ReadWrite }
enum  OpenOptions {
  ModeDefault = -1, MustExist = 0, Create = 1, Truncate = 2,
  Exclusive = 4, Temporary = 8, DenySharedRead = 16, DenySharedWrite = 32

Public Member Functions

Miscellaneous functions
virtual PObjectClone () const
Overrides from class PChannel
virtual BOOL Close ()
virtual PString GetName () const
Overrides from class PObject
Comparison Compare (const PObject &obj) const
Information functions
virtual PChannelGetBaseReadChannel () const
virtual PChannelGetBaseWriteChannel () const
int GetHandle () const
virtual BOOL IsOpen () const
Overrides from class PFile
const PBYTEArray & GetData () const
Reading functions
virtual PINDEX GetLastReadCount () const
PTimeInterval GetReadTimeout () const
virtual void OnReadComplete (void *buf, PINDEX len)
virtual BOOL ReadAsync (void *buf, PINDEX len)
BOOL ReadBlock (void *buf, PINDEX len)
virtual int ReadChar ()
PString ReadString (PINDEX len)
void SetReadTimeout (const PTimeInterval &time)
Writing functions
virtual PINDEX GetLastWriteCount () const
PTimeInterval GetWriteTimeout () const
virtual void OnWriteComplete (const void *buf, PINDEX len)
void SetWriteTimeout (const PTimeInterval &time)
virtual BOOL WriteAsync (const void *buf, PINDEX len)
BOOL WriteChar (int c)
BOOL WriteString (const PString &str)
Overrides from class PFile
off_t GetLength () const
off_t GetPosition () const
BOOL SetLength (off_t len)
BOOL SetPosition (off_t pos, FilePositionOrigin origin=Start)
Overrides from class PObject
virtual PINDEX HashFunction () const
 PMemoryFile (const PBYTEArray &data)
 PMemoryFile ()
Overrides from class PChannel
virtual BOOL Read (void *buf, PINDEX len)
virtual BOOL Write (const void *buf, PINDEX len)

Static Public Member Functions

static BOOL ConvertOSError (int libcReturnValue, Errors &lastError, int &osError)

Protected Member Functions

virtual BOOL ConvertOSError (int libcReturnValue, ErrorGroup group=LastGeneralError)
int PXClose ()
BOOL PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)
int ReadCharWithTimeout (PTimeInterval &timeout)
BOOL ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)
BOOL SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)

Protected Attributes

PString channelName
PBYTEArray data
Errors lastErrorCode [NumErrorGroups+1]
 The platform independant error code.
int lastErrorNumber [NumErrorGroups+1]
 The operating system error number (eg as returned by errno).
PINDEX lastReadCount
 Number of byte last read by the Read() function.
PINDEX lastWriteCount
 Number of byte last written by the Write() function.
int os_handle
 The operating system file handle return by standard open() function.
PFilePath path
 The fully qualified path name for the file.
off_t position
PXBlockType px_lastBlockType
PMutex px_selectMutex
PMutex px_threadMutex
PMutex px_writeMutex
PTimeInterval readTimeout
 Timeout for read operations.
BOOL removeOnClose
 File is to be removed when closed.
PTimeInterval writeTimeout
 Timeout for write operations.

Private Member Functions

 PCLASSINFO (PMemoryFile, PFile)

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

Generated by  Doxygen 1.6.0   Back to index