GNU CommonC++
Classes | Public Types | Static Public Member Functions | Protected Types | List of all members
ost::File Class Reference

#include <file.h>

Inheritance diagram for ost::File:
ost::Dir ost::RandomFile ost::MappedFile ost::SharedFile ost::ThreadFile

Classes

struct  _fcb
 

Public Types

enum  Error {
  errSuccess = 0 , errNotOpened , errMapFailed , errInitFailed ,
  errOpenDenied , errOpenFailed , errOpenInUse , errReadInterrupted ,
  errReadIncomplete , errReadFailure , errWriteInterrupted , errWriteIncomplete ,
  errWriteFailure , errLockFailure , errExtended
}
 
enum  Access { accessReadOnly = O_RDONLY , accessWriteOnly = O_WRONLY , accessReadWrite = O_RDWR }
 
enum  Open {
  openReadOnly = O_RDONLY , openWriteOnly = O_WRONLY , openReadWrite = O_RDWR , openAppend = O_WRONLY | O_APPEND ,
  openSync = O_RDWR , openTruncate = O_RDWR | O_TRUNC
}
 
enum  Attr { attrInvalid = 0 , attrPrivate = 0400 | 0200 , attrGroup = attrPrivate | 0040 | 0020 , attrPublic = attrGroup | 0004 | 0002 }
 
enum  Mapping { mappedRead = accessReadOnly , mappedWrite = accessWriteOnly , mappedReadWrite = accessReadWrite }
 
enum  Complete { completionImmediate , completionDelayed , completionDeferred }
 
typedef enum Error Error
 
typedef enum Access Access
 
typedef enum Open Open
 
typedef enum Attr Attr
 
typedef enum Complete Complete
 
typedef enum Mapping Mapping
 

Static Public Member Functions

static const char * getExtension (const char *path)
 
static const char * getFilename (const char *path)
 
static char * getFilename (const char *path, char *buffer, size_t size=64)
 
static char * getDirname (const char *path, char *buffer, size_t size=256)
 
static char * getRealpath (const char *path, char *buffer, size_t size=256)
 

Protected Types

typedef struct ost::File::_fcb fcb_t
 

Member Typedef Documentation

◆ Access

typedef enum Access ost::File::Access

◆ Attr

typedef enum Attr ost::File::Attr

◆ Complete

◆ Error

typedef enum Error ost::File::Error

◆ fcb_t

typedef struct ost::File::_fcb ost::File::fcb_t
protected

◆ Mapping

◆ Open

typedef enum Open ost::File::Open

Member Enumeration Documentation

◆ Access

Enumerator
accessReadOnly 
accessWriteOnly 
accessReadWrite 

◆ Attr

Enumerator
attrInvalid 
attrPrivate 
attrGroup 
attrPublic 

◆ Complete

Enumerator
completionImmediate 
completionDelayed 
completionDeferred 

◆ Error

Enumerator
errSuccess 
errNotOpened 
errMapFailed 
errInitFailed 
errOpenDenied 
errOpenFailed 
errOpenInUse 
errReadInterrupted 
errReadIncomplete 
errReadFailure 
errWriteInterrupted 
errWriteIncomplete 
errWriteFailure 
errLockFailure 
errExtended 

◆ Mapping

Enumerator
mappedRead 
mappedWrite 
mappedReadWrite 

◆ Open

Enumerator
openReadOnly 
openWriteOnly 
openReadWrite 
openAppend 
openSync 
openTruncate 

Member Function Documentation

◆ getDirname()

static char * ost::File::getDirname ( const char *  path,
char *  buffer,
size_t  size = 256 
)
static

◆ getExtension()

static const char * ost::File::getExtension ( const char *  path)
static

◆ getFilename() [1/2]

static const char * ost::File::getFilename ( const char *  path)
static

◆ getFilename() [2/2]

static char * ost::File::getFilename ( const char *  path,
char *  buffer,
size_t  size = 64 
)
static

◆ getRealpath()

static char * ost::File::getRealpath ( const char *  path,
char *  buffer,
size_t  size = 256 
)
static

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