1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericopenlibs/openenvcore/liblogger/inc/liblogger.dosc Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,204 @@
1.4 +/** @file ../inc/liblogger.h
1.5 +@internalComponent
1.6 +*/
1.7 +
1.8 +/** @fn LibTracer(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aFormat,...)
1.9 +
1.10 +@param aLogMessageType Type of the log message
1.11 +@param aFileName pointer to the file name
1.12 +@param aLine line number
1.13 +@param aFormat pointer to the message format and ... Variable arguments
1.14 +
1.15 +Description:
1.16 +This is a message logging interface.
1.17 +
1.18 +@return Upon successful completion it returns number to bytes write into the file .
1.19 +
1.20 +
1.21 +@publishedAll
1.22 +@externallyDefinedApi
1.23 +
1.24 +*/
1.25 +/** @fn LibTracerMarkerList(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aFormat,VA_LIST* aMarkerList)
1.26 +
1.27 +@param aLogMessageType Type of the log message
1.28 +@param aFileName pointer to the file name
1.29 +@param aLine line number
1.30 +@param aFormat pointer to the message format
1.31 +@param aMarkerList Variable list
1.32 +
1.33 +Description:
1.34 +This is a message logging interface.
1.35 +
1.36 +@return Upon successful completion it returns number to bytes write into the file .
1.37 +
1.38 +@publishedAll
1.39 +@externallyDefinedApi
1.40 +
1.41 +*/
1.42 +
1.43 +/** @fn LibTracerPartialHexDump(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aStr,int aStrLen)
1.44 +
1.45 +@param aLogMessageType Type of the log message
1.46 +@param aFileName pointer to the file name
1.47 +@param aLine line number
1.48 +@param aMessage pointer to the message as first line
1.49 +@param aStr Dump string.
1.50 +@param aStrLen Dump string length.
1.51 +
1.52 +Description:
1.53 +It dumps the message in hex format of specific dumps.
1.54 +
1.55 +@return Upon successful completion it returns number to bytes write into the file .
1.56 +
1.57 +@publishedAll
1.58 +@externallyDefinedApi
1.59 +
1.60 +*/
1.61 +
1.62 +/** @fn LibTracerHexDump(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aFormat,...)
1.63 +
1.64 +@param aLogMessageType Type of the log message
1.65 +@param aFileName pointer to the file name
1.66 +@param aLine line number
1.67 +@param aMessage pointer to the message as first line
1.68 +@param aFormat pointer to the message format and ... Variable arguments
1.69 +
1.70 +
1.71 +Description:
1.72 +It dumps the message in hex format.
1.73 +
1.74 +@return Upon successful completion it returns number to bytes write into the file .
1.75 +
1.76 +@publishedAll
1.77 +@externallyDefinedApi
1.78 +
1.79 +*/
1.80 +
1.81 +/** @fn LibTracerHexDumpMarkerList(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aFormat,VA_LIST* aMarkerList)
1.82 +
1.83 +@param aLogMessageType Type of the log message
1.84 +@param aFileName pointer to the file name
1.85 +@param aLine line number
1.86 +@param aMessage pointer to the message as first line
1.87 +@param aFormat pointer to the message format
1.88 +@param aMarkerList Variable list
1.89 +
1.90 +
1.91 +Description:
1.92 +It dumps the message in hex format.
1.93 +
1.94 +@return Upon successful completion it returns number to bytes write into the file .
1.95 +
1.96 +@publishedAll
1.97 +@externallyDefinedApi
1.98 +
1.99 +*/
1.100 +
1.101 +/** @fn LibLineExecTracer(char *aFileName, int aLine)
1.102 +
1.103 +@param aFileName pointer to the file name
1.104 +@param aLine line number
1.105 +
1.106 +Description:
1.107 +It Only logs filename and line no with timestamp.
1.108 +
1.109 +@return Upon successful completion it returns number to bytes write into the file .
1.110 +
1.111 +@publishedAll
1.112 +@externallyDefinedApi
1.113 +
1.114 +*/
1.115 +
1.116 +
1.117 +/** @fn LibMessageTracer(TLibTraceMessageType aLogMessageType,char *aFormat,VA_LIST* aMarkerList)
1.118 +
1.119 +@param aLogMessageType Type of the log message
1.120 +@param aFormat pointer to the message format
1.121 +@param aMarkerList Variable list
1.122 +
1.123 +Description:
1.124 +It Only logs/traces message without timestamp
1.125 +
1.126 +@return Upon successful completion it returns number to bytes write into the file .
1.127 +
1.128 +@publishedAll
1.129 +@externallyDefinedApi
1.130 +
1.131 +*/
1.132 +
1.133 +
1.134 +/** @fn LibHexDumpMessagePartTracer(TLibTraceMessageType aLogMessageType,char* aMessage,char *aFormat,VA_LIST* aMarkerList)
1.135 +
1.136 +@param aLogMessageType Type of the log message
1.137 +@param aMessage pointer to the message as first line
1.138 +@param aFormat pointer to the message format
1.139 +@param aMarkerList Variable list
1.140 +
1.141 +Description:
1.142 +It Only logs/traces message without timestamp
1.143 +
1.144 +@return Upon successful completion it returns number to bytes write into the file .
1.145 +
1.146 +@publishedAll
1.147 +@externallyDefinedApi
1.148 +
1.149 +*/
1.150 +
1.151 +/** @typedef typedef enum TLibTraceMessageType TLibTraceMessageType
1.152 +
1.153 +enums,defines log message type (Info/Minor/Major/Critical)
1.154 +
1.155 +@publishedAll
1.156 +@released
1.157 +*/
1.158 +
1.159 +/** @def LOG_BITS
1.160 +
1.161 +only logging for critical/major
1.162 +
1.163 +@publishedAll
1.164 +@released
1.165 +*/
1.166 +
1.167 +/** @def LOG_FILE_NAME_LINE
1.168 +
1.169 +This macro will be used for file and line no.
1.170 +
1.171 +@publishedAll
1.172 +@released
1.173 +*/
1.174 +
1.175 +
1.176 +/** @def LIB_TRACE
1.177 +
1.178 +Usage:
1.179 +@code
1.180 +LIB_TRACE(<messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},format,args);
1.181 +@endcode
1.182 +
1.183 +@publishedAll
1.184 +@released
1.185 +*/
1.186 +
1.187 +/** @def LIB_TRACE_DUMP
1.188 +
1.189 +Usage:
1.190 +@code
1.191 +LIB_TRACE_DUMP(<messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},message, // user wants to add any message before dump, (i.e. TCP message)format,args);@publishedAll
1.192 +@endcode
1.193 +
1.194 +@released
1.195 +*/
1.196 +
1.197 +
1.198 +/** @def LIB_TRACE_DUMP_LEN
1.199 +
1.200 +Usage:
1.201 +@code
1.202 +LIB_TRACE_DUMP_LEN(<messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},message, // user wants to add any message before dump, (i.e. TCP message)umpstring,stringlength);
1.203 +@endcode
1.204 +
1.205 +@publishedAll
1.206 +@released
1.207 +*/