CAMix Class Reference

Inheritance diagram for CAMix:

Public Types
enum	tMixType { FIRST_MIX , MIDDLE_MIX , LAST_MIX , JAP }

Public Member Functions
	CAMix ()
virtual	~CAMix ()
SINT32	start ()
virtual SINT32	reconfigure ()
virtual tMixType	getType () const =0
virtual void	shutDown ()
virtual bool	isShutDown ()
SINT32	getMixCascadeInfo (XERCES_CPP_NAMESPACE::DOMDocument *&docMixCascadeInfo)
	Returns the Mix-Cascade info which should be send to the InfoService. More...
bool	acceptsReconfiguration ()
CAControlChannelDispatcher *	getDownstreamControlChannelDispatcher () const
CAControlChannelDispatcher *	getUpstreamControlChannelDispatcher () const
UINT32	getLastConnectionTime ()
bool	isConnected ()

Static Public Attributes
static const UINT32	TIMEOUT_MIX_CONNECTION_ESTABLISHEMENT = 60000

Protected Member Functions
virtual SINT32	clean ()=0
virtual SINT32	initOnce ()
virtual SINT32	init ()=0
virtual SINT32	loop ()=0
SINT32	checkCompatibility (DOMNode *a_parent, const char *a_mixPosition)
SINT32	appendCompatibilityInfo (DOMNode *a_parent)
SINT32	addMixInfo (DOMNode *a_element, bool a_bForceFirstNode)
virtual SINT32	processKeyExchange ()=0
virtual SINT32	initMixCascadeInfo (DOMElement *elemMixes)
	This will initialize the XML Cascade Info struct XMLFirstMixToInfoService that is sent to the InfoService in CAInfoService::sendCascadeHelo() More...
SINT32	signXML (DOMNode *a_element)

Protected Attributes
volatile bool	m_bLoop
bool	m_bReconfiguring
volatile bool	m_bShutDown
CAMultiSignature *	m_pMultiSignature
CAInfoService *	m_pInfoService
UINT32	m_u32KeepAliveRecvInterval
UINT32	m_u32KeepAliveSendInterval
bool	m_acceptReconfiguration
volatile bool	m_bConnected
volatile UINT32	m_lLastConnectionTime
XERCES_CPP_NAMESPACE::DOMDocument *	m_docMixCascadeInfo
CAControlChannelDispatcher *	m_pMuxOutControlChannelDispatcher
CAControlChannelDispatcher *	m_pMuxInControlChannelDispatcher

Private Member Functions
bool	needAutoConfig ()
	This method checks if target interfaces (network adress and port of next mix) have been specified in the config file. More...

Member Enumeration Documentation

tMixType

enum CAMix::tMixType

Enumerator
FIRST_MIX
MIDDLE_MIX
LAST_MIX
JAP

Constructor & Destructor Documentation

CAMix()

CAMix::CAMix

(

)

References CACmdLnOptions::acceptReconfiguration(), CALibProxytest::getOptions(), m_acceptReconfiguration, m_bConnected, m_bLoop, m_bReconfiguring, m_bShutDown, m_docMixCascadeInfo, m_lLastConnectionTime, m_pInfoService, m_pMultiSignature, m_pMuxInControlChannelDispatcher, m_pMuxOutControlChannelDispatcher, m_u32KeepAliveRecvInterval, and m_u32KeepAliveSendInterval.

~CAMix()

CAMix::~CAMix ( )

virtual

Member Function Documentation

acceptsReconfiguration()

bool CAMix::acceptsReconfiguration

(

)

References m_acceptReconfiguration.

addMixInfo()

SINT32 CAMix::addMixInfo ( DOMNode *  a_element, bool  a_bForceFirstNode  )

protected

References E_SUCCESS, E_UNKNOWN, and CALibProxytest::getOptions().

Referenced by initMixCascadeInfo(), CALastMix::processKeyExchange(), and CAMiddleMix::processKeyExchange().

