#include <module.h>
Module functionality block
Definition at line 642 of file module.h.
◆ clear
| void(* module_func_block::clear) (struct module_qstate *qstate, int id) |
clear module specific data
Definition at line 701 of file module.h.
◆ deinit
| void(* module_func_block::deinit) (struct module_env *env, int id) |
de-init, delete, the module. Called once for the global state.
- Parameters
-
| env | module environment. |
| id | module id number. |
Definition at line 660 of file module.h.
◆ get_mem
| size_t(* module_func_block::get_mem) (struct module_env *env, int id) |
How much memory is the module specific data using.
- Parameters
-
| env | module environment. |
| id | the module id. |
- Returns
- the number of bytes that are alloced.
Definition at line 709 of file module.h.
◆ inform_super
inform super querystate about the results from this subquerystate. Is called when the querystate is finished. The method invoked is the one from the current module active in the super querystate.
- Parameters
-
| qstate | the query state that is finished. Examine return_rcode and return_reply in the qstate. |
| id | module id for this module. This coincides with the current module for the super qstate. |
| super | the super querystate that needs to be informed. |
Definition at line 695 of file module.h.
◆ init
| int(* module_func_block::init) (struct module_env *env, int id) |
init the module. Called once for the global state. This is the place to apply settings from the config file.
- Parameters
-
| env | module environment. |
| id | module id number. return: 0 on error |
Definition at line 653 of file module.h.
◆ name
| const char* module_func_block::name |
text string name of module
Definition at line 644 of file module.h.
◆ operate
accept a new query, or work further on existing query. Changes the qstate->ext_state to be correct on exit.
- Parameters
-
| ev | event that causes the module state machine to (re-)activate. |
| qstate | the query state. Note that this method is not allowed to change the query state 'identity', that is query info, qflags, and priming status. Attach a subquery to get results to a different query. |
| id | module id number that operate() is called on. |
| outbound | if not NULL this event is due to the reply/timeout or error on this outbound query. |
- Returns
- : if at exit the ext_state is: o wait_module: next module is started. (with pass event). o error or finished: previous module is resumed. o otherwise it waits until that event happens (assumes the service routine to make subrequest or send message have been called.
Definition at line 682 of file module.h.
The documentation for this struct was generated from the following file:
- /home/abuild/rpmbuild/BUILD/electroneum-5.0.0.4/external/unbound/util/module.h