Libmodule core API#
Libmodule core API denotes the set of symbols exposed by
libmodule_core.so library, whose headers are installed in
It is made of multiple headers:
mod.hthat contains module related API
mod_easy.hthat contains an helper macro to build simplest applications, ie: single context, single module for each source file
ctx.hthat contains context related API
fs.h(installed only if
WITH_FScmake option is enabled) that contains libmodule fuseFS related API
cmn.hthat contains some common symbols, and cannot be manually included
For the sake of readiness, function params where an output value will be stored, are marked with
OUT (empty) macro.
All the libmodule core API returns an errno-style negative error code, where left unspecified.
Ideally, all of the exposed pointers have their lifetime reference based.
This means that you can call
m_mem_ref() API to manage eg:
m_evt_t pointers, and so on.
Normally, there is no such need because the library manages everything.
But if you called
m_mod_ref(), then you own a reference on that module and it’s up to you to free the reference by calling
m_mem_unref() on it.