Software and Services, Portable Libraries  2019.Mar.01
A library for managing digital certificates
SoftwareAndServices::Library::Common::Base Class Reference

A portable I/O library for reading and writing binary data. More...

#include "<SaS/Common/Base.hpp>"

+ Inheritance diagram for SoftwareAndServices::Library::Common::Base:
+ Collaboration diagram for SoftwareAndServices::Library::Common::Base:

Public Types

enum  endian_t { BigEndian_t = 4321, LittleEndian_t = 1234, NetworkByteOrder_t = BigEndian_t, UnknownEndian_t = 0 }
 enumerated types for BIG_ENDIAN and LITTLE_ENDIAN. More...
 
enum  open_flags { O_CREAT_t = O_CREAT, O_RDONLY_t = O_RDONLY, O_WRONLY_t = O_WRONLY }
 Open a file flags. More...
 
enum  Whence_t { SEEK_SET_t = SEEK_SET, SEEK_CUR_t = SEEK_CUR, SEEK_END_t = SEEK_END }
 How to apply the offset variable in the lseek() member function. More...
 

Public Member Functions

 Base (const int fd, const char *aFileName)
 File Constructor. More...
 
 Base (const char *buffer)
 File Constructor. More...
 
 Base (const wchar_t *buffer)
 File Constructor. More...
 
 Base (File *file=nullptr)
 Base - Constructor. More...
 
virtual ~Base ()
 Base - Destructor. More...
 
bool AtEOF ()
 
uint32_t CanRead ()
 
bool close ()
 Close the file. More...
 
bool Close ()
 Close the file. More...
 
virtual InstanceCount_t decInstance () const
 Decrement the instance. More...
 
void DoIoInNetworkByteOrder (bool NetOrder)
 Set a flag indicating if we write in native, or network byte order. More...
 
bool Encrypt (bool DoEncryption)
 Turn encryption ON/OFF. More...
 
bool Flush ()
 Force write all data. More...
 
const char * GetBuffer () const
 
uint32_t GetBufferSize () const
 
int GetFd ()
 
const char * GetFileName () const
 
virtual InstanceCount_t getInstance () const
 
virtual InstanceCount_t incInstance () const
 Increment the instance. More...
 
bool IsMMapped () const
 
bool Keys (const char *Private, const char *Public)
 Set the TLS/SSL public/private key to use. More...
 
char LookNext ()
 
off_t Lseek (off_t offset, Whence_t whence)
 Seek to a position in this File. More...
 
bool Mkdir (const char *path, mode_t mode)
 Make a directory, and all path components when needed. More...
 
bool NextIsLwsp ()
 
bool open (const char *file, int RWmode)
 Open the named file for reading or writing. More...
 
bool Open (const char *file, int RWmode)
 Open the named file for reading or writing. More...
 
void operator delete (void *data)
 This class supports instance counting, so we override the delete() operator and only the final delete removes the class. More...
 
int Printf (const char *Format,...)
 printf like method, wrapper for vprintf() More...
 
uint32_t Read (void *data, const uint32_t Length, bool force=true)
 Read with our without blocking. More...
 
bool readBool (bool *Value)
 Read a Boolean from a file. More...
 
bool readChar (char *Value)
 Read a 'char' from a File. More...
 
bool readDouble (double *Value)
 Read an 'double' from a File. More...
 
bool readEndian (endian_t *Value)
 Read a endian_t from a file. More...
 
bool readFloat (float *Value)
 Read an 'float' from a File. More...
 
bool readInt (int *Value)
 Read an 'int' from a File. More...
 
bool ReadLine (uint8_t **Results, uint32_t &Length, bool Force=true, bool DiscardEol=true)
 Read with our without blocking. More...
 
bool readLong (long *Value)
 Read an 'long' from a File. More...
 
bool readLongLong (long long *Value)
 Read an 'long long' from a File. More...
 
bool readShort (short *Value)
 Read a 'short' from a File. More...
 
