AAAEventHandler Class Reference

Event Handler. More...

#include <diameter_api.h>

Inheritance diagram for AAAEventHandler:

List of all members.

Public Member Functions
	AAAEventHandler (AAAApplicationCore &c)
virtual	~AAAEventHandler ()
virtual AAAReturnCode	HandleMessage (AAAMessage &msg)
virtual AAAReturnCode	HandleDisconnect ()
virtual AAAReturnCode	HandleTimeout ()
virtual AAAReturnCode	HandleSessionTimeout ()
virtual AAAReturnCode	HandleAuthLifetimeTimeout ()
virtual AAAReturnCode	HandleAuthGracePeriodTimeout ()
virtual AAAReturnCode	HandleAbort ()
const AAAApplicationCore &	GetApplicationCore ()
Protected Attributes
AAAApplicationCore &	core

---

Detailed Description

Event Handler.

Provides an abstract interface for handling different types of events from incomming messages, session disconnection .. etc.

Additional event handler methods can easily be added to this class. This allows new event mechanisms to use this abstraction without the need for declaring new handler classes.

---

Constructor & Destructor Documentation

AAAEventHandler::AAAEventHandler (  AAAApplicationCore &  c  )  [inline]

constructor Parameters: appCore  Application core for which to subscribe or un-subscribe messages to.

virtual AAAEventHandler::~AAAEventHandler (   )  [inline, virtual]

destructor

---

Member Function Documentation

const AAAApplicationCore& AAAEventHandler::GetApplicationCore (   )  [inline]

Access method for the application core

virtual AAAReturnCode AAAEventHandler::HandleAbort (   )  [inline, virtual]

This is invoked by the library during session abort event. An abort occurs when the server decides to terminate the client session by sending an ASR to the client session. The library will process the ASR message and notify the application that the server wishes to abort the session via this handler. It is the responsibility of the derived class to override this function and capture this event.

virtual AAAReturnCode AAAEventHandler::HandleAuthGracePeriodTimeout (   )  [inline, virtual]

This is invoked by the library if authorization grace period negotiated between the client and server expires. Note that the values are based on Authorization-Grace-Period AVP's exchange between client and server with initial values dictated by configuration entries. It is the responsibility of the derived class to override this function and capture this events if it is interested in it.

virtual AAAReturnCode AAAEventHandler::HandleAuthLifetimeTimeout (   )  [inline, virtual]

This is invoked by the library if authorization lifetime negotiated between the client and server expires. Note that the values are based on Authorization-Lifetime AVP's exchange between client and server with initial values dictated by configuration entries. It is the responsibility of the derived class to override this function and capture this events if it is interested in it.

virtual AAAReturnCode AAAEventHandler::HandleDisconnect (   )  [inline, virtual]

This is invoked by the library during session disconnect event. Disconnection event occurs when a session is terminated because of network connectivity issues. For the library, this means that all transport connections to all peers has been lost. Note that this event can occur at any moment after the application core has been started even prior to any session transmitting or receiving messages. It is the responsibility of the derived class to override this function and capture this events.

virtual AAAReturnCode AAAEventHandler::HandleMessage (  AAAMessage &  msg  )  [inline, virtual]

This is invoked by the library when an incomming message needs to be delivered to the application. This event occurs only after a valid message with a session id matching the session id of this session object has been received. The msg argument is pre-allocated by the library and is valid only within the context of this method. It is the responsibility of the derived class to override this function and capture this events. Parameters: msg  Incomming message to be processed

virtual AAAReturnCode AAAEventHandler::HandleSessionTimeout (   )  [inline, virtual]

This is invoked by the library if session timeout negotiated between the client and server expires. Note that the values are based on Session-Timeout AVP's exchange between client and server with initial values dictated by configuration entries. It is the responsibility of the derived class to override this function and capture this events if it is interested in it.

virtual AAAReturnCode AAAEventHandler::HandleTimeout (   )  [inline, virtual]

This is a generic timeout event handler that is currently not used. This is reserved for future versions of timer servicing via framework.h

---

Member Data Documentation

AAAApplicationCore& AAAEventHandler::core [protected]

Application Core reference

---

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

• diameter_api.h

---