PVXMLCache Class Reference

#include <vxml.h>

Inheritance diagram for PVXMLCache:

Collaboration diagram for PVXMLCache:

Public Member Functions
	PVXMLCache ()
virtual bool	Get (const PString &prefix, const PString &key, const PString &suffix, PFilePath &filename)
virtual bool	PutWithLock (const PString &prefix, const PString &key, const PString &suffix, PFile &file)
void	SetDirectory (const PDirectory &directory)
const PDirectory &	GetDirectory () const
Public Member Functions inherited from PSafeObject
	PSafeObject ()
	Create a thread safe object. More...
	PSafeObject (const PSafeObject &other)
	PSafeObject (PSafeObject *indirectLock)
	PSafeObject (PReadWriteMutex &mutex)
	~PSafeObject ()
PBoolean	SafeReference ()
	Increment the reference count for object. More...
PBoolean	SafeDereference ()
	Decrement the reference count for object. More...
__inline bool	LockReadOnly () const
	Lock the object for Read Only access. More...
__inline bool	LockReadOnly (const PDebugLocation &location) const
__inline void	UnlockReadOnly () const
	Release the read only lock on an object. More...
__inline void	UnlockReadOnly (const PDebugLocation &location) const
__inline bool	LockReadWrite () const
	Lock the object for Read/Write access. More...
__inline bool	LockReadWrite (const PDebugLocation &location) const
__inline void	UnlockReadWrite () const
	Release the read/write lock on an object. More...
__inline void	UnlockReadWrite (const PDebugLocation &location) const
void	SafeRemove ()
	Set the removed flag. More...
unsigned	IsSafelyBeingRemoved () const
	Indicate the object is being safely removed. More...
PBoolean	SafelyCanBeDeleted () const
	Determine if the object can be safely deleted. More...
virtual bool	GarbageCollection ()
	Do any garbage collection that may be required by the object so that it may be finally deleted. More...
unsigned	GetSafeReferenceCount () const
	Get count of references to this object. More...
Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
__inline void	SetTraceContextIdentifier (unsigned id)
__inline void	SetTraceContextIdentifier (const PObject &obj)
__inline void	SetTraceContextIdentifier (const PObject *obj)
__inline void	CopyTraceContextIdentifier (PObject &obj) const
__inline void	CopyTraceContextIdentifier (PObject *obj) const
virtual	~PObject ()
__inline const char *	GetClass () const
__inline bool	IsClass (const char *name) const
__inline const PObject *	PTraceObjectInstance () const
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...
virtual PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class. More...
virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...
bool	operator== (const PObject &obj) const
	Compare the two objects. More...
bool	operator!= (const PObject &obj) const
	Compare the two objects. More...
bool	operator< (const PObject &obj) const
	Compare the two objects. More...
bool	operator> (const PObject &obj) const
	Compare the two objects. More...
bool	operator<= (const PObject &obj) const
	Compare the two objects. More...
bool	operator>= (const PObject &obj) const
	Compare the two objects. More...
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
virtual PFilePath	CreateFilename (const PString &prefix, const PString &key, const PString &suffix)
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PDirectory	m_directory
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the Compare() function. More...
Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)
static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject *from)
static __inline const char *	Class ()
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Constructor & Destructor Documentation

PVXMLCache::PVXMLCache

(

)

Member Function Documentation

virtual PFilePath PVXMLCache::CreateFilename ( const PString &  prefix, const PString &  key, const PString &  suffix  )

protectedvirtual

virtual bool PVXMLCache::Get ( const PString &  prefix, const PString &  key, const PString &  suffix, PFilePath &  filename  )

virtual

const PDirectory& PVXMLCache::GetDirectory ( ) const

inline

References m_directory.

virtual bool PVXMLCache::PutWithLock ( const PString &  prefix, const PString &  key, const PString &  suffix, PFile &  file  )

virtual

void PVXMLCache::SetDirectory

(

const PDirectory &

directory

)

Member Data Documentation

PDirectory PVXMLCache::m_directory

protected

Referenced by GetDirectory().

---

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

• vxml.h