FDEngine Class Reference

Provides an interface for controlling freeDiameter. More...

#include <efd.h>

Public Member Functions
	FDEngine (const char *cfgfile=NULL)
	Class constructor. More...
	FDEngine (const std::string &cfgfile)
	Class constructor. More...
	~FDEngine ()
	Class destructor. More...
Bool	init ()
	Initializes freeDiameter and loads the configuration file. More...
Bool	start ()
	Starts freeDiameter. More...
Void	uninit (Bool wait=true)
	Shuts down freeDiameter. More...
Void	waitForShutdown ()
	Waits for freeDiameter to shut down. More...
const EString &	getConfigFile ()
	Retrieves the configuration file name.. More...
const EString &	setConfigFile (const char *cf)
	Sets the configuration file. More...
const EString &	setConfigFile (const std::string &cf)
	Sets the configuration file. More...
Void	advertiseSupport (FDDictionaryEntryApplication &app, Int auth=0, Int acct=0)
	Configures a Diameter application to be advertised in the CER/CEA. More...
Void	advertiseSupport (FDDictionaryEntryApplication &app, FDDictionaryEntryVendor &vendor, Int auth=0, Int acct=0)
	Configures a vendor specific Diameter application to be advertised in the CER/CEA. More...

Detailed Description

Provides an interface for controlling freeDiameter.

Constructor & Destructor Documentation

FDEngine() [1/2]

FDEngine::FDEngine

(

const char *

cfgfile = NULL

)

Class constructor.

Parameters

cfgfile

the full path to the freeDiameter configuration file.

FDEngine() [2/2]

FDEngine::FDEngine

(

const std::string &

cfgfile

)

Class constructor.

Parameters

cfgfile

the full path to the freeDiameter configuration file.

~FDEngine()

FDEngine::~FDEngine

(

)

Class destructor.

Member Function Documentation

advertiseSupport() [1/2]

Void FDEngine::advertiseSupport	(	FDDictionaryEntryApplication &	app,
		FDDictionaryEntryVendor &	vendor,
		Int	auth = 0,
		Int	acct = 0
	)

Configures a vendor specific Diameter application to be advertised in the CER/CEA.

Parameters

app	the dictionary entry associated with the application.
vendor	the dictionary entry associated with vendor.
auth	indicates that this application is an authentication application.
acct	indicates that this application is an accounting application.

Exceptions

FDException

advertiseSupport() [2/2]

Void FDEngine::advertiseSupport	(	FDDictionaryEntryApplication &	app,
		Int	auth = 0,
		Int	acct = 0
	)

Configures a Diameter application to be advertised in the CER/CEA.

Parameters

app	the dictionary entry associated with the application.
auth	indicates that this application is an authentication application.
acct	indicates that this application is an accounting application.

Exceptions

FDException

getConfigFile()

const EString& FDEngine::getConfigFile ( )

inline

Retrieves the configuration file name..

Returns

an EString reference containing the configuration file name.

init()

Bool FDEngine::init

(

)

Initializes freeDiameter and loads the configuration file.

Returns

True if initialization was successful, otherwise False.

Exceptions

FDException

setConfigFile() [1/2]

const EString& FDEngine::setConfigFile ( const char *  cf )

inline

Sets the configuration file.

Parameters

cf	the new value for the configuration file.

Returns

an EString reference containing the configuration file name.

setConfigFile() [2/2]

const EString& FDEngine::setConfigFile ( const std::string &  cf )

inline

Sets the configuration file.

Parameters

cf	the new value for the configuration file.

Returns

an EString reference containing the configuration file name.

start()

Bool FDEngine::start

(

)

Starts freeDiameter.

Returns

True if successful, otherwise False.

Exceptions

FDException

uninit()

Void FDEngine::uninit

(

Bool

wait = true

)

Shuts down freeDiameter.

waitForShutdown()

Void FDEngine::waitForShutdown

(

)

Waits for freeDiameter to shut down.

---

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

• /home/vagrant/share/code/epctools/include/epc/efd.h
• /home/vagrant/share/code/epctools/src/efd.cpp