---

SqContext Class Reference

Maintains the list of SqObjectReference objects. More...

#include <Context.h>

List of all members.

Public Methods
void	AddObjectReference (SqObjectReference *item)
void	RemoveObjectReference (SqObjectReference *item)
void	DeleteAllObjectReference ()
void	ReplaceObjectReference (SqObjectReference *item, SqObjectReference *newItem)
SqObjectReference*	GetFirstObjectReference () const
SqObjectReference*	GetLastObjectReference () const
SqObjectReference*	GetNextObjectReference (SqObjectReference *pos) const
SqObjectReference*	GetPrevObjectReference (SqObjectReference *pos) const
int	GetObjectReferenceCount () const
SqContextManager*	GetContextManager () const
virtual	~SqContext ()
	Destructor method. More...
unsigned long	getNextObjSeq ()
	Increases the object reference sequence number and returns the new value. More...
unsigned short	timeoutRemaining (const time_t *pNow=NULL)
	Returns the number of seconds this context has left to live. More...
const CString&	GetContextKey () const
	Returns the value of member 'm_contextKey'. More...
void	SetContextKey (const CString &rContextKey)
	Set the value of member 'm_contextKey' to 'rContextKey'. More...
unsigned long	GetKey () const
	Returns the value of member 'm_key'. More...
void	SetKey (unsigned long key)
	Set the value of member 'm_key' to 'key'. More...
time_t	GetLastAct () const
	Returns the value of member 'm_lastAct'. More...
void	SetLastAct (time_t lastAct)
	Set the value of member 'm_lastAct' to 'lastAct'. More...
unsigned short	GetTimeout () const
	Returns the value of member 'm_timeout'. More...
void	SetTimeout (unsigned short timeout)
	Set the value of member 'm_timeout' to 'timeout'. More...
const CString&	GetUserData () const
	Returns the value of member 'm_UserData'. More...
void	SetUserData (const CString &rUserData)
	Set the value of member 'm_UserData' to 'rUserData'. More...
SqObjectReference*	FindObjectReference (unsigned long ObjSeq)
Public Attributes
SqContextManager*	_refContextManager
SqContext*	_parentContextManager
SqContext*	_leftContextManager
SqContext*	_rightContextManager
Protected Methods
	SqContext (SqContextManager *pContextManager, unsigned long key, unsigned short timeout)
	Constructor method. More...
Private Methods
void	ConstructorInclude (SqContextManager *pContextManager)
	Method which must be called first in a constructor. More...
void	DestructorInclude ()
	Method which must be called first in a destructor. More...
Private Attributes
SqObjectReference*	_firstObjectReference
int	_countObjectReference
unsigned long	m_key
unsigned short	m_timeout
CString	m_UserData
time_t	m_lastAct
unsigned long	m_ObjSeq
CString	m_contextKey
Friends
class	SqContextManager

---

Detailed Description

Maintains the list of SqObjectReference objects.

Definition at line 45 of file Context.h.

---

Constructor & Destructor Documentation

SqContext::SqContext ( SqContextManager * pContextManager, unsigned long key, unsigned short timeout ) [protected]

Constructor method. Definition at line 53 of file Context.cpp.

SqContext::~SqContext ( ) [virtual]

Destructor method. Definition at line 71 of file Context.cpp.

---

Member Function Documentation

void SqContext::AddObjectReference ( SqObjectReference * item )

Definition at line 208 of file Context.cpp. Referenced by SqObjectReference::ConstructorInclude(), ReplaceObjectReference(), and SqObjectReference::SetObjSeq().

void SqContext::ConstructorInclude ( SqContextManager * pContextManager ) [private]

Method which must be called first in a constructor. Definition at line 128 of file Context.cpp.

void SqContext::DeleteAllObjectReference ( )

Definition at line 341 of file Context.cpp.

void SqContext::DestructorInclude ( ) [private]

Method which must be called first in a destructor. Definition at line 147 of file Context.cpp. Referenced by ~SqContext().

SqObjectReference * SqContext::FindObjectReference ( unsigned long ObjSeq )

Definition at line 159 of file Context.cpp. Referenced by SOAPBridge_ObjectContextManager_i::freeStoredObjectReference(), and SOAPBridge_ObjectContextManager_i::resolveStoredObjectReference().

const CString & SqContext::GetContextKey ( ) const [inline]

Returns the value of member 'm_contextKey'. Definition at line 198 of file Context.h.

SqContextManager * SqContext::GetContextManager ( ) const [inline]

Definition at line 143 of file Context.h.

SqObjectReference * SqContext::GetFirstObjectReference ( ) const

Definition at line 396 of file Context.cpp. Referenced by DeleteAllObjectReference(), DestructorInclude(), and SqContext::ObjectReferenceIterator::IsFirst().

unsigned long SqContext::GetKey ( ) const [inline]

Returns the value of member 'm_key'. Definition at line 218 of file Context.h. Referenced by SqContextManager::AddContext(), SqContextManager::FindContext(), and SqContextManager::ReplaceContext().