bool readString (char **Value)
 Read a 'string (char*)' from a File. More...
 
bool readToken (Token_t *token)
 Read a 'Token_t' from a File. More...
 
bool readUChar (unsigned char *Value)
 Read a 'unsigned char' from a File. More...
 
bool readUInt (unsigned int *Value)
 Read an 'unsigned int' from a File. More...
 
bool readULong (unsigned long *Value)
 Read an 'unsigned long' from a File. More...
 
bool readULongLong (unsigned long long *Value)
 Read an 'unsigned long long' from a File. More...
 
bool readUShort (unsigned short *Value)
 Read an 'unsigned short' from a File. More...
 
off_t Tell ()
 
void ThrowExceptions (bool Enable)
 Turn on C++ exceptions. More...
 
bool WeAreNetworkByteOrder ()
 Determine the current network byte order configuration. More...
 
uint32_t Write (const void *data, const uint32_t Length)
 Write to File. More...
 
uint32_t Write (const char *data)
 Write a C-string (const char*) to File. More...
 
bool writeBool (bool Value)
 Write a Boolean to File. More...
 
bool writeChar (char Value)
 Write a 'char' to File. More...
 
bool writeDouble (double Value)
 Write an 'double to File. More...
 
bool writeEndian (endian_t Value)
 Write a endian_t to File. More...
 
bool writeFloat (float Value)
 Write an 'float to File. More...
 
bool writeInt (int Value)
 Write an 'int' to File. More...
 
bool writeLong (long Value)
 Write an 'long' to File. More...
 
bool writeLongLong (long long Value)
 Write an 'long long' to File. More...
 
bool writeShort (short Value)
 Write an 'short' to File. More...
 
bool writeString (const char *Value)
 Write a 'string (char*)' to File. More...
 
bool writeToken (const Token_t token)
 Write a 'Token_t' to File. More...
 
bool writeUChar (unsigned char Value)
 Write an 'unsigned char' to File. More...
 
bool writeUInt (unsigned int Value)
 Write an 'unsigned int' to File. More...
 
bool writeULong (unsigned long Value)
 Write an 'unsigned long' to File. More...
 
bool writeULongLong (unsigned long long Value)
 Write an 'unsigned long long' to File. More...
 
bool writeUShort (unsigned short Value)
 Write an 'unsigned short' to File. More...
 

Static Public Member Functions

static const char * GetTopDir ()
 
static bool Lock (const char *fileName)
 Lock the file - block until locked. More...
 
static bool LockFileOnly (const char *fileName)
 Lock the file - block until locked. More...
 
static bool SetTopDir (const char *theTop)
 
static bool Trylock (const char *fileName)
 Try to lock the file. More...
 
static bool Unlock (const char *fileName)
 UnLock the file - block until unlocked. More...
 
static bool UnlockFileOnly (const char *fileName)
 UnLock the file - block until unlocked. More...
 

Static Public Attributes

static const char * DefaultTopDir
 The current topDir. More...
 
static const char * NewTmpFileExt
 defult extension for temporary files created. More...
 

Detailed Description

A portable I/O library for reading and writing binary data.

Write/read the data type to/from storage.

It takes the object and the token and data, and call the correct writeObject(File *) or writeObject(File *) method to save the data.

The 'all' flag, forces writeArray to write ALL objects. By default, _Method_t (and others? check Base.cc for authoritative source) is not written to storage as it is a process time action and not a state object.

Author
Software and Services LLC

Definition at line 125 of file Base.hpp.

Member Enumeration Documentation

◆ endian_t

enumerated types for BIG_ENDIAN and LITTLE_ENDIAN.

Definition at line 234 of file Base.hpp.

◆ open_flags

Open a file flags.

NOTE: It is NOT possible to open a file for both READ and WRITE.

Enumerator
O_CREAT_t 

Open a file and create if it does not exist.

O_RDONLY_t 

Open the calendar for READ only.

