EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
FDHook Class Referenceabstract

Registers, unregisters and process freeDiameter hooks. See "MONITORING" in libfdcore.h in the freeDiameter library. More...

#include <efd.h>

Inheritance diagram for FDHook:
EStatistics::DiameterHook

Public Member Functions

 FDHook ()
 Class constructor. More...
 
virtual Void process (enum fd_hook_type type, struct msg *msg, struct peer_hdr *peer, Void *other, struct fd_hook_permsgdata *pmd)=0
 Method that is called to process a freeDiameter hook callback. More...
 
Bool registerHook (UInt hookmask)
 Registers the hook for the specified events.
More...
 
Void unregisterHook ()
 Unregisters the hook. More...
 
struct fd_hook_hdl * getHandle ()
 Retrieves the hook handle. More...
 
UInt getHookMask ()
 Retrieves the hook mask. More...
 

Detailed Description

Registers, unregisters and process freeDiameter hooks. See "MONITORING" in libfdcore.h in the freeDiameter library.

Constructor & Destructor Documentation

◆ FDHook()

FDHook::FDHook ( )

Class constructor.

Member Function Documentation

◆ getHandle()

struct fd_hook_hdl* FDHook::getHandle ( )
inline

Retrieves the hook handle.

Returns
the hook handle.

◆ getHookMask()

UInt FDHook::getHookMask ( )
inline

Retrieves the hook mask.

Returns
the hook mask.

◆ process()

virtual Void FDHook::process ( enum fd_hook_type  type,
struct msg *  msg,
struct peer_hdr *  peer,
Void *  other,
struct fd_hook_permsgdata *  pmd 
)
pure virtual

Method that is called to process a freeDiameter hook callback.

Parameters
typethe type of hook that triggered this call, in case same cb is registered for several hooks.
msgif relevant, the pointer to the message triggering the call. NULL otherwise.
peerif relevant, the pointer to the peer associated with the call. NULL otherwise.
otherfor some callbacks, the remaining information is passed in this parameter. See each hook detail.
pmdstructure associated with a given message, across several hooks.

◆ registerHook()

Bool FDHook::registerHook ( UInt  hookmask)

Registers the hook for the specified events.

◆ unregisterHook()

Void FDHook::unregisterHook ( )

Unregisters the hook.


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