appendCompatibilityInfo()

SINT32 CAMix::appendCompatibilityInfo ( DOMNode *  a_parent )

protected

EDIT HERE FOR INTRODUCING NEW FLAGS!

References createDOMElement(), E_SUCCESS, MIX_VERSION, NEW_CHANNEL_ENCRYPTION_COMPATIBILITY, NEW_FLOW_CONTROL_COMPATIBILITY, PAYMENT_COMPATIBILITY, setDOMElementAttribute(), and WITH_INTEGRITY_CHECK_COMPATIBILITY.

Referenced by CALastMix::processKeyExchange(), and CAMiddleMix::processKeyExchange().

checkCompatibility()

SINT32 CAMix::checkCompatibility ( DOMNode *  a_parent, const char *  a_mixPosition  )

protected

EDIT HERE FOR ADDING INCOMPATIBLE VERSIONS!

EDIT HERE FOR INTRODUCING NEW FLAGS!

EDIT HERE FOR INTRODUCING NEW FLAGS!

References E_SUCCESS, E_UNKNOWN, flags, getDOMChildByName(), getDOMElementAttribute(), getNodeName(), len, MIX_VERSION, MIX_VERSION_COMPATIBILITY, NEW_CHANNEL_ENCRYPTION_COMPATIBILITY, NEW_FLOW_CONTROL_COMPATIBILITY, PAYMENT_COMPATIBILITY, CAMsg::printMsg(), and WITH_INTEGRITY_CHECK_COMPATIBILITY.

Referenced by CALastMix::processKeyExchange(), and CAMiddleMix::processKeyExchange().

clean()

virtual SINT32 CAMix::clean ( )

protectedpure virtual

Implemented in CAMiddleMix, CALastMix, and CAFirstMix.

Referenced by start().

getDownstreamControlChannelDispatcher()

CAControlChannelDispatcher* CAMix::getDownstreamControlChannelDispatcher

(

)

const

References m_pMuxInControlChannelDispatcher.

Referenced by CAReplayCtrlChannelMsgProc::CAReplayCtrlChannelMsgProc(), and CAReplayCtrlChannelMsgProc::~CAReplayCtrlChannelMsgProc().

getLastConnectionTime()

UINT32 CAMix::getLastConnectionTime

(

)

References m_lLastConnectionTime.

Referenced by CAInfoService::InfoLoop().

getMixCascadeInfo()

SINT32 CAMix::getMixCascadeInfo

(

XERCES_CPP_NAMESPACE::DOMDocument *&

docMixCascadeInfo

)

Returns the Mix-Cascade info which should be send to the InfoService.

This is NOT a copy!

Parameters

docMixCascadeInfo

where the XML struct would be stored

Return values

E_SUCCESS

References E_SUCCESS, E_UNKNOWN, and m_docMixCascadeInfo.

Referenced by CAInfoService::getCascadeHeloXMLAsString(), and CAAccountingInstance::prepareCCRequest().

getType()

virtual tMixType CAMix::getType ( ) const

pure virtual

Implemented in CAMiddleMix, CALastMix, and CAFirstMix.

Referenced by CAReplayCtrlChannelMsgProc::initTimestampsMessageTemplate(), CAReplayCtrlChannelMsgProc::proccessGetTimestamp(), and CAReplayCtrlChannelMsgProc::proccessGotTimestamp().

getUpstreamControlChannelDispatcher()

CAControlChannelDispatcher* CAMix::getUpstreamControlChannelDispatcher

(

)

const

References m_pMuxOutControlChannelDispatcher.

Referenced by CAReplayCtrlChannelMsgProc::CAReplayCtrlChannelMsgProc(), and CAReplayCtrlChannelMsgProc::~CAReplayCtrlChannelMsgProc().

init()

virtual SINT32 CAMix::init ( )

protectedpure virtual

Implemented in CAMiddleMix, CALastMix, and CAFirstMix.

Referenced by start().

initMixCascadeInfo()

SINT32 CAMix::initMixCascadeInfo ( DOMElement *  mixes )

protectedvirtual

This will initialize the XML Cascade Info struct XMLFirstMixToInfoService that is sent to the InfoService in CAInfoService::sendCascadeHelo()

Parameters

mixes

the <Mixes> element of the XML struct we received from the succeeding mix.

Return values

E_UNKNOWN	if processing produces an error
E_SUCCESS	otherwise

Reimplemented in CAMiddleMix, and CALastMix.

References addMixInfo(), CHANNELS_PER_CLIENT, createDOMDocument(), createDOMElement(), E_SUCCESS, equals(), getDOMChildByName(), getLastDOMChildByName(), CACmdLnOptions::getListenerInterface(), CACmdLnOptions::getListenerInterfaceCount(), CACmdLnOptions::getMaxNrOfUsers(), CACmdLnOptions::getMixId(), CALibProxytest::getOptions(), CAListenerInterface::getType(), CAListenerInterface::isHidden(), m_docMixCascadeInfo, PAYMENT_VERSION, CAMsg::printMsg(), RAW_TCP, RAW_UDP, setDOMElementAttribute(), setDOMElementValue(), signXML(), and CAListenerInterface::toDOMElement().

Referenced by CALastMix::initMixCascadeInfo().

initOnce()

SINT32 CAMix::initOnce ( )

protectedvirtual

Reimplemented in CAMiddleMix, CALastMix, and CAFirstMix.

References E_SUCCESS, E_UNKNOWN, CALibProxytest::getOptions(), and CAMsg::printMsg().

Referenced by CAFirstMix::initOnce(), CALastMix::initOnce(), and start().

isConnected()

bool CAMix::isConnected

(

)

References m_bConnected.

Referenced by CAInfoService::InfoLoop(), CAInfoService::sendCascadeHelo(), and CAInfoService::sendStatus().

isShutDown()

virtual bool CAMix::isShutDown ( )

virtual

References m_bShutDown.

Referenced by my_terminate().

loop()

virtual SINT32 CAMix::loop ( )

protectedpure virtual

Implemented in CALastMix, CAFirstMix, CALastMixB, CAFirstMixB, CALastMixA, CAFirstMixA, and CAMiddleMix.

Referenced by start().

needAutoConfig()

bool CAMix::needAutoConfig ( )

private

This method checks if target interfaces (network adress and port of next mix) have been specified in the config file.

A return value of true means that necessary information to bring the cascade online is missing and must be downloaded from the InfoService (if available).

Return values

false	if the target interfaces are configured one way or another
true	if config file contains no target interface info and InfoService is unavailable

References CATargetInterface::cleanAddr(), CALibProxytest::getOptions(), CACmdLnOptions::getTargetInterface(), CACmdLnOptions::getTargetInterfaceCount(), CATargetInterface::getTargetType(), and TARGET_MIX.

Referenced by start().

processKeyExchange()

virtual SINT32 CAMix::processKeyExchange ( )

protectedpure virtual

Implemented in CAMiddleMix, CALastMix, and CAFirstMix.

reconfigure()

virtual SINT32 CAMix::reconfigure ( )

virtual

Reimplemented in CALastMix, and CAFirstMix.

References E_SUCCESS.

shutDown()

virtual void CAMix::shutDown ( )

virtual

Reimplemented in CAFirstMixA.

References m_bLoop, and m_bShutDown.

Referenced by my_terminate().

signXML()

SINT32 CAMix::signXML ( DOMNode *  a_element )

protected

References m_pMultiSignature, and CAMultiSignature::signXML().

Referenced by initMixCascadeInfo(), CALastMix::processKeyExchange(), and CAMiddleMix::processKeyExchange().

start()

SINT32 CAMix::start

(

)

References CACmdLnOptions::acceptReconfiguration(), clean(), E_SHUTDOWN, E_SUCCESS, E_UNKNOWN, ev_sys_enterMainLoop, ev_sys_leavingMainLoop, getcurrentTimeMillis(), CALibProxytest::getOptions(), init(), initOnce(), CAInfoService::isRunning(), loop(), m_bConnected, m_bLoop, m_bReconfiguring, m_lLastConnectionTime, m_pInfoService, m_pMultiSignature, MONITORING_FIRE_SYS_EVENT, needAutoConfig(), CAMsg::printMsg(), CAInfoService::sendCascadeHelo(), CAInfoService::setConfiguring(), CAInfoService::setMultiSignature(), CAInfoService::setSerial(), CAInfoService::signal(), sSleep(), CAInfoService::start(), and CAInfoService::stop().

Referenced by main().

Member Data Documentation

m_acceptReconfiguration

bool CAMix::m_acceptReconfiguration

protected

Referenced by acceptsReconfiguration(), and CAMix().

m_bConnected

volatile bool CAMix::m_bConnected

protected

Referenced by CAMix(), isConnected(), and start().

m_bLoop

volatile bool CAMix::m_bLoop

protected

Referenced by CAMix(), shutDown(), CAFirstMixA::shutDown(), and start().

m_bReconfiguring

bool CAMix::m_bReconfiguring

protected

Referenced by CAMix(), and start().

m_bShutDown

volatile bool CAMix::m_bShutDown

protected

Referenced by CAMix(), CAMiddleMix::clean(), isShutDown(), and shutDown().

m_docMixCascadeInfo

XERCES_CPP_NAMESPACE::DOMDocument* CAMix::m_docMixCascadeInfo

protected

Referenced by CAMix(), getMixCascadeInfo(), CALastMix::initMixCascadeInfo(), and initMixCascadeInfo().

m_lLastConnectionTime

volatile UINT32 CAMix::m_lLastConnectionTime

protected

Referenced by CAMix(), getLastConnectionTime(), and start().

m_pInfoService

CAInfoService* CAMix::m_pInfoService

protected

Referenced by CAFirstMix::CAFirstMix(), CALastMix::CALastMix(), CAMiddleMix::CAMiddleMix(), CAMix(), CAFirstMix::clean(), CAFirstMixA::shutDown(), and start().

m_pMultiSignature

CAMultiSignature* CAMix::m_pMultiSignature

protected

Referenced by CALastMix::CALastMix(), CAMiddleMix::CAMiddleMix(), CAMix(), CAFirstMix::doUserLogin_internal(), CAFirstMix::initOnce(), CALastMix::initOnce(), CAMiddleMix::initOnce(), CAMiddleMix::processKeyExchange(), signXML(), and start().

m_pMuxInControlChannelDispatcher

CAControlChannelDispatcher* CAMix::m_pMuxInControlChannelDispatcher

protected

Referenced by CAMix(), CALastMix::clean(), getDownstreamControlChannelDispatcher(), CAMiddleMix::init(), CALastMixA::loop(), and CALastMixB::loop().

m_pMuxOutControlChannelDispatcher

CAControlChannelDispatcher* CAMix::m_pMuxOutControlChannelDispatcher

protected

Referenced by CAMix(), CAFirstMix::clean(), getUpstreamControlChannelDispatcher(), and CAFirstMix::init().

m_u32KeepAliveRecvInterval

UINT32 CAMix::m_u32KeepAliveRecvInterval

protected

Referenced by CAMix(), CALastMix::processKeyExchange(), and CAMiddleMix::processKeyExchange().

m_u32KeepAliveSendInterval

UINT32 CAMix::m_u32KeepAliveSendInterval

protected

Referenced by CAMix(), CALastMix::processKeyExchange(), and CAMiddleMix::processKeyExchange().

TIMEOUT_MIX_CONNECTION_ESTABLISHEMENT

const UINT32 CAMix::TIMEOUT_MIX_CONNECTION_ESTABLISHEMENT = 60000

static

Referenced by CALastMix::processKeyExchange(), and CAMiddleMix::processKeyExchange().