osmocom
/
libosmocore
mirror of https://gerrit.osmocom.org/libosmocore
11
0
Fork 0
Code Issues Releases Wiki Activity

add API doc for LOGPFSM* macros 

Change-Id: I3bf6500889aa58195f50a726dec0876c0c2baec3
This commit is contained in:
Neels Hofmeyr 2018-12-20 00:19:29 +01:00
parent 785ecc9e50
commit b11ff7c537
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
include/osmocom/core/fsm.h
View File

@ -119,9 +119,24 @@ struct osmo_fsm_inst {
void osmo_fsm_log_addr(bool log_addr);
/*! Log using FSM instance's context, on explicit logging level.
* \param fi An osmo_fsm_inst.
* \param level A logging level, e.g. LOGL_INFO.
* \param fmt printf-like format string.
* \param args Format string arguments.
*/
#define LOGPFSML(fi, level, fmt, args...) \
LOGPFSMLSRC(fi, level, __FILE__, __LINE__, fmt, ## args)
/*! Log using FSM instance's context, on explicit logging level, and with explicit source file and line info.
* The log subsystem to log on is obtained from the underlying FSM definition.
* \param fi An osmo_fsm_inst.
* \param level A logging level, e.g. LOGL_INFO.
* \param caller_file A string constant containing a source file path, like __FILE__.
* \param caller_line A number constant containing a source file line, like __LINE__.
* \param fmt printf-like format string.
* \param args Format string arguments.
*/
#define LOGPFSMLSRC(fi, level, caller_file, caller_line, fmt, args...) \
LOGPSRC((fi)->fsm->log_subsys, level, \
caller_file, caller_line, \
@ -130,9 +145,25 @@ void osmo_fsm_log_addr(bool log_addr);
osmo_fsm_state_name((fi)->fsm, (fi)->state), \
## args)
/*! Log using FSM instance's context.
* The log level to log on is obtained from the FSM instance.
* The log subsystem to log on is obtained from the underlying FSM definition.
* \param fi An osmo_fsm_inst.
* \param fmt printf-like format string.
* \param args Format string arguments.
*/
#define LOGPFSM(fi, fmt, args...) \
LOGPFSML(fi, (fi)->log_level, fmt, ## args)
/*! Log using FSM instance's context, with explicit source file and line info.
* The log level to log on is obtained from the FSM instance.
* The log subsystem to log on is obtained from the underlying FSM definition.
* \param fi An osmo_fsm_inst.
* \param caller_file A string constant containing a source file path, like __FILE__.
* \param caller_line A number constant containing a source file line, like __LINE__.
* \param fmt printf-like format string.
* \param args Format string arguments.
*/
#define LOGPFSMSRC(fi, caller_file, caller_line, fmt, args...) \
LOGPFSMLSRC(fi, (fi)->log_level, \
caller_file, caller_line, \