Rudiments

Public Member Functions | Static Public Member Functions | List of all members
file Class Reference

Inherits filedescriptor.

Inherited by device, and url.

## Public Member Functions
| file ()
| file (const file &f)
file & | operator= (const file &f)
virtual | ~file ()
virtual bool | open (const char *name, int32_t flags)
virtual bool | open (const char *name, int32_t flags, mode_t perms)
virtual bool | create (const char *name, mode_t perms)
virtual char * | getContents ()
virtual ssize_t | getContents (unsigned char *buffer, size_t buffersize)
virtual bool | truncate () const
virtual bool | truncate (off64_t size) const
virtual off64_t | getCurrentPosition () const
virtual off64_t | setPositionRelativeToBeginning (off64_t offset) const
virtual off64_t | setPositionRelativeToCurrent (off64_t offset) const
virtual off64_t | setPositionRelativeToEnd (off64_t offset) const
virtual bool | tryLockFile (int16_t type) const
virtual bool | lockFile (int16_t type) const
virtual bool | checkLockFile (int16_t type, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | unlockFile () const
virtual bool | tryLockRegion (int16_t type, off64_t start, off64_t len) const
virtual bool | lockRegion (int16_t type, off64_t start, off64_t len) const
virtual bool | checkLockRegion (int16_t type, off64_t start, off64_t len, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | unlockRegion (off64_t start, off64_t len) const
virtual bool | tryLockFromCurrent (int16_t type, off64_t len) const
virtual bool | tryLockFromCurrent (int16_t type, off64_t start, off64_t len) const
virtual bool | lockFromCurrent (int16_t type, off64_t len) const
virtual bool | lockFromCurrent (int16_t type, off64_t start, off64_t len) const
virtual bool | checkLockFromCurrent (int16_t type, off64_t len, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | checkLockFromCurrent (int16_t type, off64_t start, off64_t len, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | unlockFromCurrent (off64_t len) const
virtual bool | unlockFromCurrent (off64_t start, off64_t len) const
virtual bool | tryLockFromEnd (int16_t type, off64_t len) const
virtual bool | tryLockFromEnd (int16_t type, off64_t start, off64_t len) const
virtual bool | lockFromEnd (int16_t type, off64_t len) const
virtual bool | lockFromEnd (int16_t type, off64_t start, off64_t len) const
virtual bool | checkLockFromEnd (int16_t type, off64_t len, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | checkLockFromEnd (int16_t type, off64_t start, off64_t len, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | unlockFromEnd (off64_t len) const
virtual bool | unlockFromEnd (off64_t start, off64_t len) const
virtual bool | tryLockRemainder (int16_t type, off64_t start) const
virtual bool | lockRemainder (int16_t type, off64_t start) const
virtual bool | checkLockRemainder (int16_t type, off64_t start, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | unlockRemainder (off64_t start) const
virtual bool | tryLockRemainderFromCurrent (int16_t type) const
virtual bool | tryLockRemainderFromCurrent (int16_t type, off64_t start) const
virtual bool | lockRemainderFromCurrent (int16_t type) const
virtual bool | lockRemainderFromCurrent (int16_t type, off64_t start) const
virtual bool | checkLockRemainderFromCurrent (int16_t type, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | checkLockRemainderFromCurrent (int16_t type, off64_t start, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | unlockRemainderFromCurrent () const
virtual bool | unlockRemainderFromCurrent (off64_t start) const
virtual bool | tryLockRemainderFromEnd (int16_t type) const
virtual bool | tryLockRemainderFromEnd (int16_t type, off64_t start) const
virtual bool | lockRemainderFromEnd (int16_t type) const
virtual bool | lockRemainderFromEnd (int16_t type, off64_t start) const
virtual bool | checkLockRemainderFromEnd (int16_t type, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | checkLockRemainderFromEnd (int16_t type, off64_t start, int16_t *conftype, int16_t *confwhence, off64_t *confstart, off64_t *conflen) const
virtual bool | unlockRemainderFromEnd () const
virtual bool | unlockRemainderFromEnd (off64_t start) const
virtual bool | sequentialAccess (off64_t start, size_t len) const
virtual bool | randomAccess (off64_t start, size_t len) const
virtual bool | onlyOnce (off64_t start, size_t len) const
virtual bool | willNeed (off64_t start, size_t len) const
virtual bool | wontNeed (off64_t start, size_t len) const
virtual bool | normalAccess (off64_t start, size_t len) const
virtual bool | reserve (off64_t start, size_t len) const
virtual bool | sync () const
virtual bool | dataSync () const
virtual void | dontGetCurrentPropertiesOnOpen ()
virtual void | getCurrentPropertiesOnOpen ()
virtual bool | getCurrentProperties ()
virtual mode_t | getPermissions () const
virtual uid_t | getOwnerUserId () const
virtual gid_t | getOwnerGroupId () const
virtual off64_t | getSize () const
virtual blksize_t | getBlockSize () const
virtual blkcnt_t | getBlockCount () const
virtual int32_t | isSocket () const
virtual int32_t | isSymbolicLink () const
virtual int32_t | isRegularFile () const
virtual int32_t | isBlockDevice () const
virtual int32_t | isDirectory () const
virtual int32_t | isCharacterDevice () const
virtual int32_t | isFifo () const
virtual time_t | getLastAccessTime () const
virtual time_t | getLastModificationTime () const
virtual time_t | getLastChangeTime () const
virtual dev_t | getDevice () const
virtual dev_t | getDeviceType () const
virtual uint64_t | getInode () const
virtual nlink_t | getNumberOfHardLinks () const
virtual bool | setPermissions (mode_t perms) const
virtual bool | changeOwner (const char *newuser, const char *newgroup) const
virtual bool | changeOwner (uid_t uid, gid_t gid) const
virtual bool | canChangeOwner () const
virtual int64_t | maxLinks () const
virtual void * | getInternalFileStatisticsStructure ()
Public Member Functions inherited from filedescriptor
| filedescriptor ()
| filedescriptor (const filedescriptor &f)
filedescriptor & | operator= (const filedescriptor &f)
virtual | ~filedescriptor ()
virtual bool | close ()
int32_t | getFileDescriptor () const
void | setFileDescriptor (int32_t filedesc)
int32_t | duplicate () const
bool | duplicate (int32_t newfd) const
void | setSecurityContext (securitycontext *ctx)
securitycontext * | getSecurityContext ()
virtual bool | supportsBlockingNonBlockingModes ()
virtual bool | useNonBlockingMode () const
virtual bool | useBlockingMode () const
virtual bool | isUsingNonBlockingMode () const
ssize_t | write (uint16_t number)
ssize_t | write (uint32_t number)
ssize_t | write (uint64_t number)
ssize_t | write (int16_t number)
ssize_t | write (int32_t number)
ssize_t | write (int64_t number)
ssize_t | write (float number)
ssize_t | write (double number)
ssize_t | write (unsigned char character)
ssize_t | write (char character)
ssize_t | write (bool value)
ssize_t | write (const unsigned char *string)
ssize_t | write (const char *string)
ssize_t | write (const unsigned char *string, size_t size)
ssize_t | write (const char *string, size_t length)
ssize_t | write (const void *buffer, size_t size)
ssize_t | write (uint16_t number, int32_t sec, int32_t usec)
ssize_t | write (uint32_t number, int32_t sec, int32_t usec)
ssize_t | write (uint64_t number, int32_t sec, int32_t usec)
ssize_t | write (int16_t number, int32_t sec, int32_t usec)
ssize_t | write (int32_t number, int32_t sec, int32_t usec)
ssize_t | write (int64_t number, int32_t sec, int32_t usec)
ssize_t | write (float number, int32_t sec, int32_t usec)
ssize_t | write (double number, int32_t sec, int32_t usec)
ssize_t | write (unsigned char character, int32_t sec, int32_t usec)
ssize_t | write (char character, int32_t sec, int32_t usec)
ssize_t | write (bool value, int32_t sec, int32_t usec)
ssize_t | write (const unsigned char *string, int32_t sec, int32_t usec)
ssize_t | write (const char *string, int32_t sec, int32_t usec)
ssize_t | write (const unsigned char *string, size_t size, int32_t sec, int32_t usec)
ssize_t | write (const char *string, size_t size, int32_t sec, int32_t usec)
ssize_t | write (const void *buffer, size_t size, int32_t sec, int32_t usec)
size_t | printf (const char *format,...)
size_t | printf (const char *format, va_list *argp)
void | safePrint (unsigned char c)
void | safePrint (const unsigned char *str)
void | safePrint (const unsigned char *str, int32_t length)
void | safePrint (char c)
void | safePrint (const char *str)
void | safePrint (const char *str, int32_t length)
void | printBits (unsigned char value)
void | printBits (uint16_t value)
void | printBits (uint32_t value)
void | printBits (uint64_t value)
void | printBits (char value)
void | printBits (int16_t value)
void | printBits (int32_t value)
void | printBits (int64_t value)
void | printBits (const unsigned char *bits, uint64_t size)
ssize_t | read (uint16_t *buffer)
ssize_t | read (uint32_t *buffer)
ssize_t | read (uint64_t *buffer)
ssize_t | read (int16_t *buffer)
ssize_t | read (int32_t *buffer)
ssize_t | read (int64_t *buffer)
ssize_t | read (float *buffer)
ssize_t | read (double *buffer)
ssize_t | read (unsigned char *buffer)
ssize_t | read (char *buffer)
ssize_t | read (bool *buffer)
ssize_t | read (unsigned char *buffer, size_t size)
ssize_t | read (char *buffer, size_t length)
ssize_t | read (void *buf, size_t size)
ssize_t | read (char **buffer, const char *terminator)
ssize_t | read (char **buffer, const char *terminator, size_t maxbytes)
ssize_t | read (uint16_t *buffer, int32_t sec, int32_t usec)
ssize_t | read (uint32_t *buffer, int32_t sec, int32_t usec)
ssize_t | read (uint64_t *buffer, int32_t sec, int32_t usec)
ssize_t | read (int16_t *buffer, int32_t sec, int32_t usec)
ssize_t | read (int32_t *buffer, int32_t sec, int32_t usec)
ssize_t | read (int64_t *buffer, int32_t sec, int32_t usec)
ssize_t | read (float *buffer, int32_t sec, int32_t usec)
ssize_t | read (double *buffer, int32_t sec, int32_t usec)
ssize_t | read (unsigned char *buffer, int32_t sec, int32_t usec)
ssize_t | read (char *buffer, int32_t sec, int32_t usec)
ssize_t | read (bool *buffer, int32_t sec, int32_t usec)
ssize_t | read (unsigned char *buffer, size_t size, int32_t sec, int32_t usec)
ssize_t | read (char *buffer, size_t size, int32_t sec, int32_t usec)
ssize_t | read (void *buf, size_t size, int32_t sec, int32_t usec)
ssize_t | read (char **buffer, const char *terminator, int32_t sec, int32_t usec)
ssize_t | read (char **buffer, const char *terminator, size_t maxbytes, int32_t sec, int32_t usec)
ssize_t | read (char **buffer, const char *terminator, size_t maxbytes, char escapechar, int32_t sec, int32_t usec)
int32_t | waitForNonBlockingRead (int32_t sec, int32_t usec) const
int32_t | waitForNonBlockingWrite (int32_t sec, int32_t usec) const
void | retryInterruptedReads ()
void | dontRetryInterruptedReads ()
bool | getRetryInterruptedReads () const
void | retryInterruptedWrites ()
void | dontRetryInterruptedWrites ()
bool | getRetryInterruptedWrites () const
void | retryInterruptedWaits ()
void | dontRetryInterruptedWaits ()
bool | getRetryInterruptedWaits () const
void | retryInterruptedFcntl ()
void | dontRetryInterruptedFcntl ()
bool | getRetryInterruptedFcntl () const
void | retryInterruptedIoctl ()
void | dontRetryInterruptedIoctl ()
bool | getRetryInterruptedIoctl () const
void | allowShortReads ()
void | dontAllowShortReads ()
void | allowShortWrites ()
void | dontAllowShortWrites ()
virtual bool | passFileDescriptor (int32_t fd)
virtual bool | receiveFileDescriptor (int32_t *fd)
virtual bool | passSocket (int32_t sock)
virtual bool | receiveSocket (int32_t *sock)
void | translateByteOrder ()
void | dontTranslateByteOrder ()
virtual int32_t | fCntl (int32_t command, long arg) const
virtual int32_t | ioCtl (int32_t command, void *arg) const
bool | useNaglesAlgorithm ()
bool | dontUseNaglesAlgorithm ()
bool | setSocketWriteBufferSize (int32_t size)
bool | getSocketWriteBufferSize (int32_t *size)
bool | setSocketReadBufferSize (int32_t size)
bool | getSocketReadBufferSize (int32_t *size)
bool | disableIPv4 ()
bool | enableIPv4 ()
const char * | getType () const
char * | getPeerAddress () const
bool | setWriteBufferSize (ssize_t size) const
bool | flushWriteBuffer (int32_t sec, int32_t usec)
bool | setReadBufferSize (ssize_t size) const
bool | closeOnExec ()
bool | dontCloseOnExec ()
bool | getCloseOnExec ()

## Static Public Member Functions
static bool | createFile (const char *name, mode_t perms)
static bool | createFifo (const char *filename, mode_t perms)
static int32_t | createTemporaryFile (char *templatefilename)
static int32_t | createTemporaryFile (char *templatefilename, mode_t perms)
static bool | createHardLink (const char *oldpath, const char *newpath)
static bool | createSymbolicLink (const char *oldpath, const char *newpath)
static char * | resolveSymbolicLink (const char *filename)
static bool | rename (const char *oldpath, const char *newpath)
static bool | remove (const char *filename)
static bool | truncate (const char *filename)
static bool | truncate (const char *filename, off64_t size)
static char * | getContents (const char *name)
static ssize_t | getContents (const char *name, unsigned char *buffer, size_t buffersize)
static bool | exists (const char *filename)
static bool | readable (const char *filename)
static bool | writeable (const char *filename)
static bool | executable (const char *filename)
static bool | accessible (const char *filename, int32_t mode)
static bool | getLastChangeTime (const char *filename, time_t *ctime)
static bool | setPermissions (const char *filename, mode_t perms)
static bool | changeOwner (const char *filename, const char *newuser, const char *newgroup)
static bool | changeOwner (const char *filename, uid_t uid, gid_t gid)
static bool | canChangeOwner (const char *filename)
static bool | setLastAccessTime (const char *filename, time_t lastaccesstime)
static bool | setLastModificationTime (const char *filename, time_t lastmodtime)
static bool | setLastAccessAndModificationTimes (const char *filename, time_t lastaccesstime, time_t lastmodtime)
static bool | setLastAccessAndModificationTimes (const char *filename)
static char * | dirname (const char *filename)
static char * | basename (const char *filename)
static char * | basename (const char *filename, const char *ext)
static char * | extension (const char *filename)
static char * | eightDotThree (const char *filename)
static key_t | generateKey (const char *filename, int32_t id)
static int64_t | maxLinks (const char *filename)
Static Public Member Functions inherited from filedescriptor
static bool | createPipe (filedescriptor *readfd, filedescriptor *writefd)
static uint16_t | hostToNet (uint16_t value)
static uint32_t | hostToNet (uint32_t value)
static uint64_t | hostToNet (uint64_t value)
static uint16_t | netToHost (uint16_t value)
static uint32_t | netToHost (uint32_t value)
static uint64_t | netToHost (uint64_t value)
static uint16_t | hostToLittleEndian (uint16_t value)
static uint32_t | hostToLittleEndian (uint32_t value)
static uint64_t | hostToLittleEndian (uint64_t value)
static uint16_t | littleEndianToHost (uint16_t value)
static uint32_t | littleEndianToHost (uint32_t value)
static uint64_t | littleEndianToHost (uint64_t value)

## Detailed Description

The file class provides methods for interacting with files and for discovering the properties associated with a file such as permissions, ownership, size, etc.

Many of the static methods are just provided for convenience. Use them if you need to get a a single property or perform a single operation.

If you need to get multiple properties or perform multiple operations, create an instance of the class, call open(), then use the non-static methods.

## Constructor & Destructor Documentation

## ◆ file() [1/2]

file::file | ( |  | ) |

Creates an instance of the file class.

## ◆ file() [2/2]

file::file | ( | const file & | f | ) |

Creates an instance of the file class that is a copy of "f".

## ◆ ~file()

virtual file::~file | ( |  | ) |
| virtual

Deletes this instance of the file class.

## Member Function Documentation

## ◆ accessible()

static bool file::accessible | ( | const char * | filename,
|  | int32_t | mode
| ) |  |
| static

Checks to see if "filename" exists, is readable, is writeable and/or is executable by the user, based on the value of "mode". Mode should be an or'ed combination of F_OK (exists), R_OK (readable), W_OK (writable) and X_OK (executable) flags.

Returns true if the file meets the conditions set by the mode and false otherwise.

## ◆ basename() [1/2]

static char* file::basename | ( | const char * | filename | ) |
| static

Returns the non-directory portion of "filename". This method allocates a buffer internally and returns it. The calling program must deallocate the buffer.

## ◆ basename() [2/2]

static char* file::basename | ( | const char * | filename,
|  | const char * | ext
| ) |  |
| static

Returns the non-directory portion of "filename", truncating "ext". This method allocates a buffer internally and returns it. The calling program must deallocate the buffer.

## ◆ canChangeOwner() [1/2]

virtual bool file::canChangeOwner | ( |  | ) | const
| virtual

Returns true if any of the changeOwner() methods are allowed on "filename" and false otherwise.

## ◆ canChangeOwner() [2/2]

static bool file::canChangeOwner | ( | const char * | filename | ) |
| static

Returns true if any of the changeOwner methods are allowed on "filename" and false otherwise.

## ◆ changeOwner() [1/4]

static bool file::changeOwner | ( | const char * | filename,
|  | const char * | newuser,
|  | const char * | newgroup
| ) |  |
| static

Changes the user and/or group that owns the file. Returns true on success and false on failure.

## ◆ changeOwner() [2/4]

static bool file::changeOwner | ( | const char * | filename,
|  | uid_t | uid,
|  | gid_t | gid
| ) |  |
| static

Changes the user and/or group that owns the file. Returns true on success and false on failure.

## ◆ changeOwner() [3/4]

virtual bool file::changeOwner | ( | const char * | newuser,
|  | const char * | newgroup
| ) |  | const
| virtual

Changes the user and/or group that owns the file. Returns true on success and false on failure.

## ◆ changeOwner() [4/4]

virtual bool file::changeOwner | ( | uid_t | uid,
|  | gid_t | gid
| ) |  | const
| virtual

Changes the user that owns the file. Returns true on success and false on failure.

## ◆ checkLockFile()

virtual bool file::checkLockFile | ( | int16_t | type,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if the entire file can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockFromCurrent() [1/2]

virtual bool file::checkLockFromCurrent | ( | int16_t | type,
|  | off64_t | len,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if "len" bytes of the file starting at the current position in the file can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockFromCurrent() [2/2]

virtual bool file::checkLockFromCurrent | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if "len" bytes of the file starting at the current position in the file plus "start" bytes can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockFromEnd() [1/2]

virtual bool file::checkLockFromEnd | ( | int16_t | type,
|  | off64_t | len,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if "len" bytes of the file starting at the end of the file can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockFromEnd() [2/2]

virtual bool file::checkLockFromEnd | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if "len" bytes of the file starting at the end of the file plus "start" bytes can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockRegion()

virtual bool file::checkLockRegion | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if "len" bytes of the file starting at position "start" (relative to the beginning of the file) can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockRemainder()

virtual bool file::checkLockRemainder | ( | int16_t | type,
|  | off64_t | start,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if the remainder of the file starting at position "start" (relative to the beginning of the file) can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockRemainderFromCurrent() [1/2]

virtual bool file::checkLockRemainderFromCurrent | ( | int16_t | type,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if the remainder of the file starting at the current position can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockRemainderFromCurrent() [2/2]

virtual bool file::checkLockRemainderFromCurrent | ( | int16_t | type,
|  | off64_t | start,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if the remainder of the file starting at the current position plus "start" bytes can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockRemainderFromEnd() [1/2]

virtual bool file::checkLockRemainderFromEnd | ( | int16_t | type,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if the remainder of the file starting at the end can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ checkLockRemainderFromEnd() [2/2]

virtual bool file::checkLockRemainderFromEnd | ( | int16_t | type,
|  | off64_t | start,
|  | int16_t * | conftype,
|  | int16_t * | confwhence,
|  | off64_t * | confstart,
|  | off64_t * | conflen
| ) |  | const
| virtual

Checks to see if the remainder of the file starting at the end plus "start" bytes can be locked or not using the specified lock "type" (F_RDLCK or F_WRLCK) but does not actually attempt to lock the file. Returns true if the lock can be established immediately or false otherwise.

If the lock cannot be established then the "conf" parameters will be populated with the details about a conflicting lock which would prevent the file from being locked. "conftype" will contain the type of the lock (F_RDLCK or F_WRLCK) "confwhence" will contain the offset type of the lock (SEEK_SET, SEEK_CUR or SEEK_END), "confstart" will contain the starting offset for the lock and "conflen" will contain the number of bytes that are locked.

## ◆ create()

virtual bool file::create | ( | const char * | name,
|  | mode_t | perms
| ) |  |
| virtual

Creates the file "name" with permissions "perms". If the file already exists, it will be truncated. Returns true on success and false on failure.

Note that if "perms" is 0 then the method will fail.

Equivalent to calling: open(name,O_CREAT|O_WRONLY|O_TRUNC|O_BINARY,perms)

## ◆ createFifo()

static bool file::createFifo | ( | const char * | filename,
|  | mode_t | perms
| ) |  |
| static

Creates a fifo called "filename" with permissions "perms". Returns true on success and false on failure.

## ◆ createFile()

static bool file::createFile | ( | const char * | name,
|  | mode_t | perms
| ) |  |
| static

Create a file named "name" with permissions "perms". If the file already exists, it will be truncated. Returns true on success and false on failure.

## ◆ createHardLink()

static bool file::createHardLink | ( | const char * | oldpath,
|  | const char * | newpath
| ) |  |
| static

Creates a hard link between "oldpath" and "newpath". Returns true on success and false on failure.

## ◆ createSymbolicLink()

static bool file::createSymbolicLink | ( | const char * | oldpath,
|  | const char * | newpath
| ) |  |
| static

Creates a symbolic link between "oldpath" and "newpath". Returns true on success and false on failure.

## ◆ createTemporaryFile() [1/2]

static int32_t file::createTemporaryFile | ( | char * | templatefilename | ) |
| static

Creates a (presumably) temporary file using "templatefilename" as a template. The last 6 characters of "templatefilename" must be XXXXXX and "templatefilename" will be modified to contain the name of the file that was actually created.

Opens and returns the file descriptor handle of the file on success and -1 on failure.

## ◆ createTemporaryFile() [2/2]

static int32_t file::createTemporaryFile | ( | char * | templatefilename,
|  | mode_t | perms
| ) |  |
| static

Creates a temporary file using "templatefilename" as a template. The last 6 characters of "templatefilename" must be XXXXXX and "templatefilename" will be modified to contain the name of the file that was actually created.

Sets the permissions of the file to "perms". If permissions cannot be set then the file is removed and the call fails.

Opens and returns the file descriptor handle of the file on success and -1 on failure.

## ◆ dataSync()

virtual bool file::dataSync | ( |  | ) | const
| virtual

On most filesystems, changes to files are often cached in system ram, this methods causes those changes to be immediately copied to the storage medium that the file resides on.

This method differs from sync() in that it does not wait until file metadata such as last-access or last-modification times to be written before it returns.

Returns true on success and false on failure.

Note that if a hard disk has on-board write cache enabled, this method only assures that the changes has been copied into the disk's write cache, not necessarily to the disk itself.

## ◆ dirname()

static char* file::dirname | ( | const char * | filename | ) |
| static

Returns the directory portion of "filename". This method allocates a buffer internally and returns it. The calling program must deallocate the buffer.

## ◆ dontGetCurrentPropertiesOnOpen()

virtual void file::dontGetCurrentPropertiesOnOpen | ( |  | ) |
| virtual

Causes the open() and create() methods to call getCurrentProperties() internally so other methods of this class such as getSize() will return valid data about the file immediately. This is the default behavior.

## ◆ eightDotThree()

static char* file::eightDotThree | ( | const char * | filename | ) |
| static

Translates the basename of "filename" to an 8.3 format, performing substitutions in the same way that Windows does. This method allocates a buffer internally and returns it. The calling program must deallocate the buffer.

## ◆ executable()

static bool file::executable | ( | const char * | filename | ) |
| static

Returns true if "filename" is executable by the user or false otherwise.

## ◆ exists()

static bool file::exists | ( | const char * | filename | ) |
| static

Returns true if the file exists and false otherwise.

## ◆ extension()

static char* file::extension | ( | const char * | filename | ) |
| static

Returns the portion of "filename" after the last dot, including the dot, or an empty string if the filename contains no dot. The output should be suitable to be passed in as the "ext" parameter when calling basename().

## ◆ generateKey()

static key_t file::generateKey | ( | const char * | filename,
|  | int32_t | id
| ) |  |
| static

Generates a key based on "filename" and the least signifigant 8 bits of id (which must be non-zero) suitable for use with semaphores, shared memory segments and message queues.

## ◆ getBlockCount()

virtual blkcnt_t file::getBlockCount | ( |  | ) | const
| virtual

Returns the number of blocks allocated for the file or -1 for systems don't support this.

## ◆ getBlockSize()

virtual blksize_t file::getBlockSize | ( |  | ) | const
| virtual

Returns the blocksize to use for most efficient I/O with the file or -1 for systems don't support this.

## ◆ getContents() [1/4]

virtual char* file::getContents | ( |  | ) |
| virtual

Allocates a string large enough to accommodate the contents of the currently opened file, reads the contents of the file into the string and returns the string. The string must be freed by the calling program.

Note: The contents returned by this method are as-is. No end-of-line translation is performed.

If the file contains no data, then an empty string is returned. If an error occurs then a NULL is returned.

## ◆ getContents() [2/4]

static char* file::getContents | ( | const char * | name | ) |
| static

Allocates a string large enough to accommodate the contents of the file "name" , reads the contents of the file into the string, terminates it with a NULL and returns the string. The string must be freed by the calling program.

Note: The contents returned by this method are as-is. No end-of-line translation is performed.

If the file contains no data, then an empty string is returned. If an error occurs then a NULL is returned.

## ◆ getContents() [3/4]

static ssize_t file::getContents | ( | const char * | name,
|  | unsigned char * | buffer,
|  | size_t | buffersize
| ) |  |
| static

Reads the contents of the file "name" into "buffer" of size "buffersize". If the file is larger than "buffersize" then only "buffersize" bytes of the file will be read into "buffer".

Note: The contents returned by this method are as-is. No end-of-line translation is performed.

Returns the number of bytes copied into "buffer" or -1 on error.

## ◆ getContents() [4/4]

virtual ssize_t file::getContents | ( | unsigned char * | buffer,
|  | size_t | buffersize
| ) |  |
| virtual

Reads the contents of the currently open file into "buffer" of size "buffersize". If the file is larger than "buffersize" then only "buffersize" bytes of the file will be read into "buffer".

Note: The contents returned by this method are as-is. No end-of-line translation is performed.

Returns the number of bytes copied into "buffer" or -1 on error.

## ◆ getCurrentPosition()

virtual off64_t file::getCurrentPosition | ( |  | ) | const
| virtual

Returns the position (relative to the beginning of the file) at which the next read or write will occur, or -1 on failure.

## ◆ getCurrentProperties()

virtual bool file::getCurrentProperties | ( |  | ) |
| virtual

Refreshes the current file properties as returned by getSize(), getPermissions(), etc.

Returns true on success and false on failure.

## ◆ getCurrentPropertiesOnOpen()

virtual void file::getCurrentPropertiesOnOpen | ( |  | ) |
| virtual

Causes the open() and create() methods to not to call getCurrentProperties() internally. This offers a small performance improvement which can become significant if you intend to open lots of files but don't need to know the size or any other properties about them.

If this method is called and a method such as getSize() is called afterwards, then it will call getCurrentProperties() internally.

## ◆ getDevice()

virtual dev_t file::getDevice | ( |  | ) | const
| virtual

Returns the device of the file.

## ◆ getDeviceType()

virtual dev_t file::getDeviceType | ( |  | ) | const
| virtual

Returns the device type of the file.

## ◆ getInode()

virtual uint64_t file::getInode | ( |  | ) | const
| virtual

Returns the base inode of the file.

## ◆ getInternalFileStatisticsStructure()

virtual void* file::getInternalFileStatisticsStructure | ( |  | ) |
| virtual

Returns a pointer to the file stats structure used internally. (struct stat * on unix)

## ◆ getLastAccessTime()

virtual time_t file::getLastAccessTime | ( |  | ) | const
| virtual

Returns the time of last access of the file.

## ◆ getLastChangeTime() [1/2]

virtual time_t file::getLastChangeTime | ( |  | ) | const
| virtual

Returns the time of last change of the file.

Change time IS affected by changing file permissions, ownership or creating links.

## ◆ getLastChangeTime() [2/2]

static bool file::getLastChangeTime | ( | const char * | filename,
|  | time_t * | ctime
| ) |  |
| static

Sets "ctime" to the last change time of "filename". Returns true on success and false on failure.

Change time IS affected by changing file permissions, ownership or creating links.

## ◆ getLastModificationTime()

virtual time_t file::getLastModificationTime | ( |  | ) | const
| virtual

Returns the time of last modification of the file.

Modification time IS NOT affected by changing file permissions, ownership or creating links.

## ◆ getNumberOfHardLinks()

virtual nlink_t file::getNumberOfHardLinks | ( |  | ) | const
| virtual

Returns the number of hard links to the file.

## ◆ getOwnerGroupId()

virtual gid_t file::getOwnerGroupId | ( |  | ) | const
| virtual

Returns the group id of the file's owner.

## ◆ getOwnerUserId()

virtual uid_t file::getOwnerUserId | ( |  | ) | const
| virtual

Returns the user id of the file's owner.

## ◆ getPermissions()

virtual mode_t file::getPermissions | ( |  | ) | const
| virtual

Returns the permissions settings for the file.

## ◆ getSize()

virtual off64_t file::getSize | ( |  | ) | const
| virtual

Returns the number of bytes in the file.

## ◆ isBlockDevice()

virtual int32_t file::isBlockDevice | ( |  | ) | const
| virtual

Returns 1 if the file is a block device, 0 if it's not or -1 on error.

## ◆ isCharacterDevice()

virtual int32_t file::isCharacterDevice | ( |  | ) | const
| virtual

Returns 1 if the file is a character device, 0 if it's not or -1 on error.

## ◆ isDirectory()

virtual int32_t file::isDirectory | ( |  | ) | const
| virtual

Returns 1 if the file is a directory, 0 if it's not or -1 on error.

## ◆ isFifo()

virtual int32_t file::isFifo | ( |  | ) | const
| virtual

Returns 1 if the file is a fifo, 0 if it's not or -1 on error.

## ◆ isRegularFile()

virtual int32_t file::isRegularFile | ( |  | ) | const
| virtual

Returns 1 if the file is a regular file, 0 if it's not or -1 on error.

## ◆ isSocket()

virtual int32_t file::isSocket | ( |  | ) | const
| virtual

Returns 1 if the file is a socket, 0 if it's not or -1 on error.

## ◆ isSymbolicLink()

virtual int32_t file::isSymbolicLink | ( |  | ) | const
| virtual

Returns 1 if the file is a symbolic link, 0 if it's not or -1 on error.

## ◆ lockFile()

virtual bool file::lockFile | ( | int16_t | type | ) | const
| virtual

Attempts to lock the entire file using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Return true on success or false otherwise.

## ◆ lockFromCurrent() [1/2]

virtual bool file::lockFromCurrent | ( | int16_t | type,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at the current position in the file using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockFromCurrent() [2/2]

virtual bool file::lockFromCurrent | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at the current position in the file plus "start" bytes using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockFromEnd() [1/2]

virtual bool file::lockFromEnd | ( | int16_t | type,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at the end of the file using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockFromEnd() [2/2]

virtual bool file::lockFromEnd | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at the end of the file plus "start" bytes using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockRegion()

virtual bool file::lockRegion | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at position "start" (relative to the beginning of the file) using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockRemainder()

virtual bool file::lockRemainder | ( | int16_t | type,
|  | off64_t | start
| ) |  | const
| virtual

Attempts to lock the remainder of the file starting at position "start" (relative to the beginning of the file) using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockRemainderFromCurrent() [1/2]

virtual bool file::lockRemainderFromCurrent | ( | int16_t | type | ) | const
| virtual

Attempts to lock the remainder of the file starting at the current position using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockRemainderFromCurrent() [2/2]

virtual bool file::lockRemainderFromCurrent | ( | int16_t | type,
|  | off64_t | start
| ) |  | const
| virtual

Attempts to lock the remainder of the file starting at the current position plus "start" bytes using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockRemainderFromEnd() [1/2]

virtual bool file::lockRemainderFromEnd | ( | int16_t | type | ) | const
| virtual

Attempts to lock the remainder of the file starting at the end using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ lockRemainderFromEnd() [2/2]

virtual bool file::lockRemainderFromEnd | ( | int16_t | type,
|  | off64_t | start
| ) |  | const
| virtual

Attempts to lock the remainder of the file starting at the end plus "start" bytes using the specified lock "type" (F_RDLCK or F_WRLCK) and blocks until the lock can be established. Returns true on success or false otherwise.

## ◆ maxLinks() [1/2]

virtual int64_t file::maxLinks | ( |  | ) | const
| virtual

Returns the maximum number of links that can be created to "filename".

## ◆ maxLinks() [2/2]

static int64_t file::maxLinks | ( | const char * | filename | ) |
| static

Returns the maximum number of links that can be created to "filename".

## ◆ normalAccess()

virtual bool file::normalAccess | ( | off64_t | start,
|  | size_t | len
| ) |  | const
| virtual

Advises the kernel that you are going to access the region of the currently open file begining at byte "start", for "len" bytes, normally so the kernel can undo any previously applied optimizations.

Returns true on success and false on failure.

On operating systems don't support this method, it returns true but don't actually do anything.

## ◆ onlyOnce()

virtual bool file::onlyOnce | ( | off64_t | start,
|  | size_t | len
| ) |  | const
| virtual

Advises the kernel that you are going to access the region of the currently open file begining at byte "start", for "len" bytes, only one time so the kernel can perform some optimizations.

Returns true on success and false on failure.

On operating systems don't support this method, it returns true but don't actually do anything.

## ◆ open() [1/2]

virtual bool file::open | ( | const char * | name,
|  | int32_t | flags
| ) |  |
| virtual

Opens the file "name" using "flags".

"flags" may contain one more more of the following flags, or'ed together:

O_RDONLY - Open the file in read-only mode.

O_WRONLY - Open the file in write-only mode.

O_RDWR - Open the file in write-only mode.

O_APPEND - Set the position to the end of the file.

O_TRUNC - Truncate the file. Requires O_WRONLY or O_RDWR.

Many platforms support additional, platform-specific flags.

Note that since this method doesn't allow file permissions to be set, attempts to open the file with the O_CREAT flag (which creates the file if it doesn't exist) will fail.

Returns true on success and false on failure.

## ◆ open() [2/2]

virtual bool file::open | ( | const char * | name,
|  | int32_t | flags,
|  | mode_t | perms
| ) |  |
| virtual

Opens the file "name" using "flags".

"flags" may contain one more more of the following flags, or'ed together:

O_RDONLY - Open the file in read-only mode.

O_WRONLY - Open the file in write-only mode.

O_RDWR - Open the file in write-only mode.

O_APPEND - Set the position to the end of the file.

O_TRUNC - Truncate the file. Requires O_WRONLY or O_RDWR.

O_CREAT - Creates the file if it doesn't exist. See O_EXCL.

O_EXCL - Requires O_CREAT. Causes O_CREAT to fail if the file already exists. Without O_EXCL, O_CREAT will succeed, and just open the file, if the file already exists.

Many platforms support additional, platform-specific flags.

If "flags" contains O_CREAT and the file doesn't already exist, then it will be created with permissions "perms". Note that if "perms" is 0 then the method will fail.

Returns true on success and false on failure.

## ◆ operator=()

file& file::operator= | ( | const file & | f | ) |

Makes this instance of the file class identical to "f".

## ◆ randomAccess()

virtual bool file::randomAccess | ( | off64_t | start,
|  | size_t | len
| ) |  | const
| virtual

Advises the kernel that you are going to access the region of the currently open file begining at byte "start", for "len" bytes, randomly so the kernel can perform some optimizations.

Returns true on success and false on failure.

On operating systems don't support this method, it returns true but don't actually do anything.

## ◆ readable()

static bool file::readable | ( | const char * | filename | ) |
| static

Returns true if "filename" is readable by the user or false otherwise.

## ◆ remove()

static bool file::remove | ( | const char * | filename | ) |
| static

Removes file "filename". Returns true on success and false on failure. (Will not remove a directory).

## ◆ rename()

static bool file::rename | ( | const char * | oldpath,
|  | const char * | newpath
| ) |  |
| static

Renames "oldpath" to "newpath". Returns true on success and false on failure.

## ◆ reserve()

virtual bool file::reserve | ( | off64_t | start,
|  | size_t | len
| ) |  | const
| virtual

Reserves space on the storage medium such that a write to the region starting at "start" and continuing for "len" bytes will not fail due to lack of storage space.

Returns true if the region can be reserved and false otherwise.

## ◆ resolveSymbolicLink()

static char* file::resolveSymbolicLink | ( | const char * | filename | ) |
| static

Returns the pathname of the file that the symbolic link "filename" points to. Returns NULL on failure.

Note that this method allocates a buffer for the path internally and returns it. The calling program must deallocate this buffer.

## ◆ sequentialAccess()

virtual bool file::sequentialAccess | ( | off64_t | start,
|  | size_t | len
| ) |  | const
| virtual

Advises the kernel that you are going to access the region of the currently open file begining at byte "start", for "len" bytes, sequentially so the kernel can perform some optimizations.

Returns true on success and false on failure.

On operating systems don't support this method, it returns true but don't actually do anything.

## ◆ setLastAccessAndModificationTimes() [1/2]

static bool file::setLastAccessAndModificationTimes | ( | const char * | filename | ) |
| static

Overrides the last access and modification times of the file, setting them both to the current system time. Returns true on success and false on failure.

## ◆ setLastAccessAndModificationTimes() [2/2]

static bool file::setLastAccessAndModificationTimes | ( | const char * | filename,
|  | time_t | lastaccesstime,
|  | time_t | lastmodtime
| ) |  |
| static

Overrides the last access and modification times of the file, setting them to "lastaccesstime" and "lastmodtime" respectively. Returns true on success and false on failure.

## ◆ setLastAccessTime()

static bool file::setLastAccessTime | ( | const char * | filename,
|  | time_t | lastaccesstime
| ) |  |
| static

Overrides the last access time of the file, setting it to "lastaccesstime". Returns true on success and false on failure.

## ◆ setLastModificationTime()

static bool file::setLastModificationTime | ( | const char * | filename,
|  | time_t | lastmodtime
| ) |  |
| static

Overrides the last modification time of the file, setting it to "lastaccesstime". Returns true on success and false on failure.

## ◆ setPermissions() [1/2]

static bool file::setPermissions | ( | const char * | filename,
|  | mode_t | perms
| ) |  |
| static

Sets the permissions of the file to "perms". Returns true on success and false on failure.

## ◆ setPermissions() [2/2]

virtual bool file::setPermissions | ( | mode_t | perms | ) | const
| virtual

Sets the permissions of the file to "perms". Returns true on success and false on failure.

## ◆ setPositionRelativeToBeginning()

virtual off64_t file::setPositionRelativeToBeginning | ( | off64_t | offset | ) | const
| virtual

Sets the position (relative to the beginning of the file) at which the next read or write will occur to "offset". Returns that position on success or -1 on failure.

## ◆ setPositionRelativeToCurrent()

virtual off64_t file::setPositionRelativeToCurrent | ( | off64_t | offset | ) | const
| virtual

Advances the position at which the next read or write will occur by "offset" bytes. Returns that position on success or -1 on failure.

## ◆ setPositionRelativeToEnd()

virtual off64_t file::setPositionRelativeToEnd | ( | off64_t | offset | ) | const
| virtual

Sets the position at which the next read or write will occur to the end of the file plus "offset" bytes. Generally, "offset" will be negative though most filesystems allow the creation of files with holes in them and that can be accomplished by using a positive "offset" and then writing data at that position. Returns the position on succes or -1 on failure.

## ◆ sync()

virtual bool file::sync | ( |  | ) | const
| virtual

On most filesystems, changes to files are often cached in system ram, this methods causes those changes (including changes to file metadata such as last-access and last-modifiction times) to be immediately copied to the storage medium that the file resides on.

Returns true on success and false on failure.

Note that if a hard disk has on-board write cache enabled, this method only assures that the changes has been copied into the disk's write cache, not necessarily to the disk itself.

## ◆ truncate() [1/4]

virtual bool file::truncate | ( |  | ) | const
| virtual

Truncates all data in the file, resulting in a file of zero bytes. Returns true on success and false on failure.

## ◆ truncate() [2/4]

static bool file::truncate | ( | const char * | filename | ) |
| static

Truncates the file. Returns true on success and false on failure.

## ◆ truncate() [3/4]

static bool file::truncate | ( | const char * | filename,
|  | off64_t | size
| ) |  |
| static

Truncates the file after the first "size" bytes. Returns true on success and false on failure.

## ◆ truncate() [4/4]

virtual bool file::truncate | ( | off64_t | size | ) | const
| virtual

Truncates all data beyond the first "size" bytes, resulting in a file of "size" bytes. Returns true on success and false on failure.

## ◆ tryLockFile()

virtual bool file::tryLockFile | ( | int16_t | type | ) | const
| virtual

Attempts to lock the entire file using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockFromCurrent() [1/2]

virtual bool file::tryLockFromCurrent | ( | int16_t | type,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at the current position in the file using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockFromCurrent() [2/2]

virtual bool file::tryLockFromCurrent | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at the current position in the file plus "start" bytes using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockFromEnd() [1/2]

virtual bool file::tryLockFromEnd | ( | int16_t | type,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at the end of the file using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockFromEnd() [2/2]

virtual bool file::tryLockFromEnd | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at the the end of the file plus "start" bytes using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockRegion()

virtual bool file::tryLockRegion | ( | int16_t | type,
|  | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to lock "len" bytes of the file starting at position "start" (relative to the beginning of the file) using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockRemainder()

virtual bool file::tryLockRemainder | ( | int16_t | type,
|  | off64_t | start
| ) |  | const
| virtual

Attempts to lock the remainder of the file starting at position "start" (relative to the beginning of the file) using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockRemainderFromCurrent() [1/2]

virtual bool file::tryLockRemainderFromCurrent | ( | int16_t | type | ) | const
| virtual

Attempts to lock the remainder of the file starting at the current position using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockRemainderFromCurrent() [2/2]

virtual bool file::tryLockRemainderFromCurrent | ( | int16_t | type,
|  | off64_t | start
| ) |  | const
| virtual

Attempts to lock the remainder of the file starting at the current position plus "start" bytes using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockRemainderFromEnd() [1/2]

virtual bool file::tryLockRemainderFromEnd | ( | int16_t | type | ) | const
| virtual

Attempts to lock the remainder of the file starting at the end using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ tryLockRemainderFromEnd() [2/2]

virtual bool file::tryLockRemainderFromEnd | ( | int16_t | type,
|  | off64_t | start
| ) |  | const
| virtual

Attempts to lock the remainder of the file starting at the end plus "start" bytes using the specified lock "type" (F_RDLCK or F_WRLCK). Returns true if the lock can be established immediately or false otherwise.

## ◆ unlockFile()

virtual bool file::unlockFile | ( |  | ) | const
| virtual

Attempts to release a previosly established lock and returns true on success or false otherwise.

## ◆ unlockFromCurrent() [1/2]

virtual bool file::unlockFromCurrent | ( | off64_t | len | ) | const
| virtual

Attempts to release a previosly established lock of "len" bytes of the file starting at the current position in the file. Returns true on success or false otherwise.

## ◆ unlockFromCurrent() [2/2]

virtual bool file::unlockFromCurrent | ( | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to release a previosly established lock of "len" bytes of the file starting at the current position in the file plus "start" bytes. Returns true on success or false otherwise.

## ◆ unlockFromEnd() [1/2]

virtual bool file::unlockFromEnd | ( | off64_t | len | ) | const
| virtual

Attempts to release a previosly established lock of "len" bytes of the file starting at the end of the file. Returns true on success or false otherwise.

## ◆ unlockFromEnd() [2/2]

virtual bool file::unlockFromEnd | ( | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to release a previosly established lock of "len" bytes of the file starting at the end of the file plus "start" bytes. Returns true on success or false otherwise.

## ◆ unlockRegion()

virtual bool file::unlockRegion | ( | off64_t | start,
|  | off64_t | len
| ) |  | const
| virtual

Attempts to release a previosly established lock of "len" bytes of the file starting at position "start" (relative to the beginning of the file). Returns true on success or false otherwise.

## ◆ unlockRemainder()

virtual bool file::unlockRemainder | ( | off64_t | start | ) | const
| virtual

Attempts to release a previosly established lock on the remainder of the file, starting at position "start" (relative to the begining of the file). Returns true on success or false otherwise.

## ◆ unlockRemainderFromCurrent() [1/2]

virtual bool file::unlockRemainderFromCurrent | ( |  | ) | const
| virtual

Attempts to release a previosly established lock on the remainder of the file, starting at the current position. Returns true on success or false otherwise.

## ◆ unlockRemainderFromCurrent() [2/2]

virtual bool file::unlockRemainderFromCurrent | ( | off64_t | start | ) | const
| virtual

Attempts to release a previosly established lock on the remainder of the file, starting at the current position plus "start" bytes. Returns true on success or false otherwise.

## ◆ unlockRemainderFromEnd() [1/2]

virtual bool file::unlockRemainderFromEnd | ( |  | ) | const
| virtual

Attempts to release a previosly established lock on the remainder of the file, starting at the end. Returns true on success or false otherwise.

## ◆ unlockRemainderFromEnd() [2/2]

virtual bool file::unlockRemainderFromEnd | ( | off64_t | start | ) | const
| virtual

Attempts to release a previosly established lock on the remainder of the file, starting at the end plus "start" bytes. Returns true on success or false otherwise.

## ◆ willNeed()

virtual bool file::willNeed | ( | off64_t | start,
|  | size_t | len
| ) |  | const
| virtual

Advises the kernel that you are going to access the region of the currently open file begining at byte "start", for "len" bytes, in the near future so the kernel can perform some optimizations.

Returns true on success and false on failure.

On operating systems don't support this method, it returns true but don't actually do anything.

## ◆ wontNeed()

virtual bool file::wontNeed | ( | off64_t | start,
|  | size_t | len
| ) |  | const
| virtual

Advises the kernel that you are not going to access the region of the currently open file begining at byte "start", for "len" bytes, in the near future so the kernel can perform some optimizations.

Returns true on success and false on failure.

On operating systems don't support this method, it returns true but don't actually do anything.

## ◆ writeable()

static bool file::writeable | ( | const char * | filename | ) |
| static

Returns true if "filename" is writeable by the user or false otherwise.