SaltAPI  1.1
An API for the HTTPd / Zia by Salty Studio.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Types | Public Member Functions | List of all members
Module::IModule Class Referenceabstract

#include <IModule.hpp>

Inheritance diagram for Module::IModule:
Inheritance graph
[legend]

Public Types

enum  Type {
  Core, Logger, ConfigLoader, Network,
  FileServe, HTTP, Default
}
 

Public Member Functions

virtual std::string const & GetName () const =0
 
virtual Type GetType () const =0
 
virtual bool Load ()=0
 Method for futur use. More...
 
virtual bool Unload ()=0
 Method for futur use. More...
 
virtual IModule * GetModule (ICore &core) const =0
 The function return an instance of the module. More...
 

Detailed Description

Interface representing a module

Definition at line 20 of file IModule.hpp.

Member Enumeration Documentation

enum Module::IModule::Type

Type of a module

Enumerator
Core 
Logger 
ConfigLoader 
Network 
FileServe 
HTTP 
Default 

Definition at line 25 of file IModule.hpp.

Member Function Documentation

IModule * Module::IModule::GetModule ( ICore &  core) const
pure virtual

The function return an instance of the module.

Parameters
core
Returns
pointer on module instance

Implemented in Module::ACore, Module::AModule, Compress, HelloWorld, and AddEvent.

std::string const & Module::IModule::GetName ( ) const
pure virtual
Returns
name of the module

Implemented in Module::AModule.

Type Module::IModule::GetType ( ) const
pure virtual
Returns
type of the module

Implemented in Module::AModule.

bool Module::IModule::Load ( )
pure virtual

Method for futur use.

Returns
true if everything is ok

Implemented in Module::AModule.

virtual bool Module::IModule::Unload ( )
pure virtual

Method for futur use.

bool Unload()

Returns
true if everything is ok

Implemented in Module::AModule.

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