os/ossrv/genericopenlibs/openenvcore/liblogger/inc/liblogger.dosc
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/** @file ../inc/liblogger.h
sl@0
     2
@internalComponent
sl@0
     3
*/
sl@0
     4
sl@0
     5
/** @fn  LibTracer(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aFormat,...)
sl@0
     6
sl@0
     7
@param aLogMessageType Type of the log message
sl@0
     8
@param aFileName pointer to the file name 
sl@0
     9
@param aLine line number
sl@0
    10
@param aFormat pointer to the message format and ... Variable arguments
sl@0
    11
sl@0
    12
Description:
sl@0
    13
This is a message logging interface.
sl@0
    14
sl@0
    15
@return   Upon successful completion it returns number to bytes write into the file .
sl@0
    16
sl@0
    17
sl@0
    18
@publishedAll
sl@0
    19
@externallyDefinedApi
sl@0
    20
sl@0
    21
*/
sl@0
    22
/** @fn  LibTracerMarkerList(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aFormat,VA_LIST* aMarkerList)
sl@0
    23
sl@0
    24
@param aLogMessageType Type of the log message
sl@0
    25
@param aFileName pointer to the file name 
sl@0
    26
@param aLine line number
sl@0
    27
@param aFormat pointer to the message format
sl@0
    28
@param aMarkerList Variable list
sl@0
    29
sl@0
    30
Description:
sl@0
    31
This is a message logging interface.
sl@0
    32
sl@0
    33
@return   Upon successful completion it returns number to bytes write into the file .
sl@0
    34
sl@0
    35
@publishedAll
sl@0
    36
@externallyDefinedApi
sl@0
    37
sl@0
    38
*/
sl@0
    39
sl@0
    40
/** @fn  LibTracerPartialHexDump(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aStr,int aStrLen)
sl@0
    41
sl@0
    42
@param aLogMessageType Type of the log message
sl@0
    43
@param aFileName pointer to the file name 
sl@0
    44
@param aLine line number
sl@0
    45
@param aMessage pointer to the message as first line
sl@0
    46
@param aStr Dump string.  
sl@0
    47
@param aStrLen Dump string length. 
sl@0
    48
sl@0
    49
Description:
sl@0
    50
It dumps the message in hex format of specific dumps.
sl@0
    51
sl@0
    52
@return   Upon successful completion it returns number to bytes write into the file .
sl@0
    53
sl@0
    54
@publishedAll
sl@0
    55
@externallyDefinedApi
sl@0
    56
sl@0
    57
*/
sl@0
    58
sl@0
    59
/** @fn  LibTracerHexDump(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aFormat,...)
sl@0
    60
sl@0
    61
@param aLogMessageType Type of the log message
sl@0
    62
@param aFileName pointer to the file name 
sl@0
    63
@param aLine line number
sl@0
    64
@param aMessage pointer to the message as first line
sl@0
    65
@param aFormat pointer to the message format and ... Variable arguments
sl@0
    66
sl@0
    67
sl@0
    68
Description:
sl@0
    69
It dumps the message in hex format.
sl@0
    70
sl@0
    71
@return   Upon successful completion it returns number to bytes write into the file .
sl@0
    72
sl@0
    73
@publishedAll
sl@0
    74
@externallyDefinedApi
sl@0
    75
sl@0
    76
*/
sl@0
    77
sl@0
    78
/** @fn  LibTracerHexDumpMarkerList(TLibTraceMessageType aLogMessageType,char *aFileName,int aLine,char *aMessage,char *aFormat,VA_LIST* aMarkerList)
sl@0
    79
sl@0
    80
@param aLogMessageType Type of the log message
sl@0
    81
@param aFileName pointer to the file name 
sl@0
    82
@param aLine line number
sl@0
    83
@param aMessage pointer to the message as first line
sl@0
    84
@param aFormat pointer to the message format 
sl@0
    85
@param aMarkerList Variable list
sl@0
    86
sl@0
    87
sl@0
    88
Description:
sl@0
    89
It dumps the message in hex format.
sl@0
    90
sl@0
    91
@return   Upon successful completion it returns number to bytes write into the file .
sl@0
    92
sl@0
    93
@publishedAll
sl@0
    94
@externallyDefinedApi
sl@0
    95
sl@0
    96
*/
sl@0
    97
