1 /** @file ../inc/liblogger.h
5 /** @fn LibTracer(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aFormat,...)
7 @param aLogMessageType Type of the log message
8 @param aFileName pointer to the file name
9 @param aLine line number
10 @param aFormat pointer to the message format and ... Variable arguments
13 This is a message logging interface.
15 @return Upon successful completion it returns number to bytes write into the file .
22 /** @fn LibTracerMarkerList(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aFormat,VA_LIST* aMarkerList)
24 @param aLogMessageType Type of the log message
25 @param aFileName pointer to the file name
26 @param aLine line number
27 @param aFormat pointer to the message format
28 @param aMarkerList Variable list
31 This is a message logging interface.
33 @return Upon successful completion it returns number to bytes write into the file .
40 /** @fn LibTracerPartialHexDump(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aStr,int aStrLen)
42 @param aLogMessageType Type of the log message
43 @param aFileName pointer to the file name
44 @param aLine line number
45 @param aMessage pointer to the message as first line
46 @param aStr Dump string.
47 @param aStrLen Dump string length.
50 It dumps the message in hex format of specific dumps.
52 @return Upon successful completion it returns number to bytes write into the file .
59 /** @fn LibTracerHexDump(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aFormat,...)
61 @param aLogMessageType Type of the log message
62 @param aFileName pointer to the file name
63 @param aLine line number
64 @param aMessage pointer to the message as first line
65 @param aFormat pointer to the message format and ... Variable arguments
69 It dumps the message in hex format.
71 @return Upon successful completion it returns number to bytes write into the file .
78 /** @fn LibTracerHexDumpMarkerList(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aFormat,VA_LIST* aMarkerList)
80 @param aLogMessageType Type of the log message
81 @param aFileName pointer to the file name
82 @param aLine line number
83 @param aMessage pointer to the message as first line
84 @param aFormat pointer to the message format
85 @param aMarkerList Variable list
89 It dumps the message in hex format.
91 @return Upon successful completion it returns number to bytes write into the file .
98 /** @fn LibLineExecTracer(char *aFileName, int aLine)
100 @param aFileName pointer to the file name
101 @param aLine line number
104 It Only logs filename and line no with timestamp.
106 @return Upon successful completion it returns number to bytes write into the file .
109 @externallyDefinedApi
114 /** @fn LibMessageTracer(TLibTraceMessageType aLogMessageType,char *aFormat,VA_LIST* aMarkerList)
116 @param aLogMessageType Type of the log message
117 @param aFormat pointer to the message format
118 @param aMarkerList Variable list
121 It Only logs/traces message without timestamp
123 @return Upon successful completion it returns number to bytes write into the file .
126 @externallyDefinedApi
131 /** @fn LibHexDumpMessagePartTracer(TLibTraceMessageType aLogMessageType,char* aMessage,char *aFormat,VA_LIST* aMarkerList)
133 @param aLogMessageType Type of the log message
134 @param aMessage pointer to the message as first line
135 @param aFormat pointer to the message format
136 @param aMarkerList Variable list
139 It Only logs/traces message without timestamp
141 @return Upon successful completion it returns number to bytes write into the file .
144 @externallyDefinedApi
148 /** @typedef typedef enum TLibTraceMessageType TLibTraceMessageType
150 enums,defines log message type (Info/Minor/Major/Critical)
158 only logging for critical/major
164 /** @def LOG_FILE_NAME_LINE
166 This macro will be used for file and line no.
177 LIB_TRACE(<messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},format,args);
184 /** @def LIB_TRACE_DUMP
188 LIB_TRACE_DUMP(<messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},message, // user wants to add any message before dump, (i.e. TCP message)format,args);@publishedAll
195 /** @def LIB_TRACE_DUMP_LEN
199 LIB_TRACE_DUMP_LEN(<messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},message, // user wants to add any message before dump, (i.e. TCP message)umpstring,stringlength);