Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ModuleTestClient Class Reference

Inheritance diagram for ModuleTestClient:

[legend]Collaboration diagram for ModuleTestClient:

[legend]List of all members.

Public Member Functions
	ModuleTestClient (InspIRCd *Me)
virtual Version	GetVersion ()
	Returns the version number of a Module.
virtual void	OnBackgroundTimer (time_t)
	Called once every five seconds for background processing.
virtual const char *	OnRequest (Request *request)
	Called whenever a Request class is sent to your module by another module.
virtual	~ModuleTestClient ()

---

Detailed Description

Definition at line 17 of file m_testclient.cpp.

---

Constructor & Destructor Documentation

ModuleTestClient::ModuleTestClient (  InspIRCd *  Me  )  [inline]

Definition at line 23 of file m_testclient.cpp. References ModuleManager::Attach(), I_OnBackgroundTimer, I_OnRequest, InspIRCd::Modules, and Module::ServerInstance.

virtual ModuleTestClient::~ModuleTestClient (   )  [inline, virtual]

Definition at line 99 of file m_testclient.cpp.

---

Member Function Documentation

virtual Version ModuleTestClient::GetVersion (   )  [inline, virtual]

Returns the version number of a Module. The method should return a Version object with its version information assigned via Version::Version Reimplemented from Module. Definition at line 31 of file m_testclient.cpp. References API_VERSION, and VF_VENDOR.

virtual void ModuleTestClient::OnBackgroundTimer (  time_t   )  [inline, virtual]

Called once every five seconds for background processing. This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server. Parameters: curtime  The current timer derived from time(2) Reimplemented from Module. Definition at line 36 of file m_testclient.cpp. References DEBUG, SQLrequest::error, ModuleManager::FindFeature(), SQLrequest::id, LogManager::Log(), InspIRCd::Logs, InspIRCd::Modules, Request::Send(), Module::ServerInstance, SQLerror::Str(), and InspIRCd::Time().

virtual const char* ModuleTestClient::OnRequest (  Request *  request  )  [inline, virtual]

Called whenever a Request class is sent to your module by another module. Please see the documentation of Request::Send() for further information. The Request sent can always be assumed to be non-NULL, you should not change the request object or its data. Your method may return arbitary data in the char* result which the requesting module may be able to use for pre-determined purposes (e.g. the results of an SQL query, etc). Parameters: request  The Request class being received Reimplemented from Module. Definition at line 56 of file m_testclient.cpp. References SQLresult::ColName(), SQLresult::Cols(), SQLfield::d, DEBUG, SQLresult::error, Request::GetId(), SQLresult::GetValue(), SQLerror::Id(), LogManager::Log(), InspIRCd::Logs, SQLresult::Rows(), Module::ServerInstance, SQL_NO_ERROR, SQLRESID, SQLSUCCESS, and SQLerror::Str().

---

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

• m_testclient.cpp