sl@0
    98
/** @fn  LibLineExecTracer(char *aFileName, int aLine)
sl@0
    99
sl@0
   100
@param aFileName pointer to the file name 
sl@0
   101
@param aLine line number
sl@0
   102
sl@0
   103
Description:
sl@0
   104
It Only logs filename and line no with timestamp.
sl@0
   105
sl@0
   106
@return   Upon successful completion it returns number to bytes write into the file .
sl@0
   107
sl@0
   108
@publishedAll
sl@0
   109
@externallyDefinedApi
sl@0
   110
sl@0
   111
*/
sl@0
   112
sl@0
   113
sl@0
   114
/** @fn  LibMessageTracer(TLibTraceMessageType aLogMessageType,char *aFormat,VA_LIST* aMarkerList)
sl@0
   115
sl@0
   116
@param aLogMessageType Type of the log message
sl@0
   117
@param aFormat pointer to the message format 
sl@0
   118
@param aMarkerList Variable list
sl@0
   119
sl@0
   120
Description:
sl@0
   121
It Only logs/traces message without timestamp
sl@0
   122
sl@0
   123
@return   Upon successful completion it returns number to bytes write into the file .
sl@0
   124
sl@0
   125
@publishedAll
sl@0
   126
@externallyDefinedApi
sl@0
   127
sl@0
   128
*/
sl@0
   129
sl@0
   130
sl@0
   131
/** @fn  LibHexDumpMessagePartTracer(TLibTraceMessageType aLogMessageType,char* aMessage,char *aFormat,VA_LIST* aMarkerList)
sl@0
   132
sl@0
   133
@param aLogMessageType Type of the log message
sl@0
   134
@param aMessage pointer to the message as first line
sl@0
   135
@param aFormat pointer to the message format 
sl@0
   136
@param aMarkerList Variable list
sl@0
   137
sl@0
   138
Description:
sl@0
   139
It Only logs/traces message without timestamp
sl@0
   140
sl@0
   141
@return   Upon successful completion it returns number to bytes write into the file .
sl@0
   142
sl@0
   143
@publishedAll
sl@0
   144
@externallyDefinedApi
sl@0
   145
sl@0
   146
*/
sl@0
   147
sl@0
   148
/** @typedef typedef enum TLibTraceMessageType TLibTraceMessageType
sl@0
   149
sl@0
   150
enums,defines log message type (Info/Minor/Major/Critical)
sl@0
   151
sl@0
   152
@publishedAll
sl@0
   153
@released
sl@0
   154
*/
sl@0
   155
sl@0
   156
/** @def LOG_BITS
sl@0
   157
sl@0
   158
only logging for critical/major
sl@0
   159
sl@0
   160
@publishedAll
sl@0
   161
@released
sl@0
   162
*/
sl@0
   163
sl@0
   164
/** @def LOG_FILE_NAME_LINE
sl@0
   165
sl@0
   166
This macro will be used for file and line no.
sl@0
   167
sl@0
   168
@publishedAll
sl@0
   169
@released
sl@0
   170
*/
sl@0
   171
sl@0
   172
sl@0
   173
/** @def LIB_TRACE
sl@0
   174
sl@0
   175
Usage:
sl@0
   176
@code
sl@0
   177
LIB_TRACE(<messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},format,args);
sl@0
   178
@endcode
sl@0
   179
sl@0
   180
@publishedAll
sl@0
   181
@released
sl@0
   182
*/
sl@0
   183
sl@0
   184
/** @def LIB_TRACE_DUMP
sl@0
   185
sl@0
   186
Usage:
sl@0
   187
@code
sl@0
   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
sl@0
   189
@endcode
sl@0
   190
sl@0
   191
@released
sl@0
   192
*/
sl@0
   193
sl@0
   194
sl@0
   195
/** @def LIB_TRACE_DUMP_LEN
sl@0
   196
sl@0
   197
Usage:
sl@0
   198
@code
sl@0
   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);
sl@0
   200
@endcode
sl@0
   201
sl@0
   202
@publishedAll
sl@0
   203
@released
sl@0
   204
*/