TAO 4.0.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
TAO::Storable_Base Class Referenceabstract

#include <Storable_Base.h>

Inheritance diagram for TAO::Storable_Base:
Inheritance graph
[legend]

Public Types

enum  Storable_State { goodbit = 0 , badbit = 1 , eofbit = 2 , failbit = 4 }
 

Public Member Functions

 Storable_Base (bool use_backup, bool retry_ebadf)
 
virtual ~Storable_Base ()
 
bool use_backup ()
 
bool retry_on_ebadf ()
 
void remove ()
 
virtual int create_backup ()=0
 
virtual int exists ()=0
 
virtual int open ()=0
 
virtual int close ()=0
 
virtual int flock (int whence, int start, int len)=0
 
virtual int funlock (int whence, int start, int len)=0
 
virtual time_t last_changed ()=0
 
void clear (Storable_State state=goodbit)
 
void setstate (Storable_State state)
 
Storable_State rdstate () const
 
bool good () const
 
bool bad () const
 
bool eof () const
 
bool fail () const
 
virtual void rewind ()=0
 
virtual bool flush ()=0
 
virtual int sync ()=0
 
virtual Storable_Base & operator<< (const ACE_CString &)=0
 
virtual Storable_Base & operator>> (ACE_CString &)=0
 
virtual Storable_Base & operator<< (ACE_UINT32)=0
 
virtual Storable_Base & operator>> (ACE_UINT32 &)=0
 
virtual Storable_Base & operator<< (ACE_UINT64)=0
 
virtual Storable_Base & operator>> (ACE_UINT64 &)=0
 
virtual Storable_Base & operator<< (ACE_INT32)=0
 
virtual Storable_Base & operator>> (ACE_INT32 &)=0
 
virtual Storable_Base & operator<< (ACE_INT64)=0
 
virtual Storable_Base & operator>> (ACE_INT64 &)=0
 
virtual Storable_Base & operator<< (const TAO_OutputCDR &cdr)=0
 
virtual size_t write (size_t size, const char *bytes)=0
 
virtual size_t read (size_t size, char *bytes)=0
 
virtual int restore_backup ()=0
 

Static Public Member Functions

static ACE_CString state_as_string (Storable_State state)
 

Static Public Attributes

static bool use_backup_default = false
 
static bool retry_on_ebadf_default = false
 

Protected Member Functions

virtual void do_remove ()=0
 
virtual void remove_backup ()=0
 If a backup file exists, remove it.
 

Protected Attributes

bool use_backup_
 
bool retry_on_ebadf_
 

Private Attributes

Storable_State state_
 

Member Enumeration Documentation

◆ Storable_State

enum TAO::Storable_Base::Storable_State
Enumerator
goodbit 
badbit 
eofbit 
failbit 

Constructor & Destructor Documentation

◆ Storable_Base()

TAO::Storable_Base::Storable_Base ( bool use_backup,
bool retry_ebadf )

◆ ~Storable_Base()

TAO::Storable_Base::~Storable_Base ( )
virtual

Member Function Documentation

◆ bad()

bool TAO::Storable_Base::bad ( ) const

◆ clear()

void TAO::Storable_Base::clear ( Storable_State state = goodbit)

◆ close()

virtual int TAO::Storable_Base::close ( )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ create_backup()

virtual int TAO::Storable_Base::create_backup ( )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ do_remove()

virtual void TAO::Storable_Base::do_remove ( )
protectedpure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ eof()

bool TAO::Storable_Base::eof ( ) const

◆ exists()

virtual int TAO::Storable_Base::exists ( )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ fail()

bool TAO::Storable_Base::fail ( ) const

◆ flock()

virtual int TAO::Storable_Base::flock ( int whence,
int start,
int len )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ flush()

virtual bool TAO::Storable_Base::flush ( )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ funlock()

virtual int TAO::Storable_Base::funlock ( int whence,
int start,
int len )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ good()

bool TAO::Storable_Base::good ( ) const

◆ last_changed()

virtual time_t TAO::Storable_Base::last_changed ( )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ open()

virtual int TAO::Storable_Base::open ( )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator<<() [1/6]

virtual Storable_Base & TAO::Storable_Base::operator<< ( ACE_INT32 )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator<<() [2/6]

virtual Storable_Base & TAO::Storable_Base::operator<< ( ACE_INT64 )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator<<() [3/6]

virtual Storable_Base & TAO::Storable_Base::operator<< ( ACE_UINT32 )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator<<() [4/6]

virtual Storable_Base & TAO::Storable_Base::operator<< ( ACE_UINT64 )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator<<() [5/6]

virtual Storable_Base & TAO::Storable_Base::operator<< ( const ACE_CString & )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator<<() [6/6]

virtual Storable_Base & TAO::Storable_Base::operator<< ( const TAO_OutputCDR & cdr)
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator>>() [1/5]

virtual Storable_Base & TAO::Storable_Base::operator>> ( ACE_CString & )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator>>() [2/5]

virtual Storable_Base & TAO::Storable_Base::operator>> ( ACE_INT32 & )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator>>() [3/5]

virtual Storable_Base & TAO::Storable_Base::operator>> ( ACE_INT64 & )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator>>() [4/5]

virtual Storable_Base & TAO::Storable_Base::operator>> ( ACE_UINT32 & )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ operator>>() [5/5]

virtual Storable_Base & TAO::Storable_Base::operator>> ( ACE_UINT64 & )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ rdstate()

TAO::Storable_Base::Storable_State TAO::Storable_Base::rdstate ( ) const

◆ read()

virtual size_t TAO::Storable_Base::read ( size_t size,
char * bytes )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ remove()

void TAO::Storable_Base::remove ( )

Remove the file that is assumed to not be open. If backup are used, the backup will also be removed.

◆ remove_backup()

virtual void TAO::Storable_Base::remove_backup ( )
protectedpure virtual

If a backup file exists, remove it.

Implemented in TAO::Storable_FlatFileStream.

◆ restore_backup()

virtual int TAO::Storable_Base::restore_backup ( )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ retry_on_ebadf()

bool TAO::Storable_Base::retry_on_ebadf ( )

◆ rewind()

virtual void TAO::Storable_Base::rewind ( )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

◆ setstate()

void TAO::Storable_Base::setstate ( Storable_State state)

◆ state_as_string()

ACE_CString TAO::Storable_Base::state_as_string ( Storable_State state)
static

◆ sync()

virtual int TAO::Storable_Base::sync ( )
pure virtual

Force write of storable data to storage. Returns 0 on success, otherwise EOF

Implemented in TAO::Storable_FlatFileStream.

◆ use_backup()

bool TAO::Storable_Base::use_backup ( )

◆ write()

virtual size_t TAO::Storable_Base::write ( size_t size,
const char * bytes )
pure virtual

Implemented in TAO::Storable_FlatFileStream.

Member Data Documentation

◆ retry_on_ebadf_

bool TAO::Storable_Base::retry_on_ebadf_
protected

◆ retry_on_ebadf_default

bool TAO::Storable_Base::retry_on_ebadf_default = false
static

The process-wide default policy for retiring certain flock operations if an ebadf is returned. This can happen spuriously on nfs mounted file.

◆ state_

Storable_State TAO::Storable_Base::state_
private

◆ use_backup_

bool TAO::Storable_Base::use_backup_
protected

◆ use_backup_default

bool TAO::Storable_Base::use_backup_default = false
static

The process-wide default policy for doing a backup when close () is called. The backup can then be restored if restore_backup () is called. The initial value for the default is false.

The documentation for this class was generated from the following files:
Generated by doxygen 1.10.0