ost::RandomFile(3)

📦 version 1.8.1, in ubuntu jammy

💖 ost::RandomFile(3) 💖

okay bestie, welcome to the manual page for ost::RandomFile(3) from the Library Functions Manual — it's giving foundational-base-class energy and honestly? she ate ✨

🌸 NAME 🌸

ost::RandomFile — the whole point of this class is to define a base class for low level random file access that is portable between Win32 and Posix systems. 🦋

✨ SYNOPSIS ✨

#include <file.h>

Inherits ost::Mutex, and ost::File.

Inherited by ost::MappedFile, ost::SharedFile, and ost::ThreadFile.

💅 Public Member Functions 💅

  • virtual ~RandomFile () — destroy a random access file or it's derived class. bye babe 🫶
  • bool initial (void) — this method should be called right after a RandomFile derived object has been created. yes, literally right after, don't skip it 💀
  • off_t getCapacity (void) — get current file capacity.
  • virtual Error restart (void) — this method is commonly used to close and re-open an existing database.
  • Error getErrorNumber (void) — return current error id.
  • char * getErrorString (void) — return current error string.
  • bool operator! (void) — no description given, she's mysterious like that 🙈

🎀 Protected Member Functions 🎀

  • RandomFile (const char *name=NULL) — create an unopened random access file.
  • RandomFile (const RandomFile &rf) — default copy constructor.
  • Error error (Error errid, char *errstr=NULL) — post an error event.
  • Error error (char *err) — post an extended string error message.
  • void setError (bool enable) — used to enable or disable throwing of exceptions on errors.
  • Error setCompletion (Complete mode) — used to set file completion modes.
  • void setTemporary (bool enable) — used to set the temporary attribute for the file.
  • virtual Attr initialize (void) — this method is used to initialize a newly created file as indicated by the 'initial' flag.
  • void final (void) — close the file.

🧚 Protected Attributes 🧚

  • int fd
  • Access access
  • char * pathname
  • struct { unsigned count: 16; bool thrown: 1; bool initial: 1; bool immediate: 1; bool temp: 1; } flags
(Note that these are not member functions.) — yes bestie, we're still claiming them, they're part of the family 💖
  • bool __EXPORT isDir (const char *path)
  • bool __EXPORT isFile (const char *path)
  • bool __EXPORT isDevice (const char *path)
  • bool __EXPORT canAccess (const char *path)
  • bool __EXPORT canModify (const char *path)
  • time_t __EXPORT lastModified (const char *path)
  • time_t __EXPORT lastAccessed (const char *path)

⭐ Additional Inherited Members ⭐

yeah there's more stuff inherited, it's just vibing over there 🦋

👑 Detailed Description 👑

The purpose of this class is to define a base class for low level random file access that is portable between Win32 and Posix systems. fr fr, that's the mission statement.

This class is a foundation both for optimized thread shared and traditional locked file access that is commonly used to build database services, rather than the standard C++ streaming file classes. so like, if you're out here building database services, this is your girl. the standard C++ streaming file classes could never 💅

🌸 Author 🌸

David Sugar dyfet@ostel.com

Portable random disk file access. 🌈

🎀 Constructor & Destructor Documentation 🎀

ost::RandomFile::RandomFile (const char * name = NULL) [protected]

Create an unopened random access file. she's not open yet, she's just existing ✨

ost::RandomFile::RandomFile (const RandomFile & rf) [protected]

Default copy constructor. copy her, she doesn't mind 🫶

virtual ost::RandomFile::~RandomFile () [virtual]

Destroy a random access file or it's derived class. it's giving goodbye era, iconic exit 💀

💜 Member Function Documentation 💜

Error ost::RandomFile::error (char * err) [inline], [protected]

Post an extended string error message.

Returns errExtended. that's the return value bestie, exactly as written

Parameters err error string.

References ost::error().

Error ost::RandomFile::error (Error errid, char * errstr = NULL) [protected]

Post an error event.

Returns error code.

Parameters

  • errid error code.
  • errstr error message string.

void ost::RandomFile::final (void) [protected]

Close the file. periodt. 🎀

off_t ost::RandomFile::getCapacity (void)

Get current file capacity.

Returns total file size.

Error ost::RandomFile::getErrorNumber (void) [inline]

Return current error id.

Returns last error identifier set.

char* ost::RandomFile::getErrorString (void) [inline]

Return current error string.

Returns last error string set.

bool ost::RandomFile::initial (void)

This method should be called right after a RandomFile derived object has been created. This method will invoke initialize if the object is newly created, and set file access permissions appropriately.

Returns true if file had to be initialized. 🌈

virtual Attr ost::RandomFile::initialize (void) [protected], [virtual]

This method is used to initialize a newly created file as indicated by the 'initial' flag. This method also returns the file access permissions that should be associated with the file. This method should never be called directly, but is instead used to impliment the 'Initial' method. Typically one would use this to build an empty database shell when a previously empty database file is created.

okay listen — "should never be called directly" — I said what I said, do NOT call her directly, she's got a whole Initial method as her spokesperson 💅

Returns access, or attrInvalid if should be removed.

bool ost::RandomFile::operator! (void)

no description here either, she's just out here existing 🙈

virtual Error ost::RandomFile::restart (void) [virtual]

This method is commonly used to close and re-open an existing database. This may be used when the database has been unlinked and an external process provides a new one to use.

Reimplemented in ost::SharedFile, and ost::ThreadFile.

Error ost::RandomFile::setCompletion (Complete mode) [protected]

Used to set file completion modes.

Returns errSuccess if okay. ✨

Parameters mode completion mode.

void ost::RandomFile::setError (bool enable) [inline], [protected]

Used to enable or disable throwing of exceptions on errors.

Parameters enable true if errors will be thrown.

void ost::RandomFile::setTemporary (bool enable) [inline], [protected]

Used to set the temporary attribute for the file. Temporary files are automatically deleted when closed. so like, she deletes herself. self-care honestly 🫶

Parameters enable true for marking as temporary.

  • bool __EXPORT canAccess (const char * path) [related]
  • bool __EXPORT canModify (const char * path) [related]
  • bool __EXPORT isDevice (const char * path) [related]
  • bool __EXPORT isDir (const char * path) [related]
  • bool __EXPORT isFile (const char * path) [related]
  • time_t __EXPORT lastAccessed (const char * path) [related]
  • time_t __EXPORT lastModified (const char * path) [related]

yes, they're "related", not members, we already said that, but they're still invited to the party 💖

🧚 Member Data Documentation 🧚

  • Access ost::RandomFile::access [protected]
  • unsigned ost::RandomFile::count
  • int ost::RandomFile::fd [protected]
  • struct { ... } ost::RandomFile::flags [protected]
  • bool ost::RandomFile::immediate
  • bool ost::RandomFile::initial
  • char* ost::RandomFile::pathname [protected]
  • bool ost::RandomFile::temp
  • bool ost::RandomFile::thrown

🌈 Author 🌈

Generated automatically by Doxygen for GNU CommonC++ from the source code. not me being auto-generated 💀

and that's the whole page bestie!! 🎀 this one came from GNU CommonC++, dated Sun Dec 27 2020 — ily, go read your files randomly and portably, mwah 💋 👑

📦 where this page comes from