ApiNewYear::IConnection Class Reference

Base class allowing the execution of connection modules in IServer. More...

#include <IConnection.h>

Collaboration diagram for ApiNewYear::IConnection:

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 (SOCKET socket, IHttpClient *client)=0
	Executes the function passed to the interfaces constructor. More...

Detailed Description

Base class allowing the execution of connection modules in IServer.

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

Member Function Documentation

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

pure virtual

Getter for corresponding modules name.

IConnection get name of creating module.

Returns

constant string reference containing the modules name.

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

pure virtual

Getter for corresponding modules priority.

IConnection get the priority of the creating module.

Returns

int containing the creating modules priority.

virtual int ApiNewYear::IConnection::update ( SOCKET  socket, IHttpClient *  client  )

pure virtual

Executes the function passed to the interfaces constructor.

IConnection executes the modules main function through a function pointer.

Parameters

socket	server's listening socket.
client	pointer to the clients information (to be filled!).

Returns

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

---

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

• IConnection.h