sl@0: /** @file ../inc/liblogger.h sl@0: @internalComponent sl@0: */ sl@0: sl@0: /** @fn LibTracer(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aFormat,...) sl@0: sl@0: @param aLogMessageType Type of the log message sl@0: @param aFileName pointer to the file name sl@0: @param aLine line number sl@0: @param aFormat pointer to the message format and ... Variable arguments sl@0: sl@0: Description: sl@0: This is a message logging interface. sl@0: sl@0: @return Upon successful completion it returns number to bytes write into the file . sl@0: sl@0: sl@0: @publishedAll sl@0: @externallyDefinedApi sl@0: sl@0: */ sl@0: /** @fn LibTracerMarkerList(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aFormat,VA_LIST* aMarkerList) sl@0: sl@0: @param aLogMessageType Type of the log message sl@0: @param aFileName pointer to the file name sl@0: @param aLine line number sl@0: @param aFormat pointer to the message format sl@0: @param aMarkerList Variable list sl@0: sl@0: Description: sl@0: This is a message logging interface. sl@0: sl@0: @return Upon successful completion it returns number to bytes write into the file . sl@0: sl@0: @publishedAll sl@0: @externallyDefinedApi sl@0: sl@0: */ sl@0: sl@0: /** @fn LibTracerPartialHexDump(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aStr,int aStrLen) sl@0: sl@0: @param aLogMessageType Type of the log message sl@0: @param aFileName pointer to the file name sl@0: @param aLine line number sl@0: @param aMessage pointer to the message as first line sl@0: @param aStr Dump string. sl@0: @param aStrLen Dump string length. sl@0: sl@0: Description: sl@0: It dumps the message in hex format of specific dumps. sl@0: sl@0: @return Upon successful completion it returns number to bytes write into the file . sl@0: sl@0: @publishedAll sl@0: @externallyDefinedApi sl@0: sl@0: */ sl@0: sl@0: /** @fn LibTracerHexDump(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aFormat,...) sl@0: sl@0: @param aLogMessageType Type of the log message sl@0: @param aFileName pointer to the file name sl@0: @param aLine line number sl@0: @param aMessage pointer to the message as first line sl@0: @param aFormat pointer to the message format and ... Variable arguments sl@0: sl@0: sl@0: Description: sl@0: It dumps the message in hex format. sl@0: sl@0: @return Upon successful completion it returns number to bytes write into the file . sl@0: sl@0: @publishedAll sl@0: @externallyDefinedApi sl@0: sl@0: */ sl@0: sl@0: /** @fn LibTracerHexDumpMarkerList(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aFormat,VA_LIST* aMarkerList) sl@0: sl@0: @param aLogMessageType Type of the log message sl@0: @param aFileName pointer to the file name sl@0: @param aLine line number sl@0: @param aMessage pointer to the message as first line sl@0: @param aFormat pointer to the message format sl@0: @param aMarkerList Variable list sl@0: sl@0: sl@0: Description: sl@0: It dumps the message in hex format. sl@0: sl@0: @return Upon successful completion it returns number to bytes write into the file . sl@0: sl@0: @publishedAll sl@0: @externallyDefinedApi sl@0: sl@0: */ sl@0: sl@0: /** @fn LibLineExecTracer(char *aFileName, int aLine) sl@0: sl@0: @param aFileName pointer to the file name sl@0: @param aLine line number sl@0: sl@0: Description: sl@0: It Only logs filename and line no with timestamp. sl@0: sl@0: @return Upon successful completion it returns number to bytes write into the file . sl@0: sl@0: @publishedAll sl@0: @externallyDefinedApi sl@0: sl@0: */ sl@0: sl@0: sl@0: /** @fn LibMessageTracer(TLibTraceMessageType aLogMessageType,char *aFormat,VA_LIST* aMarkerList) sl@0: sl@0: @param aLogMessageType Type of the log message sl@0: @param aFormat pointer to the message format sl@0: @param aMarkerList Variable list sl@0: sl@0: Description: sl@0: It Only logs/traces message without timestamp sl@0: sl@0: @return Upon successful completion it returns number to bytes write into the file . sl@0: sl@0: @publishedAll sl@0: @externallyDefinedApi sl@0: sl@0: */ sl@0: sl@0: sl@0: /** @fn LibHexDumpMessagePartTracer(TLibTraceMessageType aLogMessageType,char* aMessage,char *aFormat,VA_LIST* aMarkerList) sl@0: sl@0: @param aLogMessageType Type of the log message sl@0: @param aMessage pointer to the message as first line sl@0: @param aFormat pointer to the message format sl@0: @param aMarkerList Variable list sl@0: sl@0: Description: sl@0: It Only logs/traces message without timestamp sl@0: sl@0: @return Upon successful completion it returns number to bytes write into the file . sl@0: sl@0: @publishedAll sl@0: @externallyDefinedApi sl@0: sl@0: */ sl@0: sl@0: /** @typedef typedef enum TLibTraceMessageType TLibTraceMessageType sl@0: sl@0: enums,defines log message type (Info/Minor/Major/Critical) sl@0: sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: sl@0: /** @def LOG_BITS sl@0: sl@0: only logging for critical/major sl@0: sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: sl@0: /** @def LOG_FILE_NAME_LINE sl@0: sl@0: This macro will be used for file and line no. sl@0: sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: sl@0: sl@0: /** @def LIB_TRACE sl@0: sl@0: Usage: sl@0: @code sl@0: LIB_TRACE({ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},format,args); sl@0: @endcode sl@0: sl@0: @publishedAll sl@0: @released sl@0: */ sl@0: sl@0: /** @def LIB_TRACE_DUMP sl@0: sl@0: Usage: sl@0: @code sl@0: LIB_TRACE_DUMP({ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},message, // user wants to add any message before dump, (i.e. TCP message)format,args);@publishedAll sl@0: @endcode sl@0: sl@0: @released sl@0: */ sl@0: sl@0: sl@0: /** @def LIB_TRACE_DUMP_LEN sl@0: sl@0: Usage: sl@0: @code sl@0: LIB_TRACE_DUMP_LEN({ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},message, // user wants to add any message before dump, (i.e. TCP message)umpstring,stringlength); sl@0: @endcode sl@0: sl@0: @publishedAll sl@0: @released sl@0: */