Data structure that stores all information about the currently open Mix channels. More...

Public Member Functions
	CAFirstMixChannelList ()
	~CAFirstMixChannelList ()
fmHashTableEntry *	add (CAMuxSocket pMuxSocket, const UINT8 peerIP[4], CAQueue pQueueSend, UINT8 controlChannelKeyRecv, UINT8 controlChannelKeySent)
	Adds a new TCP/IP connection (a new user) to the channel list.
SINT32	addChannel (CAMuxSocket pMuxSocket, HCHANNEL channelIn, CASymCipher pCipher, HCHANNEL *channelOut)
	Adds a new channel for a given connection to the channel list.
fmChannelListEntry *	get (CAMuxSocket *pMuxSocket, HCHANNEL channelIn)
	Returns the information for a given Input-Channel-ID.
fmHashTableEntry *	popTimeoutEntry ()
fmHashTableEntry *	popTimeoutEntry (bool a_bForce)
bool	isTimedOut (fmHashTableEntry *pHashTableEntry)
bool	isKickoutForced (fmHashTableEntry *pHashTableEntry)
void	setKickoutForced (fmHashTableEntry *pHashTableEntry, bool kickoutForced)
bool	forceKickout (fmHashTableEntry pHashTableEntry, const XERCES_CPP_NAMESPACE::DOMDocument pErrDoc)
	forces a kickout for this entry if the entry is still valid and sends an errorMessage via the control channel belonging to the entry.
SINT32	pushTimeoutEntry (fmHashTableEntry *pHashTableEntry, bool kickoutForced=!KICKOUT_FORCED)
	adds the entry to the timeout queue with mutex
SINT32	remove (CAMuxSocket *pMuxSocket)
	Removes all channels, which belongs to the given connection and the connection itself from the list.
SINT32	removeChannel (CAMuxSocket *pMuxSocket, HCHANNEL channelIn)
	Removes a single channel from the list.
fmHashTableEntry *	getFirst ()
	Gets the first connection of all connections in the list.
fmHashTableEntry *	getNext ()
	Gets the next entry in the connections-list.
fmHashTableEntry *	get (CAMuxSocket *pMuxSocket)
	Returns the general data stored for a given Socket (user)
fmChannelListEntry *	getFirstChannelForSocket (CAMuxSocket *pMuxSocket)
	Gets the first channel for a given connection.
fmChannelListEntry *	getNextChannel (fmChannelListEntry *pEntry)
	Gets the next channel for a given connection.
fmChannelListEntry *	get (HCHANNEL channelOut)
	Gets the in-channel and all associated information for the given out-channel.
void	setDelayParameters (UINT32 unlimitTraffic, UINT32 bucketGrow, UINT32 intervall)
void	decDelayBuckets (UINT32 delayBucketID)
bool	hasDelayBuckets (UINT32 delayBucketID)
Static Public Member Functions
static SINT32	test ()
Private Member Functions
SINT32	removeFromTimeoutList (fmHashTableEntry *pHashTableEntry)
SINT32	pushTimeoutEntry_internal (fmHashTableEntry *pHashTableEntry, bool kickoutForced=!KICKOUT_FORCED)
	adds the entry to the timeout queue
bool	isKickoutForced_internal (fmHashTableEntry *pHashTableEntry)
void	setKickoutForced_internal (fmHashTableEntry *pHashTableEntry, bool kickoutForced)
fmHashTableEntry *	popTimeoutEntry_internal (bool a_bForce)
UINT32	countTimeoutEntries ()
fmChannelListEntry *	get_intern_without_lock (HCHANNEL channelOut)
	Gets the in-channel and all associated information for the given out-channel.
bool	isTimedOut_internal (fmHashTableEntry *pHashTableEntry)
Private Attributes
LP_fmHashTableEntry *	m_HashTable
	The Hash-Table of all connections.
LP_fmChannelListEntry *	m_HashTableOutChannels
	The Hash-Table of all out-channels.
fmHashTableEntry *	m_listHashTableHead
	Pointer to the head of a list of all connections.
