PServiceMacro Class Reference

#include <httpsvc.h>

Inheritance diagram for PServiceMacro:

Collaboration diagram for PServiceMacro:

Public Member Functions
	PServiceMacro (const char *name, PBoolean isBlock)
	PServiceMacro (const PCaselessString &name, PBoolean isBlock)
Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...
virtual PString	Translate (PHTTPRequest &request, const PString &args, const PString &block) const
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	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 Attributes
const char *	macroName
PBoolean	isMacroBlock
PServiceMacro *	link
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Static Protected Attributes
static PServiceMacro *	list

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...
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Constructor & Destructor Documentation

PServiceMacro::PServiceMacro	(	const char *	name,
		PBoolean	isBlock
	)

PServiceMacro::PServiceMacro	(	const PCaselessString &	name,
		PBoolean	isBlock
	)

Member Function Documentation

Comparison PServiceMacro::Compare ( const PObject &  obj ) const

virtual

Compare the two objects and return their relative rank.

This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns

LessThan, EqualTo or GreaterThan according to the relative rank of the objects.

Reimplemented from PObject.

virtual PString PServiceMacro::Translate ( PHTTPRequest &  request, const PString &  args, const PString &  block  ) const

virtual

Member Data Documentation

PBoolean PServiceMacro::isMacroBlock

protected

PServiceMacro* PServiceMacro::link

protected

PServiceMacro* PServiceMacro::list

staticprotected

const char* PServiceMacro::macroName

protected

---

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

• httpsvc.h