ApiNewYear::IObserver Class Reference

Base class used to execute modules in the ExecutionLine. More...

#include <IObserver.h>

Collaboration diagram for ApiNewYear::IObserver:

Public Member Functions
virtual const std::string &	getName (void) const =0
	Getter for corresponding modules name. More...
virtual int	getPriority (void) const =0
	Getter for corresponding modules priority. More...
virtual int	update (IHttpClient *client)=0
	Executes the function passed to the interfaces constructor. More...

Detailed Description

Base class used to execute modules in the ExecutionLine.

Establishes the base architecture to allow modules to be executed by defining how they are executed by the ExecutionLine, and what information the ExecutionLine has for each module.

Member Function Documentation

virtual const std::string& ApiNewYear::IObserver::getName ( void  ) const

pure virtual

Getter for corresponding modules name.

IObserver get name of creating module.

Returns

constant string reference containing the modules name.

virtual int ApiNewYear::IObserver::getPriority ( void  ) const

pure virtual

Getter for corresponding modules priority.

IObserver get the priority of the creating module.

Returns

int containing the creating modules priority.

virtual int ApiNewYear::IObserver::update ( IHttpClient *  client )

pure virtual

Executes the function passed to the interfaces constructor.

IObserver executes the modules main function through a function pointer.

Parameters

client

the clients information.

Returns

int containing the success or error code of the modules main function.

---

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

• IObserver.h