fmHashTableEntry *	m_listHashTableNext
	Next Element in the enumeration of all connections.
fmHashTableEntry *	m_listTimoutHead
	Pointer to the head of the timout list of all connections.
fmHashTableEntry *	m_listTimoutFoot
CAMutex	m_Mutex
	This mutex is used in all functions and makes them thread safe.
volatile UINT32 **	m_pDelayBuckets
CAThread *	m_pThreadDelayBucketsLoop
CAMutex *	m_pMutexDelayChannel
bool	m_bDelayBucketsLoopRun
volatile UINT32	m_u32DelayChannelUnlimitTraffic
volatile UINT32	m_u32DelayChannelBucketGrow
volatile UINT32	m_u32DelayChannelBucketGrowIntervall
Static Private Attributes
static const SINT32	EXPIRATION_TIME_SECS = 300
Friends
THREAD_RETURN	fml_loopDelayBuckets (void *)

Detailed Description

Data structure that stores all information about the currently open Mix channels.

See [FirstMixChannelList] for more information.

Constructor & Destructor Documentation

CAFirstMixChannelList::~CAFirstMixChannelList ( )

References t_fmhashtableentry::cleanupNotifier, CAThread::join(), m_bDelayBucketsLoopRun, m_HashTable, m_HashTableOutChannels, m_pDelayBuckets, m_pMutexDelayChannel, m_pThreadDelayBucketsLoop, and MAX_HASH_KEY.

Member Function Documentation

fmHashTableEntry * CAFirstMixChannelList::add	(	CAMuxSocket *	pMuxSocket,
		const UINT8	peerIP[4],
		CAQueue *	pQueueSend,
		UINT8 *	controlChannelKeySent,
		UINT8 *	controlChannelKeyRecv
	)

Adds a new TCP/IP connection (a new user) to the channel list.

Parameters:

pMuxSocket	the new connection (from a user)
peerIP	the IP of the user, so that we can remove it later from the CAIPList
pQueueSend	the send-queue to use for this connection

Return values:

the	fmHashTableEntry of the newly added connection
NULL	if an error occured

Referenced by CAFirstMix::doUserLogin_internal(), and test().

SINT32 CAFirstMixChannelList::addChannel	(	CAMuxSocket *	pMuxSocket,
		HCHANNEL	channelIn,
		CASymCipher *	pCipher,
		HCHANNEL *	channelOut
	)

Adds a new channel for a given connection to the channel list.

Also a new out-channel id is generated and returned.

Parameters:

pMuxSocket	the connection from the user
channelIn	the channel, which should be added
pCipher	the symmetric cipher associated with this channel
channelOut	a pointer to the place, there the new generated out-channel id is stored

Return values:

E_SUCCESS	if successful
E_UNKNOWN	in case of an error

Referenced by CAFirstMixB::loop(), CAFirstMixA::loop(), and test().

UINT32 CAFirstMixChannelList::countTimeoutEntries ( ) [private]

References t_fmhashtableentry::list_TimeoutHashEntries, m_listTimoutHead, and t_fmhashtableentry::next.

void CAFirstMixChannelList::decDelayBuckets ( UINT32 delayBucketID )

References CAMutex::lock(), m_pDelayBuckets, m_pMutexDelayChannel, MAX_POLLFD, and CAMutex::unlock().

Referenced by CAFirstMixA::sendToUsers().

bool CAFirstMixChannelList::forceKickout	(	fmHashTableEntry *	pHashTableEntry,
		const XERCES_CPP_NAMESPACE::DOMDocument *	pErrDoc
	)

forces a kickout for this entry if the entry is still valid and sends an errorMessage via the control channel belonging to the entry.

returns true if pHashTableEntry is still valid, false otherwise

References KICKOUT_FORCED, CAMutex::lock(), m_Mutex, t_fmhashtableentry::pAccountingInfo, t_accountinginfo::pControlChannel, t_fmhashtableentry::pMuxSocket, CAAbstractControlChannel::sendXMLMessage(), setKickoutForced_internal(), and CAMutex::unlock().

