sipxportlib  Version 3.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OsFileWnt Class Reference

#include <OsFileWnt.h>

Inheritance diagram for OsFileWnt:
Inheritance graph
[legend]
Collaboration diagram for OsFileWnt:
Collaboration graph
[legend]

Public Member Functions

 OsFileWnt (const OsPathBase &filename)
 
virtual ~OsFileWnt ()
 
OsStatus fileunlock ()
 
OsStatus filelock (const bool wait)
 
OsStatus setLength (unsigned long newLength)
 
OsStatus touch ()
 
virtual OsStatus getFileInfo (OsFileInfoBase &rFileinfo) const
 Get information about a file. More...
 
UtlBoolean isReadonly () const
 
- Public Member Functions inherited from OsFileBase
 OsFileBase (const OsPathBase &filename)
 enumcode: Start - Set position relative to start of file. enumcode: Current - Set position relative to current file position. enumcode: End - Set position relative to end of file. More...
 
virtual ~OsFileBase ()
 
virtual OsStatus open (const int mode=READ_WRITE)
 
virtual OsStatus flush ()
 
virtual OsStatus write (const void *pBuf, unsigned long bufLen, unsigned long &rBytesWritten)
 
virtual OsStatus setPosition (long pos, FilePositionOrigin origin=START)
 
virtual OsStatus remove (UtlBoolean bForce=FALSE)
 
virtual OsStatus rename (const OsPathBase &rNewFilename)
 
virtual OsStatus copy (const OsPathBase &rNewFilename)
 
virtual OsStatus setReadOnly (UtlBoolean isReadOnly)
 
virtual OsStatus getPosition (unsigned long &pos)
 
virtual void getFileName (OsPathBase &rOsPath) const
 
virtual OsStatus read (void *pBuf, unsigned long bufLen, unsigned long &rBytesRead)
 
virtual OsStatus readLine (UtlString &str)
 
virtual UtlBoolean close ()
 
OsStatus getLength (unsigned long &length)
 
FILE * getFileDescriptor ()
 
OsConfigDbgetFileLocks ()
 
UtlBoolean isReadonly () const
 
UtlBoolean exists ()
 
UtlBoolean isEOF ()
 

Static Public Member Functions

static OsTime fileTimeToOsTime (FILETIME ft)
 Convert Windows FILETIME to an OsTime. More...
 
- Static Public Member Functions inherited from OsFileBase
static long openAndRead (const char *filename, UtlString &fileContentsRead)
 Opens and reads the contents of the named file into the given UtlString. More...
 
static long openAndWrite (const char *filename, const UtlString &fileContentsToWrite)
 Opens and write the given UtlString to the named file. More...
 
static long openAndWrite (const char *filename, const char *fileContentsToWrite, unsigned int contentLength)
 Opens and write the given data to the named file. More...
 

Protected Member Functions

 OsFileWnt (const OsFileWnt &rOsFileWnt)
 
OsFileWntoperator= (const OsFileWnt &rhs)
 
- Protected Member Functions inherited from OsFileBase
 OsFileBase (const OsFileBase &rOsFile)
 
OsFileBaseoperator= (const OsFileBase &rhs)
 

Additional Inherited Members

- Public Types inherited from OsFileBase
enum  Mode {
  READ_ONLY = 1, WRITE_ONLY = 2, READ_WRITE = 4, CREATE = 8,
  TRUNCATE = 16, APPEND = 32, FSLOCK = 64, FSLOCK_WAIT = 128
}
 
enum  FilePositionOrigin { START = 0, CURRENT = 1, END = 2 }
 enumcode: FSLOCK - Opens the file exclusively (advisory locking). enumcode: FSLOCK_WAIT - Waits to open the file locked rather than fail. More...
 
- Protected Attributes inherited from OsFileBase
OsMutex fileMutex
 
FILE * mOsFileHandle
 
OsPathBase mFilename
 
int mMode
 

Constructor & Destructor Documentation

OsFileWnt ( const OsPathBase filename)
~OsFileWnt ( )
virtual
OsFileWnt ( const OsFileWnt rOsFileWnt)
protected

Member Function Documentation

OsStatus fileunlock ( )
virtual

Reimplemented from OsFileBase.

OsStatus filelock ( const bool  wait)
virtual

Reimplemented from OsFileBase.

OsStatus setLength ( unsigned long  newLength)
virtual

Reimplemented from OsFileBase.

OsStatus touch ( )
virtual

Reimplemented from OsFileBase.

OsTime fileTimeToOsTime ( FILETIME  ft)
static

Convert Windows FILETIME to an OsTime.

This static function converts a windows FILETIME to a sipX OsTime

Parameters
ft- The Windows FILETIME to convert
Returns
an OsTime representing the FILETIME
OsStatus getFileInfo ( OsFileInfoBase rFileinfo) const
virtual

Get information about a file.

Returns all the relevant info on this file

Parameters
[out]rFileinfo- The object that is filled with the file information.

Implements OsFileBase.

UtlBoolean isReadonly ( ) const
OsFileWnt & operator= ( const OsFileWnt rhs)
protected