A Storable_Base derived class that works with a file stream. More...

#include <Storable_FlatFileStream.h>

Inheritance diagram for TAO::Storable_FlatFileStream:

Collaboration diagram for TAO::Storable_FlatFileStream:

[legend]

Public Member Functions
	Storable_FlatFileStream (const ACE_CString &file, const char *mode, bool use_backup=Storable_Base::use_backup_default, bool retry_on_ebadf=Storable_Base::retry_on_ebadf_default)

virtual	~Storable_FlatFileStream ()

virtual int	exists ()
	Check if a file exists on disk (file is not open)

virtual int	open ()
	Open a file (the remaining methods below all require an open file)

virtual int	reopen ()

virtual int	close ()
	Acquire a file lock.

virtual int	flock (int whence, int start, int len)
	Acquire a file lock.

virtual int	funlock (int whence, int start, int len)
	Release a file lock.

virtual time_t	last_changed ()
	Returns the last time an open file was changed.

virtual void	rewind ()

virtual bool	flush ()

virtual int	sync ()

virtual Storable_Base &	operator<< (const ACE_CString &)

virtual Storable_Base &	operator>> (ACE_CString &)

virtual Storable_Base &	operator<< (ACE_UINT32)

virtual Storable_Base &	operator>> (ACE_UINT32 &)

virtual Storable_Base &	operator<< (ACE_UINT64)

virtual Storable_Base &	operator>> (ACE_UINT64 &)

virtual Storable_Base &	operator<< (ACE_INT32)

virtual Storable_Base &	operator>> (ACE_INT32 &)

virtual Storable_Base &	operator<< (ACE_INT64)

virtual Storable_Base &	operator>> (ACE_INT64 &)

virtual Storable_Base &	operator<< (const TAO_OutputCDR &cdr)

virtual size_t	write (size_t size, const char *bytes)

virtual size_t	read (size_t size, char *bytes)

virtual int	restore_backup ()

Public Member Functions inherited from TAO::Storable_Base
	Storable_Base (bool use_backup, bool retry_ebadf)

virtual	~Storable_Base ()

bool	use_backup ()

bool	retry_on_ebadf ()

void	remove ()

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

Protected Member Functions
virtual void	do_remove ()

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

virtual int	create_backup ()

Private Member Functions
void	throw_on_read_error (Storable_State state)

void	throw_on_write_error (Storable_State state)

ACE_CString	backup_file_name ()

Private Attributes
ACE_OS::ace_flock_t	filelock_

FILE *	fl_

ACE_CString	file_

ACE_CString	mode_

Additional Inherited Members
Public Types inherited from TAO::Storable_Base
enum	Storable_State { goodbit = 0 , badbit = 1 , eofbit = 2 , failbit = 4 }

Static Public Member Functions inherited from TAO::Storable_Base
static ACE_CString	state_as_string (Storable_State state)

Static Public Attributes inherited from TAO::Storable_Base
static bool	use_backup_default = false

static bool	retry_on_ebadf_default = false

Protected Attributes inherited from TAO::Storable_Base
bool	use_backup_

bool	retry_on_ebadf_

Detailed Description

A Storable_Base derived class that works with a file stream.

Constructor & Destructor Documentation

◆ Storable_FlatFileStream()

TAO::Storable_FlatFileStream::Storable_FlatFileStream	(	const ACE_CString &	file,
		const char *	mode,
		bool	use_backup = Storable_Base::use_backup_default,
		bool	retry_on_ebadf = Storable_Base::retry_on_ebadf_default )

◆ ~Storable_FlatFileStream()

TAO::Storable_FlatFileStream::~Storable_FlatFileStream ( )

virtual

Member Function Documentation

◆ backup_file_name()

ACE_CString TAO::Storable_FlatFileStream::backup_file_name ( )

private

◆ close()

int TAO::Storable_FlatFileStream::close ( )

virtual

Acquire a file lock.

Implements TAO::Storable_Base.

◆ create_backup()

int TAO::Storable_FlatFileStream::create_backup ( )

protectedvirtual

Implements TAO::Storable_Base.

◆ do_remove()

void TAO::Storable_FlatFileStream::do_remove ( )

protectedvirtual

Implements TAO::Storable_Base.

◆ exists()

int TAO::Storable_FlatFileStream::exists ( )

virtual

Check if a file exists on disk (file is not open)

Implements TAO::Storable_Base.

◆ flock()

int TAO::Storable_FlatFileStream::flock	(	int	whence,
		int	start,
		int	len )

virtual

Acquire a file lock.

Implements TAO::Storable_Base.

◆ flush()

bool TAO::Storable_FlatFileStream::flush ( )

virtual

Implements TAO::Storable_Base.

◆ funlock()

int TAO::Storable_FlatFileStream::funlock	(	int	whence,
		int	start,
		int	len )

