SaltAPI  1.1
An API for the HTTPd / Zia by Salty Studio.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Module::AModule Class Reference

#include <AModule.hpp>

Inheritance diagram for Module::AModule:
Collaboration diagram for Module::AModule:

Public Member Functions

 AModule (ICore &core, Type type, std::string const &name)
 
virtual ~AModule ()
 
std::string const & GetName () const override
 
Type GetType () const override
 
bool Load () override
 Method for futur use. More...
 
bool Unload () override
 Method for futur use. More...
 
virtual IModuleGetModule (ICore &core) const override
 The function return an instance of the module. More...
 

Protected Attributes

ICorem_core
 
std::string m_name
 
Type m_type
 

Additional Inherited Members

- Public Types inherited from Module::IModule
enum  Type {
  Core, Logger, ConfigLoader, Network,
  FileServe, HTTP, Default
}
 

Detailed Description

Definition at line 13 of file AModule.hpp.

Constructor & Destructor Documentation

Module::AModule::AModule ( ICore core,
Type  type,
std::string const &  name 
)

Definition at line 8 of file AModule.cpp.

Here is the caller graph for this function:

Module::AModule::~AModule ( )
virtual

Definition at line 13 of file AModule.cpp.

Member Function Documentation

IModule * Module::AModule::GetModule ( ICore core) const
overridevirtual

The function return an instance of the module.

Parameters
core
Returns
pointer on module instance

Implements Module::IModule.

Reimplemented in Module::ACore, Compress, HelloWorld, and AddEvent.

Definition at line 33 of file AModule.cpp.

Here is the call graph for this function:

std::string const & Module::AModule::GetName ( ) const
overridevirtual
Returns
name of the module

Implements Module::IModule.

Definition at line 17 of file AModule.cpp.

IModule::Type Module::AModule::GetType ( ) const
overridevirtual
Returns
type of the module

Implements Module::IModule.

Definition at line 21 of file AModule.cpp.

bool Module::AModule::Load ( )
overridevirtual

Method for futur use.

Returns
true if everything is ok

Implements Module::IModule.

Definition at line 25 of file AModule.cpp.

bool Module::AModule::Unload ( )
overridevirtual

Method for futur use.

bool Unload()

Returns
true if everything is ok

Implements Module::IModule.

Definition at line 29 of file AModule.cpp.

Member Data Documentation

ICore& Module::AModule::m_core
protected

Definition at line 20 of file AModule.hpp.

std::string Module::AModule::m_name
protected

Definition at line 21 of file AModule.hpp.

Type Module::AModule::m_type
protected

Definition at line 22 of file AModule.hpp.


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