Raritan PX2/PX3 JSON-RPC API: pdu-json-rpc-api/idl/Log.idl Source File

Raritan PX2/PX3 JSON-RPC API

Log.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright 2014 Raritan Inc. All rights reserved.
4 */
5
6 #ifndef __LOG_IDL__
7 #define __LOG_IDL__
8
9 /** Device Logging */
10 module logging {
11
12 /** General log info */
13 structure LogInfo {
14 long creationTime; ///< Creation time of log; changed by clear()
15 int idFirst; ///< Serial number of first entry of the log
16 int idNext; ///< Next unused serial number of the log
17 };
18
19 /** A log entry */
20 structure LogEntry {
21 int id; ///< Serial number
22 time timestamp; ///< Time stamp
23 string eventClass; ///< Category (aka event class)
24 string message; ///< Message
25 };
26
27 /** A log chunk */
28 structure LogChunk {
29 long logCreationTime; ///< Creation time of log at chunk generation
30 int idFirst; ///< Serial number of first entry in the chunk
31 int allEntryCnt; ///< Number of all entries in the chunk
32 vector<LogEntry> selEntries; ///< Selected entries of the chunk
33 };
34
35 /** Range direction when fetching log entries */
36 enumeration RangeDirection {
37 FORWARD, ///< Ascending serial numbers
38 BACKWARD ///< Descending serial numbers
39 };
40
41 }
42
43 #endif /* __LOG_IDL__ */
logging::LogEntry::timestamp
time timestamp
Time stamp.
Definition: Log.idl:22
logging::LogEntry::message
string message
Message.
Definition: Log.idl:24
logging
Device Logging.
Definition: DebugLog.idl:14
logging::LogChunk
A log chunk.
Definition: Log.idl:28
logging::LogInfo::idNext
int idNext
Next unused serial number of the log.
Definition: Log.idl:16
logging::LogChunk::idFirst
int idFirst
Serial number of first entry in the chunk.
Definition: Log.idl:30
logging::LogChunk::selEntries
vector< LogEntry > selEntries
Selected entries of the chunk.
Definition: Log.idl:32
logging::LogInfo::idFirst
int idFirst
Serial number of first entry of the log.
Definition: Log.idl:15
logging::LogInfo::creationTime
long creationTime
Creation time of log; changed by clear()
Definition: Log.idl:14
logging::LogEntry::id
int id
Serial number.
Definition: Log.idl:21
logging::RangeDirection
RangeDirection
Range direction when fetching log entries.
Definition: Log.idl:36
logging::LogInfo
General log info.
Definition: Log.idl:13
logging::LogChunk::allEntryCnt
int allEntryCnt
Number of all entries in the chunk.
Definition: Log.idl:31
logging::FORWARD
Ascending serial numbers.
Definition: Log.idl:37
logging::LogChunk::logCreationTime
long logCreationTime
Creation time of log at chunk generation.
Definition: Log.idl:29
logging::LogEntry
A log entry.
Definition: Log.idl:20
logging::BACKWARD
Descending serial numbers.
Definition: Log.idl:38
logging::LogEntry::eventClass
string eventClass
Category (aka event class)
Definition: Log.idl:23