Referenced by CAFirstMix::forceKickout().

fmChannelListEntry * CAFirstMixChannelList::get	(	CAMuxSocket *	pMuxSocket,
		HCHANNEL	channelIn
	)

Returns the information for a given Input-Channel-ID.

Parameters:

pMuxSocket	the connection from the user
channelIn	the channel id

Returns:: all channel associated information (output-channel id, cipher etc.)

Return values:

NULL	if not found

References t_firstmixchannellist::channelIn, CAMuxSocket::getHashKey(), t_firstmixchannellist::list_InChannelPerSocket, CAMutex::lock(), m_HashTable, m_Mutex, MAX_HASH_KEY, t_firstmixchannellist::next, t_fmhashtableentry::pChannelList, and CAMutex::unlock().

Referenced by CAFirstMix::doUserLogin_internal(), CAFirstMixA::finishPacket(), CAFirstMixB::loop(), and CAFirstMixA::loop().

fmHashTableEntry * CAFirstMixChannelList::get ( CAMuxSocket * pMuxSocket )

Returns the general data stored for a given Socket (user)

Parameters:

pMuxSocket the connection from the user

Returns:: general data for the given user

Return values:

NULL	if not found

References CAMuxSocket::getHashKey(), CAMutex::lock(), m_HashTable, m_Mutex, MAX_HASH_KEY, and CAMutex::unlock().

fmChannelListEntry* CAFirstMixChannelList::get ( HCHANNEL channelOut )

Gets the in-channel and all associated information for the given out-channel.

Parameters:

channelOut the out-channel id for which the information is requested

Returns:: the in-channel and all associated information

Return values:

NULL	if not found in list

References get_intern_without_lock(), CAMutex::lock(), m_Mutex, and CAMutex::unlock().

fmChannelListEntry* CAFirstMixChannelList::get_intern_without_lock ( HCHANNEL channelOut ) [private]

Gets the in-channel and all associated information for the given out-channel.

This method is NOT thread safe (and so only for internal use)

See also:: get()

Parameters:

channelOut the out-channel id for which the information is requested

Returns:: the in-channel and all associated information

Return values:

NULL	if not found in list

References t_firstmixchannellist::channelOut, t_firstmixchannellist::list_OutChannelHashTable, m_HashTableOutChannels, and t_firstmixchannellist::next.

Referenced by addChannel(), and get().

fmHashTableEntry * CAFirstMixChannelList::getFirst ( )

Gets the first connection of all connections in the list.

See also:: getNext()

Returns:: first connection in the list

Return values:

NULL	if no connection is in the list

References t_fmhashtableentry::list_HashEntries, CAMutex::lock(), m_listHashTableHead, m_listHashTableNext, m_Mutex, t_fmhashtableentry::next, and CAMutex::unlock().

Referenced by CAFirstMix::clean(), CAFirstMixB::loop(), CAFirstMixA::loop(), and CAFirstMixA::sendToUsers().

fmChannelListEntry * CAFirstMixChannelList::getFirstChannelForSocket ( CAMuxSocket * pMuxSocket )

Gets the first channel for a given connection.

See also:: getNextChannel()

Parameters:

pMuxSocket the connection from the user

Returns:: the channel and the associated information

Return values:

NULL	if no channel for this connection exists at the moment

References CAMuxSocket::getHashKey(), m_HashTable, MAX_HASH_KEY, and t_fmhashtableentry::pChannelList.

Referenced by CAFirstMix::clean(), CAFirstMixA::closeConnection(), CAFirstMixB::loop(), and CAFirstMixA::notifyAllUserChannels().

fmHashTableEntry * CAFirstMixChannelList::getNext ( )

Gets the next entry in the connections-list.

See also:: getFirst()

Returns:: next entry in the connection list

Return values:

NULL	in case of an error

References t_fmhashtableentry::list_HashEntries, CAMutex::lock(), m_listHashTableNext, m_Mutex, t_fmhashtableentry::next, and CAMutex::unlock().

