wlog: change variable naming and fix documentation
* change State to active and make it BOOL since it's only got two used values * fix some typos in the documentation
This commit is contained in:
parent
59cc6c4117
commit
34c707304b
14
docs/wlog.md
14
docs/wlog.md
@ -12,7 +12,13 @@ TODO add more details and configuration examples.
|
|||||||
|
|
||||||
# Environment variables
|
# Environment variables
|
||||||
|
|
||||||
* WLOG_APPENDER - the appender to use
|
* WLOG_APPENDER - the appender to use possible values below also see the Appender section.
|
||||||
|
* CONSOLE
|
||||||
|
* FILE
|
||||||
|
* BINARY
|
||||||
|
* SYSLOG
|
||||||
|
* JOURNALD
|
||||||
|
* UDP
|
||||||
* WLOG_PREFIX - configure the prefix used for outputting the message (see
|
* WLOG_PREFIX - configure the prefix used for outputting the message (see
|
||||||
Format for more details and examples)
|
Format for more details and examples)
|
||||||
* WLOG_LEVEL - the level to output messages for
|
* WLOG_LEVEL - the level to output messages for
|
||||||
@ -34,7 +40,7 @@ The level list below is top down. Top the highest level.
|
|||||||
* WLOG_DEBUG - debug messages
|
* WLOG_DEBUG - debug messages
|
||||||
* WLOG_INFO - general informations
|
* WLOG_INFO - general informations
|
||||||
* WLOG_WARN - warnings
|
* WLOG_WARN - warnings
|
||||||
* WLOG_ERROR - error
|
* WLOG_ERROR - errors
|
||||||
* WLOG_FATAL - fatal problems
|
* WLOG_FATAL - fatal problems
|
||||||
* WLOG_OFF - completely disable the wlog output
|
* WLOG_OFF - completely disable the wlog output
|
||||||
|
|
||||||
@ -56,7 +62,7 @@ The format a logger prints in has the following possible options:
|
|||||||
* "hr" - hour
|
* "hr" - hour
|
||||||
* "mi" - minute
|
* "mi" - minute
|
||||||
* "se" - second
|
* "se" - second
|
||||||
* "ml" - milliseconds
|
* "ml" - millisecond
|
||||||
|
|
||||||
A maximum of 16 options can be used per format string.
|
A maximum of 16 options can be used per format string.
|
||||||
|
|
||||||
@ -118,7 +124,7 @@ Options:
|
|||||||
|
|
||||||
### Udp
|
### Udp
|
||||||
|
|
||||||
This appender sends the loging messages to a pre-defined remote host via UDP.
|
This appender sends the logging messages to a pre-defined remote host via UDP.
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
|
||||||
|
@ -62,10 +62,10 @@ BOOL WLog_OpenAppender(wLog* log)
|
|||||||
if (!appender->Open)
|
if (!appender->Open)
|
||||||
return TRUE;
|
return TRUE;
|
||||||
|
|
||||||
if (!appender->State)
|
if (!appender->active)
|
||||||
{
|
{
|
||||||
status = appender->Open(log, appender);
|
status = appender->Open(log, appender);
|
||||||
appender->State = 1;
|
appender->active = TRUE;
|
||||||
}
|
}
|
||||||
|
|
||||||
return status;
|
return status;
|
||||||
@ -84,10 +84,10 @@ BOOL WLog_CloseAppender(wLog* log)
|
|||||||
if (!appender->Close)
|
if (!appender->Close)
|
||||||
return TRUE;
|
return TRUE;
|
||||||
|
|
||||||
if (appender->State)
|
if (appender->active)
|
||||||
{
|
{
|
||||||
status = appender->Close(log, appender);
|
status = appender->Close(log, appender);
|
||||||
appender->State = 0;
|
appender->active = FALSE;
|
||||||
}
|
}
|
||||||
|
|
||||||
return status;
|
return status;
|
||||||
|
@ -120,7 +120,7 @@ BOOL WLog_Write(wLog* log, wLogMessage* message)
|
|||||||
if (!appender)
|
if (!appender)
|
||||||
return FALSE;
|
return FALSE;
|
||||||
|
|
||||||
if (!appender->State)
|
if (!appender->active)
|
||||||
if (!WLog_OpenAppender(log))
|
if (!WLog_OpenAppender(log))
|
||||||
return FALSE;
|
return FALSE;
|
||||||
|
|
||||||
@ -151,7 +151,7 @@ BOOL WLog_WriteData(wLog* log, wLogMessage* message)
|
|||||||
if (!appender)
|
if (!appender)
|
||||||
return FALSE;
|
return FALSE;
|
||||||
|
|
||||||
if (!appender->State)
|
if (!appender->active)
|
||||||
if (!WLog_OpenAppender(log))
|
if (!WLog_OpenAppender(log))
|
||||||
return FALSE;
|
return FALSE;
|
||||||
|
|
||||||
@ -182,7 +182,7 @@ BOOL WLog_WriteImage(wLog* log, wLogMessage* message)
|
|||||||
if (!appender)
|
if (!appender)
|
||||||
return FALSE;
|
return FALSE;
|
||||||
|
|
||||||
if (!appender->State)
|
if (!appender->active)
|
||||||
if (!WLog_OpenAppender(log))
|
if (!WLog_OpenAppender(log))
|
||||||
return FALSE;
|
return FALSE;
|
||||||
|
|
||||||
@ -213,7 +213,7 @@ BOOL WLog_WritePacket(wLog* log, wLogMessage* message)
|
|||||||
if (!appender)
|
if (!appender)
|
||||||
return FALSE;
|
return FALSE;
|
||||||
|
|
||||||
if (!appender->State)
|
if (!appender->active)
|
||||||
if (!WLog_OpenAppender(log))
|
if (!WLog_OpenAppender(log))
|
||||||
return FALSE;
|
return FALSE;
|
||||||
|
|
||||||
|
@ -37,7 +37,7 @@ typedef void (*WLOG_APPENDER_FREE)(wLogAppender* appender);
|
|||||||
|
|
||||||
#define WLOG_APPENDER_COMMON() \
|
#define WLOG_APPENDER_COMMON() \
|
||||||
DWORD Type; \
|
DWORD Type; \
|
||||||
DWORD State; \
|
BOOL active; \
|
||||||
wLogLayout* Layout; \
|
wLogLayout* Layout; \
|
||||||
CRITICAL_SECTION lock; \
|
CRITICAL_SECTION lock; \
|
||||||
BOOL recursive; \
|
BOOL recursive; \
|
||||||
|
Loading…
Reference in New Issue
Block a user