Module Events
[Furnarchy 2]

Module events. More...

Enumerations

enum  Module_Event {
  MOD_EVENT_START, MOD_EVENT_STOP, MOD_EVENT_ENABLE, MOD_EVENT_DISABLE,
  MOD_EVENT_TOUCH, MOD_EVENT_MSG
}

Detailed Description

Module events.

These events are received through a module's on_module() event handler. The event determines the type and meaning of on_module()'s param parameter and return value.

See also:
on_module

Enumeration Type Documentation

enum Module_Event

Enumerator:
MOD_EVENT_START  The module is being started for the first time.

Parameters:
[in] param A const MODULEINFO*
Returns:
Return 0 always.
See also:
MODULEINFO
MOD_EVENT_STOP  The module is being shut down.

Parameters:
[in] param Not used.
Returns:
Return 0 always.
MOD_EVENT_ENABLE  The module has been enabled.

Parameters:
[in] param Not used.
Returns:
Return 0 always.
See also:
f2_modenable()
MOD_EVENT_DISABLE  The module has been disabled.

Parameters:
[in] param Not used.
Returns:
Return 0 always.
See also:
f2_modenable()
MOD_EVENT_TOUCH  The module has been touched.

Parameters:
[in] param Not used.
Returns:
Return 0 always.
See also:
f2_modtouch()
MOD_EVENT_MSG  An arbitrary communication/transport event.

Parameters:
[in] param Meaning is arbitrary.
Returns:
Meaning is arbitrary.
Remarks:
It's up to modules communicating with each other via MOD_EVENT_MSG to agree on what the parameters and return value mean.
See also:
f2_modmsg()


Generated on Tue Jun 24 12:24:07 2008 for Furnarchy Module by  doxygen 1.5.5