time_t SqContext::GetLastAct ( ) const [inline]

Returns the value of member 'm_lastAct'. Definition at line 228 of file Context.h.

SqObjectReference * SqContext::GetLastObjectReference ( ) const

Definition at line 403 of file Context.cpp. Referenced by GetPrevObjectReference(), and SqContext::ObjectReferenceIterator::IsLast().

SqObjectReference * SqContext::GetNextObjectReference ( SqObjectReference * pos ) const

Definition at line 429 of file Context.cpp. Referenced by SqContext::ObjectReferenceIterator::Check(), and SqContext::ObjectReferenceIterator::operator++().

int SqContext::GetObjectReferenceCount ( ) const

Definition at line 515 of file Context.cpp. Referenced by SOAPBridge_ObjectContextManager_i::listStoredIORs(), and SOAPBridge_ContextManager_i::queryContextInfo().

SqObjectReference * SqContext::GetPrevObjectReference ( SqObjectReference * pos ) const

Definition at line 471 of file Context.cpp. Referenced by SqContext::ObjectReferenceIterator::Check(), and SqContext::ObjectReferenceIterator::operator--().

unsigned short SqContext::GetTimeout ( ) const [inline]

Returns the value of member 'm_timeout'. Definition at line 248 of file Context.h. Referenced by SOAPBridge_ContextManager_i::queryContextInfo().

const CString & SqContext::GetUserData ( ) const [inline]

Returns the value of member 'm_UserData'. Definition at line 268 of file Context.h. Referenced by SOAPBridge_ContextManager_i::queryContextInfo().

void SqContext::RemoveObjectReference ( SqObjectReference * item )

Definition at line 264 of file Context.cpp. Referenced by SqObjectReference::DestructorInclude(), ReplaceObjectReference(), and SqObjectReference::SetObjSeq().

void SqContext::ReplaceObjectReference ( SqObjectReference * item, SqObjectReference * newItem )

Definition at line 350 of file Context.cpp.

void SqContext::SetContextKey ( const CString & rContextKey ) [inline]

Set the value of member 'm_contextKey' to 'rContextKey'. Definition at line 208 of file Context.h. Referenced by SqContextManager::CreateContext(), and SqContextManager::SqContextManager().

void SqContext::SetKey ( unsigned long key )

Set the value of member 'm_key' to 'key'. Definition at line 109 of file Context.cpp.

void SqContext::SetLastAct ( time_t lastAct ) [inline]

Set the value of member 'm_lastAct' to 'lastAct'. Definition at line 238 of file Context.h. Referenced by SOAPBridge_ContextManager_i::setContextTimeout(), SOAPBridge_ContextManager_i::setContextUserData(), and storeObjRef().

void SqContext::SetTimeout ( unsigned short timeout ) [inline]

Set the value of member 'm_timeout' to 'timeout'. Definition at line 258 of file Context.h. Referenced by SOAPBridge_ContextManager_i::setContextTimeout().

void SqContext::SetUserData ( const CString & rUserData ) [inline]

Set the value of member 'm_UserData' to 'rUserData'. Definition at line 278 of file Context.h. Referenced by SqContextManager::CreateContext(), and SOAPBridge_ContextManager_i::setContextUserData().

unsigned long SqContext::getNextObjSeq ( )

Increases the object reference sequence number and returns the new value. Definition at line 82 of file Context.cpp. Referenced by storeObjRef().

unsigned short SqContext::timeoutRemaining ( const time_t * pNow = NULL )

Returns the number of seconds this context has left to live. Parameters: pNow   The current time or NULL, in the latter case the function will itself retrieve the current time. Definition at line 94 of file Context.cpp. Referenced by SOAPBridge_ContextManager_i::queryContextInfo().

---

Friends And Related Function Documentation

class SqContextManager [friend]

Definition at line 146 of file Context.h.

---

Member Data Documentation

int SqContext::_countObjectReference [private]

Definition at line 50 of file Context.h.

SqObjectReference * SqContext::_firstObjectReference [private]

Definition at line 49 of file Context.h.

SqContext * SqContext::_leftContextManager

Definition at line 139 of file Context.h.

SqContext * SqContext::_parentContextManager

Definition at line 138 of file Context.h.

SqContextManager * SqContext::_refContextManager

Definition at line 137 of file Context.h.

SqContext * SqContext::_rightContextManager

Definition at line 140 of file Context.h.

unsigned long SqContext::m_ObjSeq [private]

Definition at line 155 of file Context.h.

CString SqContext::m_UserData [private]

Definition at line 153 of file Context.h.

CString SqContext::m_contextKey [private]

Definition at line 156 of file Context.h.

unsigned long SqContext::m_key [private]

Definition at line 151 of file Context.h.

time_t SqContext::m_lastAct [private]

Definition at line 154 of file Context.h.

unsigned short SqContext::m_timeout [private]

Definition at line 152 of file Context.h.

---

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

• Context.h
• Context.cpp

---