virtual

Release a file lock.

Implements TAO::Storable_Base.

◆ last_changed()

time_t TAO::Storable_FlatFileStream::last_changed ( )

virtual

Returns the last time an open file was changed.

Implements TAO::Storable_Base.

◆ open()

int TAO::Storable_FlatFileStream::open ( )

virtual

Open a file (the remaining methods below all require an open file)

Implements TAO::Storable_Base.

◆ operator<<() [1/6]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator<< ( ACE_INT32 i )

virtual

Implements TAO::Storable_Base.

◆ operator<<() [2/6]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator<< ( ACE_INT64 i )

virtual

Implements TAO::Storable_Base.

◆ operator<<() [3/6]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator<< ( ACE_UINT32 i )

virtual

Implements TAO::Storable_Base.

◆ operator<<() [4/6]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator<< ( ACE_UINT64 i )

virtual

Implements TAO::Storable_Base.

◆ operator<<() [5/6]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator<< ( const ACE_CString & str )

virtual

Implements TAO::Storable_Base.

◆ operator<<() [6/6]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator<< ( const TAO_OutputCDR & cdr )

virtual

Implements TAO::Storable_Base.

◆ operator>>() [1/5]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator>> ( ACE_CString & str )

virtual

Implements TAO::Storable_Base.

◆ operator>>() [2/5]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator>> ( ACE_INT32 & i )

virtual

Implements TAO::Storable_Base.

◆ operator>>() [3/5]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator>> ( ACE_INT64 & i )

virtual

Implements TAO::Storable_Base.

◆ operator>>() [4/5]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator>> ( ACE_UINT32 & i )

virtual

Implements TAO::Storable_Base.

◆ operator>>() [5/5]

TAO::Storable_Base & TAO::Storable_FlatFileStream::operator>> ( ACE_UINT64 & i )

virtual

Implements TAO::Storable_Base.

◆ read()

size_t TAO::Storable_FlatFileStream::read	(	size_t	size,
		char *	bytes )

virtual

Implements TAO::Storable_Base.

◆ remove_backup()

void TAO::Storable_FlatFileStream::remove_backup ( )

protectedvirtual

If a backup file exists, remove it.

Implements TAO::Storable_Base.

◆ reopen()

int TAO::Storable_FlatFileStream::reopen ( )

virtual

When the locked file resides on an NFS mounted volume, occasionally the FD of the opened file becomes stale, when that happens the handle needs to be refreshed and the lock verified

◆ restore_backup()

int TAO::Storable_FlatFileStream::restore_backup ( )

virtual

Implements TAO::Storable_Base.

◆ rewind()

void TAO::Storable_FlatFileStream::rewind ( )

virtual

Implements TAO::Storable_Base.

◆ sync()

int TAO::Storable_FlatFileStream::sync ( )

virtual

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

Implements TAO::Storable_Base.

◆ throw_on_read_error()

void TAO::Storable_FlatFileStream::throw_on_read_error ( Storable_State state )

private

Throw a Storable_Read_Exception if the state is not good due to a read error.

◆ throw_on_write_error()

void TAO::Storable_FlatFileStream::throw_on_write_error ( Storable_State state )

private

Throw a Storable_Write_Exception if the state is not good due to a write error.

◆ write()

size_t TAO::Storable_FlatFileStream::write	(	size_t	size,
		const char *	bytes )

virtual

Implements TAO::Storable_Base.

Member Data Documentation

◆ file_

ACE_CString TAO::Storable_FlatFileStream::file_

private

◆ filelock_

ACE_OS::ace_flock_t TAO::Storable_FlatFileStream::filelock_

private

◆ fl_

FILE* TAO::Storable_FlatFileStream::fl_

private

◆ mode_

ACE_CString TAO::Storable_FlatFileStream::mode_

private

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

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Storable_FlatFileStream()

◆ ~Storable_FlatFileStream()

Member Function Documentation

◆ backup_file_name()

◆ close()

◆ create_backup()

◆ do_remove()

◆ exists()

◆ flock()

◆ flush()

◆ funlock()

◆ last_changed()

◆ open()

◆ operator<<() [1/6]

◆ operator<<() [2/6]

◆ operator<<() [3/6]

◆ operator<<() [4/6]

◆ operator<<() [5/6]

◆ operator<<() [6/6]

◆ operator>>() [1/5]

◆ operator>>() [2/5]

◆ operator>>() [3/5]

◆ operator>>() [4/5]

◆ operator>>() [5/5]

◆ read()

◆ remove_backup()

◆ reopen()

◆ restore_backup()

◆ rewind()

◆ sync()

◆ throw_on_read_error()

◆ throw_on_write_error()

◆ write()

Member Data Documentation

◆ file_

◆ filelock_

◆ fl_

◆ mode_