O_WRONLY_t 

Open for WRITE only.

Definition at line 217 of file Base.hpp.

◆ Whence_t

How to apply the offset variable in the lseek() member function.

Enumerator
SEEK_SET_t 

From the beginning.

SEEK_CUR_t 

From the current position.

SEEK_END_t 

From the end of the file.

Definition at line 560 of file File.hpp.

Constructor & Destructor Documentation

◆ Base() [1/4]

SoftwareAndServices::Library::Common::Base::Base ( const int  fd,
const char *  aFileName 
)

File Constructor.

Parameters
fdOpen using a file descriptor to connect to a file name.
aFileNameThe file name to use.

◆ Base() [2/4]

SoftwareAndServices::Library::Common::Base::Base ( const char *  buffer)
explicit

File Constructor.

Parameters
bufferInitialize to point to buffer.

◆ Base() [3/4]

SoftwareAndServices::Library::Common::Base::Base ( const wchar_t *  buffer)
explicit

File Constructor.

Parameters
bufferInitialize to point to buffer - using wide characters.

◆ Base() [4/4]

SoftwareAndServices::Library::Common::Base::Base ( File file = nullptr)

Base - Constructor.

Parameters
fileOpen using a File object.

◆ ~Base()

virtual SoftwareAndServices::Library::Common::Base::~Base ( )
virtual

Base - Destructor.

Member Function Documentation

◆ AtEOF()

bool SoftwareAndServices::Library::Common::File::AtEOF ( )
inherited
Returns
TRUE when at end of file.

◆ CanRead()

uint32_t SoftwareAndServices::Library::Common::File::CanRead ( )
inherited
Returns
How many octets can be read without blocking.

◆ close()

bool SoftwareAndServices::Library::Common::Base::close ( )

Close the file.

This is a wrapper for File::close, we need to track the (File*). If this object did not open the file, then this method does nothing.

Returns
TRUE if closed, else FALSE with errno set.

◆ Close()

bool SoftwareAndServices::Library::Common::File::Close ( )
inherited

Close the file.

Returns
TRUE if closed, else FALSE with errno set.

◆ decInstance()

virtual InstanceCount_t SoftwareAndServices::Library::Common::instance< File >::decInstance ( ) const
inlinevirtualinherited

Decrement the instance.

Returns
The instance count, after decrementing it.

Definition at line 129 of file instance.hpp.

◆ DoIoInNetworkByteOrder()

void SoftwareAndServices::Library::Common::Base::DoIoInNetworkByteOrder ( bool  NetOrder)

Set a flag indicating if we write in native, or network byte order.

Parameters
NetOrderWhen TRUE, the reads/writes will be in network byte order. byte order. When FALSE, the reads/writes will be in system byte order (which may or might not be in network byte order).

◆ Encrypt()

bool SoftwareAndServices::Library::Common::File::Encrypt ( bool  DoEncryption)
inherited

Turn encryption ON/OFF.

Parameters
DoEncryptionWhen true, I/O encrypted is turned ON. When false, encryption is turned OFF.
Returns
true if the Private and Public keys are valid. And encryption is turned ON (or OFF).

◆ Flush()

bool SoftwareAndServices::Library::Common::File::Flush ( )
inherited

Force write all data.

Returns
true if everything was written. False when their was an underlying write error.

◆ GetBuffer()

const char* SoftwareAndServices::Library::Common::File::GetBuffer ( ) const
inherited
Returns
a pointer to the MMAP()'d buffer, or nullptr if not MMAPed.

◆ GetBufferSize()

uint32_t SoftwareAndServices::Library::Common::File::GetBufferSize ( ) const
inherited
Returns
The size of the MMAPed buffer, or -1 if not MMAPed.

◆ GetFd()

int SoftwareAndServices::Library::Common::File::GetFd ( )
inherited
Returns
The OS FD or handle for this file object. Or -1 on error.

◆ GetFileName()

