OpenClovis Logo

clLogApi.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2002-2012 OpenClovis Solutions Inc. All Rights Reserved.
3  *
4  * This file is available under a commercial license from the
5  * copyright holder or the GNU General Public License Version 2.0.
6  *
7  * The source code for this program is not published or otherwise
8  * divested of its trade secrets, irrespective of what has been
9  * deposited with the U.S. Copyright office.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * For more information, see the file COPYING provided with this
17  * material.
18  */
19 
32 #ifndef _CL_LOG_API_H_
33 #define _CL_LOG_API_H_
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 #include <sys/types.h> /* For getpid() */
40 #include <unistd.h>
41 
42 #include <string.h>
43 #include <stdio.h>
44 #include <stdarg.h>
45 #include <clTimerApi.h>
46 #include <clCommon.h>
47 #include <clDbg.h>
48 #include <clLogUtilApi.h>
49 
50 /*********************************
51  Data Types
52 *********************************/
53 
57 typedef ClHandleT ClLogHandleT;
58 
63 typedef ClHandleT ClLogStreamHandleT;
64 
69 typedef ClHandleT ClLogFileHandleT;
70 
74 #define CL_LOG_STREAM_NAME_MAX_LENGTH 128
78 #define CL_LOG_SLINE_MSG_LEN 256
79 
80 
86 typedef enum
87 {
97 
102 typedef enum
103 {
122 
126 typedef struct
127 {
131  ClCharT *fileName;
135  ClCharT *fileLocation;
139  ClUint32T fileUnitSize;
143  ClUint32T recordSize;
147  ClBoolT haProperty;
156  ClUint32T maxFilesRotated;
160  ClUint32T flushFreq;
169  ClWaterMarkT waterMark;
170 
171  /*
172  * Syslog enabler for the stream.
173  */
174  ClBoolT syslog;
176 
181 #define CL_LOG_STREAM_CREATE 0x1
182 
186 typedef ClUint8T ClLogStreamOpenFlagsT;
187 
191 typedef struct
192 {
208  ClUint16T streamId;
214 
219 typedef struct
220 {
236  ClUint16T streamId;
238 
243 #define CL_LOG_HANDLER_WILL_ACK 0x1
244 
249 typedef ClUint8T ClLogStreamHandlerFlagsT;
250 
251 typedef enum
252  {
285  CL_LOG_SEV_DEBUG1 = CL_LOG_SEV_DEBUG,
286  CL_LOG_SEV_DEBUG2,
287  CL_LOG_SEV_DEBUG3,
288  CL_LOG_SEV_DEBUG4,
289  CL_LOG_SEV_DEBUG5,
293  CL_LOG_SEV_TRACE = CL_LOG_SEV_DEBUG5,
294  CL_LOG_SEV_DEBUG6,
295  CL_LOG_SEV_DEBUG7,
296  CL_LOG_SEV_DEBUG8,
297  CL_LOG_SEV_DEBUG9,
301  CL_LOG_SEV_MAX = CL_LOG_SEV_DEBUG9
303 
304 #if 0
308 #define CL_LOG_SEV_EMERGENCY 0x1
312 #define CL_LOG_SEV_ALERT 0x2
316 #define CL_LOG_SEV_CRITICAL 0x3
320 #define CL_LOG_SEV_ERROR 0x4
324 #define CL_LOG_SEV_WARNING 0x5
328 #define CL_LOG_SEV_NOTICE 0x6
332 #define CL_LOG_SEV_INFO 0x7
336 #define CL_LOG_SEV_DEBUG 0x8
340 #define CL_LOG_SEV_TRACE CL_LOG_TRACE
344 #define CL_LOG_SEV_MAX CL_LOG_DEBUG9
345 #endif
346 
352 typedef ClUint16T ClLogSeverityFilterT;
353 
357 #define CL_LOG_FILTER_ASSIGN 0x1
358 
362 #define CL_LOG_FILTER_MERGE_ADD 0x2
363 
367 #define CL_LOG_FILTER_MERGE_DELETE 0x3
368 
372 typedef ClUint8T ClLogFilterFlagsT;
373 
374 
378 typedef struct
379 {
387  ClUint16T msgIdSetLength;
391  ClUint8T *pMsgIdSet;
395  ClUint16T compIdSetLength;
399  ClUint8T *pCompIdSet;
400 } ClLogFilterT;
401 
455 typedef void (*ClLogStreamOpenCallbackT)(
456  CL_IN ClInvocationT invocation,
457  CL_IN ClLogStreamHandleT hStream,
458  CL_IN ClRcT rc);
459 
489 typedef void (*ClLogFilterSetCallbackT)(
490  CL_IN ClLogStreamHandleT hStream,
491  CL_IN ClLogFilterT filter);
492 
533  CL_IN ClLogStreamHandleT hStream,
534  CL_IN ClUint64T seqNum,
535  CL_IN ClUint32T numRecords,
536  CL_IN ClPtrT pRecords);
537 
542 typedef struct
543 {
559 #if 0
560  ClLogWriteCallbackT clLogWriteCallback;
561 #endif
563 
564 
568 #define CL_LOG_MSGID_BUFFER 0
569 
573 #define CL_LOG_MSGID_PRINTF_FMT 1
574 
578 #define CL_LOG_TAG_TERMINATE 0
579 
589 #define CL_LOG_TAG_BASIC_SIGNED 0x1
593 #define CL_LOG_TAG_BASIC_UNSIGNED 0x2
597 #define CL_LOG_TAG_STRING 0x3
598 
602 #define CL_LOG_TLV_UINT8(var) \
603  CL_LOG_TAG_BASIC_UNSIGNED, sizeof( var ), &(var)
604 
608 #define CL_LOG_TLV_INT8(var) \
609  CL_LOG_TAG_BASIC_SIGNED, sizeof( var ), &(var)
610 
614 #define CL_LOG_TLV_UINT16(var) \
615  CL_LOG_TAG_BASIC_UNSIGNED, sizeof( var ), &(var)
616 
620 #define CL_LOG_TLV_INT16(var) \
621  CL_LOG_TAG_BASIC_SIGNED, sizeof( var ), &(var)
622 
626 #define CL_LOG_TLV_UINT32(var) \
627  CL_LOG_TAG_BASIC_UNSIGNED, sizeof( var ), &(var)
628 
632 #define CL_LOG_TLV_INT32(var) \
633  CL_LOG_TAG_BASIC_SIGNED, sizeof( var ), &(var)
634 
638 #define CL_LOG_TLV_UINT64(var) \
639  CL_LOG_TAG_BASIC_UNSIGNED, sizeof( var ), &(var)
640 
644 #define CL_LOG_TLV_INT64(var) \
645  CL_LOG_TAG_BASIC_SIGNED, sizeof( var ), &(var)
646 
650 #define CL_LOG_TLV_STRING(var) \
651  CL_LOG_TAG_STRING, (strlen( var ) + 1), (var)
652 
653 
708 extern ClRcT
710  CL_IN const ClLogCallbacksT *pLogCallbacks,
711  CL_INOUT ClVersionT *pVersion);
712 
765 
882 extern ClRcT
884  CL_IN ClNameT streamName,
885  CL_IN ClLogStreamScopeT streamScope,
886  CL_IN ClLogStreamAttributesT *pStreamAttr,
887  CL_IN ClLogStreamOpenFlagsT streamOpenFlags,
888  CL_IN ClTimeT timeout,
889  CL_OUT ClLogStreamHandleT *phStream);
943 extern ClRcT
945 
1090 extern ClRcT
1092  ClLogSeverityT severity,
1093  ClUint16T serviceId,
1094  ClUint16T msgId,
1095  ...);
1096 
1097 extern ClRcT
1098 clLogWriteAsyncWithHeader(ClLogStreamHandleT hStream,
1099  ClLogSeverityT severity,
1100  ClUint16T serviceId,
1101  ClUint16T msgId,
1102  ...);
1103 
1104 extern ClRcT
1105 clLogWriteAsyncWithContextHeader(ClLogStreamHandleT hStream,
1106  ClLogSeverityT severity,
1107  const ClCharT *pArea,
1108  const ClCharT *pContext,
1109  ClUint16T serviceId,
1110  ClUint16T msgId,
1111  ...);
1112 
1171 extern ClRcT
1173  CL_IN ClLogFilterFlagsT filterFlags,
1174  CL_IN ClLogFilterT filter);
1175 
1243 extern ClRcT
1245  CL_IN ClNameT streamName,
1246  CL_IN ClLogStreamScopeT streamScope,
1247  CL_IN ClNameT nodeName,
1248  CL_IN ClLogStreamHandlerFlagsT handlerFlags,
1249  CL_OUT ClLogHandleT *phStream);
1302  extern ClRcT
1304 
1361  extern ClRcT
1363  CL_IN ClUint64T sequenceNumber,
1364  CL_IN ClUint32T numRecords);
1365 
1429 extern ClRcT
1431  CL_IN ClCharT *fileName,
1432  CL_IN ClCharT *fileLocation,
1433  CL_IN ClBoolT isDelete,
1434  CL_IN ClLogFileHandleT *phFile);
1435 
1478 extern ClRcT
1480 
1545 extern ClRcT
1547  CL_OUT ClLogStreamAttributesT *pStreamAttr,
1548  CL_OUT ClUint32T *pNumStreams,
1549  CL_OUT ClLogStreamMapT **ppLogStreams);
1550 
1621 extern ClRcT
1623  CL_OUT ClTimeT *pStarTime,
1624  CL_OUT ClTimeT *pEndTime,
1625  CL_OUT ClUint32T *pNumRecords,
1626  CL_OUT ClPtrT *pLogRecords);
1682 extern ClRcT
1684  CL_OUT ClUint32T *pNumStreams,
1685  CL_OUT ClLogStreamInfoT **ppLogStreams);
1686 
1713  #define clLogWrite(streamHdl, severity, libName, ...)\
1714  do\
1715  {\
1716  clLog(severity, libName, CL_LOG_CONTEXT_UNSPECIFIED, __VA_ARGS__);\
1717  } while(0)
1718 
1719 ClRcT
1720 clLogWriteDeferred(ClHandleT handle,
1721  ClLogSeverityT severity,
1722  ClUint16T servicId,
1723  ClUint16T msgId,
1724  ClCharT *pFmtStr,
1725  ...) CL_PRINTF_FORMAT(5, 6);
1726 
1727 ClRcT
1728 clLogWriteDeferredForce(ClHandleT handle,
1729  ClLogSeverityT severity,
1730  ClUint16T servicId,
1731  ClUint16T msgId,
1732  ClCharT *pFmtStr,
1733  ...) CL_PRINTF_FORMAT(5, 6);
1734 
1735 extern ClRcT
1736 clLogMsgWrite(ClHandleT streamHdl,
1737  ClLogSeverityT severity,
1738  ClUint16T serviceId,
1739  const ClCharT *pArea,
1740  const ClCharT *pContext,
1741  const ClCharT *pFileName,
1742  ClUint32T lineNum,
1743  const ClCharT *pFmtStr,
1744  ...) CL_PRINTF_FORMAT(8, 9);
1745 
1746 extern ClRcT
1747 clLogMsgWriteDeferred(ClHandleT streamHdl,
1748  ClLogSeverityT severity,
1749  ClUint16T serviceId,
1750  const ClCharT *pArea,
1751  const ClCharT *pContext,
1752  const ClCharT *pFileName,
1753  ClUint32T lineNum,
1754  const ClCharT *pFmtStr,
1755  ...) CL_PRINTF_FORMAT(8, 9);
1756 
1757 extern ClRcT
1758 clLogMsgWriteConsole(ClHandleT streamHdl,
1759  ClLogSeverityT severity,
1760  ClUint16T serviceId,
1761  const ClCharT *pArea,
1762  const ClCharT *pContext,
1763  const ClCharT *pFileName,
1764  ClUint32T lineNum,
1765  const ClCharT *pFmtStr,
1766  ...) CL_PRINTF_FORMAT(8, 9);
1767 ClUint32T clLogFormatRecordHeader(ClCharT *msgHeader, ClUint32T maxHeaderLen, ClCharT *msg, ClBoolT consoleFlag, ClUint32T msgIdCnt,
1768  ClLogSeverityT severity, const ClCharT *pFileName, ClUint32T lineNum, const ClCharT *pArea, const ClCharT *pContext);
1769 ClUint32T clLogFormatRecord(ClCharT *msgHeader, ClUint32T maxHeaderLen, ClCharT *msg, ClUint32T maxMsgLen, ClBoolT consoleFlag, ClUint32T msgIdCnt,
1770  ClLogSeverityT severity, const ClCharT *pFileName, ClUint32T lineNum,const ClCharT *pArea, const ClCharT *pContext,
1771  const ClCharT *pFmtStr, ...);
1772 ClRcT clLogSeverityFilterToValueGet(ClLogSeverityFilterT filter, ClLogSeverityT* pSeverity);
1773 ClRcT clLogSeverityValueToFilterGet(ClLogSeverityT severity, ClLogSeverityFilterT* pFilter);
1774 
1775 ClRcT clLogStreamFilterSet(ClNameT *pStreamName,
1776  ClLogStreamScopeT streamScope,
1777  ClNameT *pStreamScopeNode,
1778  ClLogFilterFlagsT filterFlags,
1779  ClLogFilterT filter);
1780 
1781 ClRcT
1782 clLogStreamFilterGet(ClNameT *pStreamName,
1783  ClLogStreamScopeT streamScope,
1784  ClNameT *pStreamScopeNode,
1785  ClLogFilterT *pFilter);
1786 
1788 clLogSeverityGet(const ClCharT *pSevName);
1789 
1790 extern ClRcT clLogTimeGet(ClCharT *pStrTime, ClUint32T maxBytes);
1791 extern ClBoolT gClLogCodeLocationEnable;
1792 #define CL_LOG_PRNT_FMT_STR "%-26s [%s:%d] (%.*s.%d : %s.%3s.%3s"
1793 #define CL_LOG_PRNT_FMT_STR_CONSOLE "%-26s [%s:%d] (%.*s.%d : %s.%3s.%3s.%05d : %6s) "
1794 
1795 #define CL_LOG_PRNT_FMT_STR_WO_FILE "%-26s (%.*s.%d : %s.%3s.%3s"
1796 #define CL_LOG_PRNT_FMT_STR_WO_FILE_CONSOLE "%-26s (%.*s.%d : %s.%3s.%3s.%05d : %6s) "
1797 
1798 
1799 #include <ipi/clLogIpiWrap.h>
1800 #ifdef __cplusplus
1801 }
1802 #endif
1803 
1804 #endif /*_CL_LOG_API_H_*/
1805 
Typical defines found in any software project.
Timer APIs.
Header file of Log Service related Macros.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
#define CL_INOUT
CL_INOUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:108
ClInt64T ClTimeT
Time duration specified in nanoseconds.
Definition: clCommon.h:154
#define CL_OUT
CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:110
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
ClRcT clLogFileClose(CL_IN ClLogFileHandleT hFileHdlr)
Close the file which was opened for reading.
ClRcT clLogHandlerRecordAck(CL_IN ClLogStreamHandleT hStream, CL_IN ClUint64T sequenceNumber, CL_IN ClUint32T numRecords)
Function to acknowledge, receipt of Log Records, to the sender of the Log Records.
ClUint16T ClLogSeverityFilterT
Variables of this type is used as a bitmap.
Definition: clLogApi.h:352
void(* ClLogRecordDeliveryCallbackT)(CL_IN ClLogStreamHandleT hStream, CL_IN ClUint64T seqNum, CL_IN ClUint32T numRecords, CL_IN ClPtrT pRecords)
Callback function to receive log records of Log streams of interest.
Definition: clLogApi.h:532
ClUint8T ClLogStreamHandlerFlagsT
While registering as strean handler, the process should specify this flag.
Definition: clLogApi.h:249
ClRcT clLogFinalize(CL_IN ClLogHandleT hLog)
Finalize the Log service for the calling process and ensures to release all the resources.
void(* ClLogFilterSetCallbackT)(CL_IN ClLogStreamHandleT hStream, CL_IN ClLogFilterT filter)
Informs the logger about a change in filter settings of a Log stream opened by this logger.
Definition: clLogApi.h:489
ClRcT clLogHandlerRegister(CL_IN ClLogHandleT hLog, CL_IN ClNameT streamName, CL_IN ClLogStreamScopeT streamScope, CL_IN ClNameT nodeName, CL_IN ClLogStreamHandlerFlagsT handlerFlags, CL_OUT ClLogHandleT *phStream)
Registers the calling process as handler for the specified stream.
ClRcT clLogFilterSet(CL_IN ClLogStreamHandleT hStream, CL_IN ClLogFilterFlagsT filterFlags, CL_IN ClLogFilterT filter)
Changes the filter settings of a Log Stream.
ClRcT clLogFileRecordsGet(CL_IN ClLogFileHandleT hFileHdlr, CL_OUT ClTimeT *pStarTime, CL_OUT ClTimeT *pEndTime, CL_OUT ClUint32T *pNumRecords, CL_OUT ClPtrT *pLogRecords)
Gets the records from the file.
ClLogSeverityT
Definition: clLogApi.h:252
ClHandleT ClLogHandleT
The type of handle supplied by Log Service during initialization.
Definition: clLogApi.h:57
ClUint8T ClLogStreamOpenFlagsT
This flags to specify the stream should be created or opened.
Definition: clLogApi.h:186
ClLogStreamScopeT
This enumeration is used to specify the scope of the stream.
Definition: clLogApi.h:87
ClUint8T ClLogFilterFlagsT
It takes the values of above specifed flags.
Definition: clLogApi.h:372
void(* ClLogStreamOpenCallbackT)(CL_IN ClInvocationT invocation, CL_IN ClLogStreamHandleT hStream, CL_IN ClRcT rc)
This function gets called When clLogStreamOpenAsync() call returns on the server.
Definition: clLogApi.h:455
ClRcT clLogHandlerDeregister(CL_IN ClLogStreamHandleT hStream)
Deregisters the calling process as handler for the specified stream.
ClRcT clLogStreamListGet(CL_IN ClLogHandleT hLog, CL_OUT ClUint32T *pNumStreams, CL_OUT ClLogStreamInfoT **ppLogStreams)
Gets the list of active streams available in the cluster.
ClRcT clLogFileMetaDataGet(CL_IN ClLogFileHandleT hFileHdlr, CL_OUT ClLogStreamAttributesT *pStreamAttr, CL_OUT ClUint32T *pNumStreams, CL_OUT ClLogStreamMapT **ppLogStreams)
Gets the metadata of the file.
ClRcT clLogStreamOpen(CL_IN ClLogHandleT hLog, CL_IN ClNameT streamName, CL_IN ClLogStreamScopeT streamScope, CL_IN ClLogStreamAttributesT *pStreamAttr, CL_IN ClLogStreamOpenFlagsT streamOpenFlags, CL_IN ClTimeT timeout, CL_OUT ClLogStreamHandleT *phStream)
Opens the stream for Logging.
ClRcT clLogInitialize(CL_OUT ClLogHandleT *phLog, CL_IN const ClLogCallbacksT *pLogCallbacks, CL_INOUT ClVersionT *pVersion)
Initializes the Log service for the calling process and ensures the version compatability.
ClHandleT ClLogFileHandleT
The type of handle supplied by Log Service to a process who has opened a file for consuming log recor...
Definition: clLogApi.h:69
ClHandleT ClLogStreamHandleT
The type of handle supplied by Log Service during log streamOpen and a process register itself as str...
Definition: clLogApi.h:63
ClRcT clLogStreamClose(CL_IN ClLogStreamHandleT hStream)
Close the stream opened for logging.
ClRcT clLogWriteAsync(ClLogStreamHandleT hStream, ClLogSeverityT severity, ClUint16T serviceId, ClUint16T msgId,...)
Logs a Log Record in the specified Log Stream.
ClLogFileFullActionT
This enumeration is used to specify the behavior of Log Service once the Log File into which this Log...
Definition: clLogApi.h:103
ClRcT clLogFileOpen(CL_IN ClLogHandleT hLog, CL_IN ClCharT *fileName, CL_IN ClCharT *fileLocation, CL_IN ClBoolT isDelete, CL_IN ClLogFileHandleT *phFile)
Opens the current logical log file for reading the log records.
@ CL_LOG_SEV_NOTICE
setting severity as NOTICE.
Definition: clLogApi.h:276
@ CL_LOG_SEV_DEBUG
setting severity as DEBUG.
Definition: clLogApi.h:284
@ CL_LOG_SEV_EMERGENCY
setting severity as EMERGENCY.
Definition: clLogApi.h:256
@ CL_LOG_SEV_CRITICAL
setting severity as CRITICAL.
Definition: clLogApi.h:264
@ CL_LOG_SEV_WARNING
setting severity as WARNING.
Definition: clLogApi.h:272
@ CL_LOG_SEV_ALERT
setting severity as ALERT.
Definition: clLogApi.h:260
@ CL_LOG_SEV_MAX
Maximum severity level.
Definition: clLogApi.h:301
@ CL_LOG_SEV_INFO
setting severity as INFORMATION.
Definition: clLogApi.h:280
@ CL_LOG_SEV_ERROR
setting severity as ERROR.
Definition: clLogApi.h:268
@ CL_LOG_SEV_TRACE
setting severity as DEBUG.
Definition: clLogApi.h:293
@ CL_LOG_STREAM_GLOBAL
Flags specifies the streams global to the node.
Definition: clLogApi.h:91
@ CL_LOG_STREAM_LOCAL
Flag specifies the streams local to the node.
Definition: clLogApi.h:95
@ CL_LOG_FILE_FULL_ACTION_WRAP
It makes the Log Service treat the Log File as a circular buffer, i.e., when the Log File becomes ful...
Definition: clLogApi.h:116
@ CL_LOG_FILE_FULL_ACTION_ROTATE
It directs the Log Service to create a new Log File Unit when the current Log File Unit becomes full.
Definition: clLogApi.h:111
@ CL_LOG_FILE_FULL_ACTION_HALT
Log Service stops putting more records in the Log File once it becomes full.
Definition: clLogApi.h:120
A name.
Definition: clCommon.h:197
Version Information for various services.
Definition: clCommon.h:250
This structure describes the attributes of the stream.
Definition: clLogApi.h:127
ClUint32T flushFreq
Num of log records after which the log stream records must be flushed.
Definition: clLogApi.h:160
ClTimeT flushInterval
Time after which the log stream records must be flushed.
Definition: clLogApi.h:164
ClBoolT haProperty
Log file replication property.
Definition: clLogApi.h:147
ClUint32T fileUnitSize
Size of the file unit.
Definition: clLogApi.h:139
ClLogFileFullActionT fileFullAction
Action that log service has to take, when the log file unit becomes full.
Definition: clLogApi.h:151
ClUint32T recordSize
Size of the log record.
Definition: clLogApi.h:143
ClCharT * fileLocation
Its the path where the log file unit(s) will be created.
Definition: clLogApi.h:135
ClWaterMarkT waterMark
The water mark for file units.When the size of file reaches this level, the water mark event will be ...
Definition: clLogApi.h:169
ClCharT * fileName
Its the prefix name of file units that are going to be created.
Definition: clLogApi.h:131
ClUint32T maxFilesRotated
If fileAction is CL_LOG_FILE_FULL_ACTION_ROTATE, the maximum num of log file units that will be creat...
Definition: clLogApi.h:156
This structure describes all the information about the log stream.
Definition: clLogApi.h:192
ClNameT streamScopeNode
The name of the node on which the stream exist.
Definition: clLogApi.h:204
ClLogStreamAttributesT streamAttr
Attributes of the log stream.
Definition: clLogApi.h:212
ClLogStreamScopeT streamScope
Scope of the log stream.
Definition: clLogApi.h:200
ClNameT streamName
Name of the log stream.
Definition: clLogApi.h:196
ClUint16T streamId
The unique id for the stream in the cluster.
Definition: clLogApi.h:208
This structure describes the information about the log stream to stream Id mapping.
Definition: clLogApi.h:220
ClNameT streamName
Name of the log stream.
Definition: clLogApi.h:224
ClLogStreamScopeT streamScope
Scope of the log stream.
Definition: clLogApi.h:228
ClNameT nodeName
Node name on which the stream exist.
Definition: clLogApi.h:232
ClUint16T streamId
Unique id of the stream in the cluster.
Definition: clLogApi.h:236
This structure describes the filter settings for the stream.
Definition: clLogApi.h:379
ClUint8T * pMsgIdSet
This memory will be treated as bitmap to mask the message ids.
Definition: clLogApi.h:391
ClUint16T compIdSetLength
The size of the memory pointed by pCompIdSet in bytes.
Definition: clLogApi.h:395
ClLogSeverityFilterT severityFilter
This field identifies the severity level.
Definition: clLogApi.h:383
ClUint16T msgIdSetLength
The size of the memory pointed by pMsgIdSet in bytes.
Definition: clLogApi.h:387
ClUint8T * pCompIdSet
This memory will be treated as bitmap to mask the component ids.
Definition: clLogApi.h:399
This structure describes about the callbacks which can be provided by process while initializing with...
Definition: clLogApi.h:543
ClLogFilterSetCallbackT clLogFilterSetCb
Callback for informing filter settings updation.
Definition: clLogApi.h:551
ClLogRecordDeliveryCallbackT clLogRecordDeliveryCb
Callback for delivering records to stream handlers.
Definition: clLogApi.h:555
ClLogStreamOpenCallbackT clLogStreamOpenCb
Callback for stream open.
Definition: clLogApi.h:547

Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen