ariba::communication::CommunicationEvents Class Reference

#include <source/ariba/communication/CommunicationEvents.h>

Inherited by ariba::overlay::BaseOverlay.

List of all members.

Public Member Functions

 CommunicationEvents ()
virtual ~CommunicationEvents ()

Protected Member Functions

virtual bool onLinkRequest (const LinkID &id, const address_v *local, const address_v *remote)
virtual void onLinkUp (const LinkID &id, const address_v *local, const address_v *remote)
virtual void onLinkDown (const LinkID &id, const address_v *local, const address_v *remote)
virtual void onLinkChanged (const LinkID &id, const address_v *oldlocal, const address_v *newlocal, const address_v *oldremote, const address_v *newremote)
virtual void onLinkFail (const LinkID &id, const address_v *local, const address_v *remote)
virtual void onLinkQoSChanged (const LinkID &id, const address_v *local, const address_v *remote, const QoSParameterSet &qos)

Friends

class BaseCommunication


Detailed Description

Definition at line 53 of file CommunicationEvents.h.


Constructor & Destructor Documentation

ariba::communication::CommunicationEvents::CommunicationEvents (  ) 

Definition at line 44 of file CommunicationEvents.cpp.

ariba::communication::CommunicationEvents::~CommunicationEvents (  )  [virtual]

Definition at line 47 of file CommunicationEvents.cpp.


Member Function Documentation

void ariba::communication::CommunicationEvents::onLinkChanged ( const LinkID id,
const address_v oldlocal,
const address_v newlocal,
const address_v oldremote,
const address_v newremote 
) [protected, virtual]

This method is called when a link has been changed because of interface failure, mobility, etc. in this case messages can still be sent over the link -- connectivity is still provided with different link properties.

Parameters:
id The link identifier of the changed link

Reimplemented in ariba::overlay::BaseOverlay.

Definition at line 63 of file CommunicationEvents.cpp.

Referenced by ariba::communication::BaseCommunication::receiveMessage().

void ariba::communication::CommunicationEvents::onLinkDown ( const LinkID id,
const address_v local,
const address_v remote 
) [protected, virtual]

This method is called when a link is dropped.

Parameters:
id The link identifier of the dropped link

Reimplemented in ariba::overlay::BaseOverlay.

Definition at line 59 of file CommunicationEvents.cpp.

Referenced by ariba::communication::BaseCommunication::dropLink(), and ariba::communication::BaseCommunication::receiveMessage().

void ariba::communication::CommunicationEvents::onLinkFail ( const LinkID id,
const address_v local,
const address_v remote 
) [protected, virtual]

Reimplemented in ariba::overlay::BaseOverlay.

Definition at line 68 of file CommunicationEvents.cpp.

void ariba::communication::CommunicationEvents::onLinkQoSChanged ( const LinkID id,
const address_v local,
const address_v remote,
const QoSParameterSet qos 
) [protected, virtual]

Reimplemented in ariba::overlay::BaseOverlay.

Definition at line 72 of file CommunicationEvents.cpp.

bool ariba::communication::CommunicationEvents::onLinkRequest ( const LinkID id,
const address_v local,
const address_v remote 
) [protected, virtual]

This method is called when a link request is received. If this method returns true, a the link request is processed and a new link will be established.

Parameters:
id The provisional link identifier of the new link
Returns:
True, if the link should be established

Reimplemented in ariba::overlay::BaseOverlay.

Definition at line 50 of file CommunicationEvents.cpp.

Referenced by ariba::communication::BaseCommunication::receiveMessage().

void ariba::communication::CommunicationEvents::onLinkUp ( const LinkID id,
const address_v local,
const address_v remote 
) [protected, virtual]

This method is called when a link is established and can be used to send messages.

Parameters:
id The link id of the established link

Reimplemented in ariba::overlay::BaseOverlay.

Definition at line 55 of file CommunicationEvents.cpp.

Referenced by ariba::communication::BaseCommunication::receiveMessage().


Friends And Related Function Documentation

friend class BaseCommunication [friend]

Definition at line 54 of file CommunicationEvents.h.


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

Generated on Fri Aug 14 23:39:19 2009 for Ariba by  doxygen 1.5.8