const char* SoftwareAndServices::Library::Common::File::GetFileName ( ) const
inherited
Returns
The file name used during open, or nullptr if none (socket).

◆ getInstance()

virtual InstanceCount_t SoftwareAndServices::Library::Common::instance< File >::getInstance ( ) const
inlinevirtualinherited
Returns
The current instance count.

Definition at line 118 of file instance.hpp.

◆ GetTopDir()

static const char* SoftwareAndServices::Library::Common::File::GetTopDir ( )
staticinherited
Returns
Get the top most directory - license file creation.

◆ incInstance()

virtual InstanceCount_t SoftwareAndServices::Library::Common::instance< File >::incInstance ( ) const
inlinevirtualinherited

Increment the instance.

Returns
The instance value, after incrementing it.

Definition at line 109 of file instance.hpp.

◆ IsMMapped()

bool SoftwareAndServices::Library::Common::File::IsMMapped ( ) const
inherited
Returns
TRUE if this is File is MMAPed.

◆ Keys()

bool SoftwareAndServices::Library::Common::File::Keys ( const char *  Private,
const char *  Public 
)
inherited

Set the TLS/SSL public/private key to use.

This MUST be set before any encrypted I/O can be used. Once set, the reads and writes are encrypted. The data in the buffer is not encrypted. Only when it reads to or writes from the file descriptor.

Parameters
PrivateThe PEM private key to use.
PublicThe PEM public key to use.
Returns
true if the keys are accepted.

◆ Lock()

static bool SoftwareAndServices::Library::Common::File::Lock ( const char *  fileName)
staticinherited

Lock the file - block until locked.

Parameters
fileNameThe file (directory) to lock.
Returns
TRUE if locked.

◆ LockFileOnly()

static bool SoftwareAndServices::Library::Common::File::LockFileOnly ( const char *  fileName)
staticinherited

Lock the file - block until locked.

Parameters
fileNameThe file (no directory) to lock.
Returns
TRUE if locked.

◆ LookNext()

char SoftwareAndServices::Library::Common::File::LookNext ( )
inherited
Returns
The next octet. This is a look only method. To get the character you still have to Read it.

◆ Lseek()

off_t SoftwareAndServices::Library::Common::File::Lseek ( off_t  offset,
Whence_t  whence 
)
inherited

Seek to a position in this File.

Parameters
offsetHow many octets.
whenceFrom beginning (SEEK_SET_t), from current position (SEEK_CUR_t), from end (SEEK_END_t).
Returns
The current position.

◆ Mkdir()

bool SoftwareAndServices::Library::Common::File::Mkdir ( const char *  path,
mode_t  mode 
)
inherited

Make a directory, and all path components when needed.

Parameters
pathWhat path to make as a directory.
modeThe directory mode.
Returns
TRUE if made, else FALSE with errno set.

◆ NextIsLwsp()

bool SoftwareAndServices::Library::Common::File::NextIsLwsp ( )
inherited
Returns
TRUE if the next character is a SPACE or TAB

◆ open()

bool SoftwareAndServices::Library::Common::Base::open ( const char *  file,
int  RWmode 
)

Open the named file for reading or writing.

This is just a wrapper for File::open(), so we can snag the File handle after the open.

Parameters
fileThe file to open.
RWmodeO_RDONLY -or- O_WRONLY.
Returns
TRUE if opened, else FALSE with errno set.
See also
File::open

◆ Open()

bool SoftwareAndServices::Library::Common::File::Open ( const char *  file,
int  RWmode 
)
inherited

Open the named file for reading or writing.

Parameters
fileThe file to open.
RWmodeO_RDONLY -or- O_WRONLY.
Returns
TRUE if opened, else FALSE with errno set.

◆ operator delete()

void SoftwareAndServices::Library::Common::Base::operator delete ( void *  data)

This class supports instance counting, so we override the delete() operator and only the final delete removes the class.

This class has at least two base classes that also have instance counting, so we need to override the default one and do our own.