Referenced by CAFirstMix::clean(), CAFirstMixB::loop(), CAFirstMixA::loop(), and CAFirstMixA::sendToUsers().

fmChannelListEntry * CAFirstMixChannelList::getNextChannel ( fmChannelListEntry * pEntry )

Gets the next channel for a given connection.

See also:: getFirstChannelForSocket()

Parameters:

pEntry a entry returned by a previos call to getFirstChannelForSocket() or getNextChannel()

Returns:: the next channel and all associated information

Return values:

NULL	if there are no more channels for this connection

References t_firstmixchannellist::list_InChannelPerSocket, and t_firstmixchannellist::next.

Referenced by CAFirstMix::clean(), CAFirstMixA::closeConnection(), CAFirstMixB::loop(), and CAFirstMixA::notifyAllUserChannels().

bool CAFirstMixChannelList::hasDelayBuckets ( UINT32 delayBucketID )

References CAMutex::lock(), m_pDelayBuckets, m_pMutexDelayChannel, MAX_POLLFD, and CAMutex::unlock().

Referenced by CAFirstMixA::sendToUsers().

bool CAFirstMixChannelList::isKickoutForced ( fmHashTableEntry * pHashTableEntry )

References isKickoutForced_internal(), CAMutex::lock(), m_Mutex, and CAMutex::unlock().

Referenced by CAFirstMixA::checkUserConnections().

bool CAFirstMixChannelList::isKickoutForced_internal ( fmHashTableEntry * pHashTableEntry ) [private]

References t_fmhashtableentry::bRecoverTimeout.

Referenced by isKickoutForced().

bool CAFirstMixChannelList::isTimedOut ( fmHashTableEntry * pHashTableEntry )

References isTimedOut_internal(), CAMutex::lock(), m_Mutex, and CAMutex::unlock().

Referenced by CAFirstMixA::checkUserConnections().

bool CAFirstMixChannelList::isTimedOut_internal ( fmHashTableEntry * pHashTableEntry ) [private]

References t_fmhashtableentry::list_TimeoutHashEntries, and t_fmhashtableentry::timoutSecs.

Referenced by isTimedOut(), and popTimeoutEntry_internal().

fmHashTableEntry * CAFirstMixChannelList::popTimeoutEntry ( )

Returns:: pops the next expired entry from the queue or returns NULL if there are no exired entries

Referenced by CAFirstMixA::checkUserConnections(), and CAFirstMixA::shutDown().

fmHashTableEntry * CAFirstMixChannelList::popTimeoutEntry ( bool a_bForce )

Parameters:

if	set to true, forces to return the next timeout enty or NULL if none are left in the queue

Returns:: if set to true, forces to return the next timeout enty or NULL if none are left in the queue

References CAMutex::lock(), m_Mutex, popTimeoutEntry_internal(), and CAMutex::unlock().

fmHashTableEntry * CAFirstMixChannelList::popTimeoutEntry_internal ( bool a_bForce ) [private]

References E_SUCCESS, isTimedOut_internal(), m_listTimoutHead, CAMsg::printMsg(), and removeFromTimeoutList().

Referenced by popTimeoutEntry().

SINT32 CAFirstMixChannelList::pushTimeoutEntry	(	fmHashTableEntry *	pHashTableEntry,
		bool	kickoutForced = `!KICKOUT_FORCED`
	)

adds the entry to the timeout queue with mutex

References CAMutex::lock(), m_Mutex, pushTimeoutEntry_internal(), and CAMutex::unlock().

Referenced by CAFirstMixA::accountTrafficDownstream(), CAFirstMixA::accountTrafficUpstream(), CAFirstMixA::checkUserConnections(), CAFirstMix::doUserLogin_internal(), and CAFirstMixA::loop().

SINT32 CAFirstMixChannelList::pushTimeoutEntry_internal	(	fmHashTableEntry *	pHashTableEntry,
		bool	kickoutForced = `!KICKOUT_FORCED`
	)		`[private]`

adds the entry to the timeout queue

renews the timestamp for the timeout list does not affect forced kickouts.

References BEGIN_STACK, E_SUCCESS, E_UNKNOWN, EXPIRATION_TIME_SECS, FINISH_STACK, INIT_STACK, t_fmhashtableentry::list_TimeoutHashEntries, m_listTimoutFoot, m_listTimoutHead, t_fmhashtableentry::next, t_fmhashtableentry::prev, removeFromTimeoutList(), setKickoutForced_internal(), and t_fmhashtableentry::timoutSecs.

Referenced by pushTimeoutEntry().

SINT32 CAFirstMixChannelList::remove ( CAMuxSocket * pMuxSocket )

Removes all channels, which belongs to the given connection and the connection itself from the list.

Parameters:

pMuxSocket the connection from the user

Return values:

E_SUCCESS	if successful
E_UNKNOWN	in case of an error

Referenced by CAFirstMix::clean(), CAFirstMixA::closeConnection(), CAFirstMix::doUserLogin_internal(), CAFirstMixB::loop(), and test().

SINT32 CAFirstMixChannelList::removeChannel	(	CAMuxSocket *	pMuxSocket,
		HCHANNEL	channelIn
	)

Removes a single channel from the list.

Parameters:

pMuxSocket	the connection from the user
channelIn	the channel, which should be removed

Return values:

E_SUCCESS	if successful
E_UNKNOWN	in case of an error

References t_firstmixchannellist::channelIn, t_firstmixchannellist::channelOut, t_fmhashtableentry::cNumberOfChannels, E_SUCCESS, E_UNKNOWN, CAMuxSocket::getHashKey(), t_firstmixchannellist::list_InChannelPerSocket, t_firstmixchannellist::list_OutChannelHashTable, CAMutex::lock(), m_HashTable, m_HashTableOutChannels, m_Mutex, MAX_HASH_KEY, t_firstmixchannellist::next, t_fmhashtableentry::pChannelList, t_fmhashtableentry::pMuxSocket, t_firstmixchannellist::prev, and CAMutex::unlock().

Referenced by CAFirstMixA::finishPacket(), CAFirstMixB::loop(), CAFirstMixA::loop(), and test().

SINT32 CAFirstMixChannelList::removeFromTimeoutList ( fmHashTableEntry * pHashTableEntry ) [private]

References E_SUCCESS, E_UNKNOWN, t_fmhashtableentry::list_TimeoutHashEntries, m_listTimoutFoot, m_listTimoutHead, t_fmhashtableentry::next, t_fmhashtableentry::prev, and CAMsg::printMsg().

Referenced by popTimeoutEntry_internal(), pushTimeoutEntry_internal(), and remove().

void CAFirstMixChannelList::setDelayParameters	(	UINT32	unlimitTraffic,
		UINT32	bucketGrow,
		UINT32	intervall
	)

References CAMutex::lock(), m_pDelayBuckets, m_pMutexDelayChannel, m_u32DelayChannelBucketGrow, m_u32DelayChannelBucketGrowIntervall, m_u32DelayChannelUnlimitTraffic, MAX_POLLFD, CAMsg::printMsg(), and CAMutex::unlock().

Referenced by CAFirstMixB::loop(), CAFirstMixA::loop(), and CAFirstMix::reconfigure().

void CAFirstMixChannelList::setKickoutForced	(	fmHashTableEntry *	pHashTableEntry,
		bool	kickoutForced
	)

References CAMutex::lock(), m_Mutex, setKickoutForced_internal(), and CAMutex::unlock().

Referenced by CAFirstMixA::accountTrafficDownstream(), and CAFirstMixA::accountTrafficUpstream().

void CAFirstMixChannelList::setKickoutForced_internal	(	fmHashTableEntry *	pHashTableEntry,
		bool	kickoutForced
	)		`[private]`

References t_fmhashtableentry::bRecoverTimeout, and CAMsg::printMsg().

Referenced by forceKickout(), pushTimeoutEntry_internal(), and setKickoutForced().