Parameters
dataThe 'this' pointer'.

◆ Printf()

int SoftwareAndServices::Library::Common::File::Printf ( const char *  Format,
  ... 
)
inherited

printf like method, wrapper for vprintf()

Parameters
FormatThe printf format string.
...The values to be processed.
Returns
The number of characters written.

◆ Read()

uint32_t SoftwareAndServices::Library::Common::File::Read ( void *  data,
const uint32_t  Length,
bool  force = true 
)
inherited

Read with our without blocking.

Parameters
dataWhere to put the data.
LengthRead up to this much data.
forceWhen TRUE, block until Length octets are read. When FALSE, read what you can without blocking, then return the number of octets read. Can also return if socket is closed or end of file.
Exceptions
Errorwith EINVAL when ThrowErrors(true) was set and an attempt to read past the buffer end occurs.
Returns
The number of octets read.

◆ readBool()

bool SoftwareAndServices::Library::Common::Base::readBool ( bool *  Value)

Read a Boolean from a file.

Parameters
ValueA pointer to where to store the read value.

◆ readChar()

bool SoftwareAndServices::Library::Common::Base::readChar ( char *  Value)

Read a 'char' from a File.

(Not this is NOT reading a string, it reads one char and places it where Value is pointing).

Parameters
ValueA pointer to where to store the read value.

◆ readDouble()

bool SoftwareAndServices::Library::Common::Base::readDouble ( double *  Value)

Read an 'double' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readEndian()

bool SoftwareAndServices::Library::Common::Base::readEndian ( endian_t Value)

Read a endian_t from a file.

Parameters
ValueA pointer to where to store the read value.

◆ readFloat()

bool SoftwareAndServices::Library::Common::Base::readFloat ( float *  Value)

Read an 'float' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readInt()

bool SoftwareAndServices::Library::Common::Base::readInt ( int *  Value)

Read an 'int' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ ReadLine()

bool SoftwareAndServices::Library::Common::File::ReadLine ( uint8_t **  Results,
uint32_t &  Length,
bool  Force = true,
bool  DiscardEol = true 
)
inherited

Read with our without blocking.

Reads characters until a '\r' or '\n' is found. Also reads the end of line characters.

When DiscardEol is true (the defult): The end of line characters are read from the input, then discarded.

The results will be terminated with a zero (0), so that standard c-string functions will work.

Only the first end of line, or set of end of line will be discarded. This allows empty lines to be detected.

Examples:

  • aline\r The \r will be read and discarded.
  • aline\r\n The \r\n will both be discarded.
  • aline\n\n Only the first \n will be discarded. The second call will result in a zero length line.
  • aline\r\n\r\n Only the first set of \r\n will be discarded. The second call will result in a zero length line.

When DiscardEold is false: The end of line characters are read from the input and returned.

Only the first end of line, or set of end of line will be returned. This allows empty lines to be detected.

Examples:

  • aline\r The \r will be read and returned.
  • aline\r\n The \r\n will both be returned.
  • aline\n\n Only the first \n will be returned. The second call will result in a zero length line.
  • aline\r\n\r\n Only the first set of \r\n will be returned. The second call will result in a zero length line.
Parameters
ResultsWhere to put the data. This is a pointer to a pointer. The value (*Results) will be updated to point to the newly allocated storage for the line.
LengthRead up to this much data. When zero, keep reading until end of line. The results will be one octet larger than Length, to accomidate the terminating zero.

On return, Length will be updated with the length of the string. The returned Length will not count the terminating zero. Ex: The string "abcd" will return 4.

Parameters
DiscardEolWhen true (the default), this method will read the end of line characters, and discard them. When false, the end of line characters will be read, and appended to Results.
ForceWhen TRUE, block until Length octets are read. When FALSE, read what you can without blocking, then return the number of octets read. Can also return if socket is closed or end of file.
Exceptions
Errorwith EINVAL when ThrowErrors(true) was set and an attempt to read past the buffer end occurs.
Returns
True if end of line was found before Length or end of file.
Note
Caller is responsible for deleteing (*Results) when the data is no longer used.

◆ readLong()

bool SoftwareAndServices::Library::Common::Base::readLong ( long *  Value)

Read an 'long' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readLongLong()

bool SoftwareAndServices::Library::Common::Base::readLongLong ( long long *  Value)

Read an 'long long' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readShort()

bool SoftwareAndServices::Library::Common::Base::readShort ( short *  Value)

Read a 'short' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readString()

bool SoftwareAndServices::Library::Common::Base::readString ( char **  Value)

Read a 'string (char*)' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readToken()

bool SoftwareAndServices::Library::Common::Base::readToken ( Token_t *  token)

Read a 'Token_t' from a File.

Parameters
tokenA pointer to where to store the read value.

◆ readUChar()

bool SoftwareAndServices::Library::Common::Base::readUChar ( unsigned char *  Value)

Read a 'unsigned char' from a File.

(Not this is NOT reading a string, it reads one char and places it where Value is pointing).

Parameters
ValueA pointer to where to store the read value.

◆ readUInt()

bool SoftwareAndServices::Library::Common::Base::readUInt ( unsigned int *  Value)

Read an 'unsigned int' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readULong()

bool SoftwareAndServices::Library::Common::Base::readULong ( unsigned long *  Value)

Read an 'unsigned long' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readULongLong()

bool SoftwareAndServices::Library::Common::Base::readULongLong ( unsigned long long *  Value)

Read an 'unsigned long long' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ readUShort()

bool SoftwareAndServices::Library::Common::Base::readUShort ( unsigned short *  Value)

Read an 'unsigned short' from a File.

Parameters
ValueA pointer to where to store the read value.

◆ SetTopDir()

static bool SoftwareAndServices::Library::Common::File::SetTopDir ( const char *  theTop)
staticinherited
Parameters
theTopthe top most directory to use - license file creation.
Returns
TRUE if set.

◆ Tell()

off_t SoftwareAndServices::Library::Common::File::Tell ( )
inherited
Returns
The current position in the File.

◆ ThrowExceptions()

void SoftwareAndServices::Library::Common::File::ThrowExceptions ( bool  Enable)
inherited

Turn on C++ exceptions.

The I/O methods may throw (Error*) on error.

Parameters
EnableWhen true, enables C++ exceptions. When Enable is false, no C++ exceptions will be thrown.

◆ Trylock()

static bool SoftwareAndServices::Library::Common::File::Trylock ( const char *  fileName)
staticinherited

Try to lock the file.

Parameters
fileNameThe file (directory) to lock.
Returns
TRUE if locked, return FALSE if already locked.

◆ Unlock()

static bool SoftwareAndServices::Library::Common::File::Unlock ( const char *  fileName)
staticinherited

UnLock the file - block until unlocked.

Parameters
fileNameThe file (directory) to unlock.
Returns
TRUE if unlocked.

◆ UnlockFileOnly()

static bool SoftwareAndServices::Library::Common::File::UnlockFileOnly ( const char *  fileName)
staticinherited

UnLock the file - block until unlocked.

Parameters
fileNameThe file (NO directory) to unlock.
Returns
TRUE if unlocked.

◆ WeAreNetworkByteOrder()

bool SoftwareAndServices::Library::Common::Base::WeAreNetworkByteOrder ( )

Determine the current network byte order configuration.

Returns
TRUE if the object is configured for network byte order.

◆ Write() [1/2]

uint32_t SoftwareAndServices::Library::Common::File::Write ( const void *  data,
const uint32_t  Length 
)
inherited

Write to File.

Parameters
dataWhere to get the data that is to be written.
LengthThe number of octets to write.
Returns
The number of octets written.
Exceptions
Errorwith EBIG when ThrowErrors(true) was set and an attempt to write past the user supplied buffer that was set when the File object was constructed.
See also
File(const char * buffer, uint32_t BufferSize)

◆ Write() [2/2]

uint32_t SoftwareAndServices::Library::Common::File::Write ( const char *  data)
inherited

Write a C-string (const char*) to File.

Parameters
dataWhere to get the data that is to be written.
Returns
The number of octets written.
Exceptions
Errorwith EBIG when ThrowErrors(true) was set and an attempt to write past the user supplied buffer that was set when the File object was constructed.
See also
File(const char * buffer, uint32_t BufferSize)

◆ writeBool()

bool SoftwareAndServices::Library::Common::Base::writeBool ( bool  Value)

Write a Boolean to File.

Parameters
ValueThe Boolean value to write.

◆ writeChar()

bool SoftwareAndServices::Library::Common::Base::writeChar ( char  Value)

Write a 'char' to File.

Parameters
ValueThe value to write.

◆ writeDouble()

bool SoftwareAndServices::Library::Common::Base::writeDouble ( double  Value)

Write an 'double to File.

Parameters
ValueThe value to write.

◆ writeEndian()

bool SoftwareAndServices::Library::Common::Base::writeEndian ( endian_t  Value)

Write a endian_t to File.

Parameters
ValueThe endian_t value to write.

◆ writeFloat()

bool SoftwareAndServices::Library::Common::Base::writeFloat ( float  Value)

Write an 'float to File.

Parameters
ValueThe value to write.

◆ writeInt()

bool SoftwareAndServices::Library::Common::Base::writeInt ( int  Value)

Write an 'int' to File.

Parameters
ValueThe value to write.

◆ writeLong()

bool SoftwareAndServices::Library::Common::Base::writeLong ( long  Value)

Write an 'long' to File.

Parameters
ValueThe value to write.

◆ writeLongLong()

bool SoftwareAndServices::Library::Common::Base::writeLongLong ( long long  Value)

Write an 'long long' to File.

Parameters
ValueThe value to write.

◆ writeShort()

bool SoftwareAndServices::Library::Common::Base::writeShort ( short  Value)

Write an 'short' to File.

Parameters
ValueThe value to write.

◆ writeString()

bool SoftwareAndServices::Library::Common::Base::writeString ( const char *  Value)

Write a 'string (char*)' to File.

Parameters
ValueThe value to write.

◆ writeToken()

bool SoftwareAndServices::Library::Common::Base::writeToken ( const Token_t  token)

Write a 'Token_t' to File.

Parameters
tokenThe value to write.

◆ writeUChar()

bool SoftwareAndServices::Library::Common::Base::writeUChar ( unsigned char  Value)

Write an 'unsigned char' to File.

Parameters
ValueThe value to write.

◆ writeUInt()

bool SoftwareAndServices::Library::Common::Base::writeUInt ( unsigned int  Value)

Write an 'unsigned int' to File.

Parameters
ValueThe value to write.

◆ writeULong()

bool SoftwareAndServices::Library::Common::Base::writeULong ( unsigned long  Value)

Write an 'unsigned long' to File.

Parameters
ValueThe value to write.

◆ writeULongLong()

bool SoftwareAndServices::Library::Common::Base::writeULongLong ( unsigned long long  Value)

Write an 'unsigned long long' to File.

Parameters
ValueThe value to write.

◆ writeUShort()

bool SoftwareAndServices::Library::Common::Base::writeUShort ( unsigned short  Value)

Write an 'unsigned short' to File.

Parameters
ValueThe value to write.

Member Data Documentation

◆ DefaultTopDir

const char* SoftwareAndServices::Library::Common::File::DefaultTopDir
staticinherited

The current topDir.

Definition at line 661 of file File.hpp.

◆ NewTmpFileExt

const char* SoftwareAndServices::Library::Common::File::NewTmpFileExt
staticinherited

defult extension for temporary files created.

Definition at line 667 of file File.hpp.


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