SINT32 CAFirstMixChannelList::test ( ) [static]

References add(), addChannel(), CAFirstMixChannelList(), CASocket::create(), E_SUCCESS, CAMuxSocket::getCASocket(), remove(), and removeChannel().

Friends And Related Function Documentation

THREAD_RETURN fml_loopDelayBuckets ( void * ) [friend]

Referenced by CAFirstMixChannelList().

Member Data Documentation

const SINT32 CAFirstMixChannelList::EXPIRATION_TIME_SECS = 300 [static, private]

Referenced by pushTimeoutEntry_internal().

bool CAFirstMixChannelList::m_bDelayBucketsLoopRun [private]

Referenced by CAFirstMixChannelList(), fml_loopDelayBuckets(), and ~CAFirstMixChannelList().

LP_fmHashTableEntry* CAFirstMixChannelList::m_HashTable [private]

The Hash-Table of all connections.

Referenced by addChannel(), CAFirstMixChannelList(), get(), getFirstChannelForSocket(), remove(), removeChannel(), and ~CAFirstMixChannelList().

LP_fmChannelListEntry* CAFirstMixChannelList::m_HashTableOutChannels [private]

The Hash-Table of all out-channels.

Referenced by addChannel(), CAFirstMixChannelList(), get_intern_without_lock(), remove(), removeChannel(), and ~CAFirstMixChannelList().

fmHashTableEntry* CAFirstMixChannelList::m_listHashTableHead [private]

Pointer to the head of a list of all connections.

Referenced by CAFirstMixChannelList(), getFirst(), and remove().

fmHashTableEntry* CAFirstMixChannelList::m_listHashTableNext [private]

Next Element in the enumeration of all connections.

Referenced by CAFirstMixChannelList(), getFirst(), getNext(), and remove().

fmHashTableEntry* CAFirstMixChannelList::m_listTimoutFoot [private]

Referenced by CAFirstMixChannelList(), pushTimeoutEntry_internal(), and removeFromTimeoutList().

fmHashTableEntry* CAFirstMixChannelList::m_listTimoutHead [private]

Pointer to the head of the timout list of all connections.

Referenced by CAFirstMixChannelList(), countTimeoutEntries(), popTimeoutEntry_internal(), pushTimeoutEntry_internal(), and removeFromTimeoutList().

CAMutex CAFirstMixChannelList::m_Mutex [private]

This mutex is used in all functions and makes them thread safe.

Referenced by addChannel(), forceKickout(), get(), getFirst(), getNext(), isKickoutForced(), isTimedOut(), popTimeoutEntry(), pushTimeoutEntry(), remove(), removeChannel(), and setKickoutForced().

volatile UINT32** CAFirstMixChannelList::m_pDelayBuckets [private]

Referenced by CAFirstMixChannelList(), decDelayBuckets(), fml_loopDelayBuckets(), hasDelayBuckets(), remove(), setDelayParameters(), and ~CAFirstMixChannelList().

CAMutex* CAFirstMixChannelList::m_pMutexDelayChannel [private]

Referenced by CAFirstMixChannelList(), decDelayBuckets(), fml_loopDelayBuckets(), hasDelayBuckets(), remove(), setDelayParameters(), and ~CAFirstMixChannelList().

CAThread* CAFirstMixChannelList::m_pThreadDelayBucketsLoop [private]

Referenced by CAFirstMixChannelList(), and ~CAFirstMixChannelList().

volatile UINT32 CAFirstMixChannelList::m_u32DelayChannelBucketGrow [private]

Referenced by CAFirstMixChannelList(), fml_loopDelayBuckets(), and setDelayParameters().

volatile UINT32 CAFirstMixChannelList::m_u32DelayChannelBucketGrowIntervall [private]

Referenced by CAFirstMixChannelList(), fml_loopDelayBuckets(), and setDelayParameters().

volatile UINT32 CAFirstMixChannelList::m_u32DelayChannelUnlimitTraffic [private]

Referenced by CAFirstMixChannelList(), and setDelayParameters().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation