Log.idl
/* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright 2014 Raritan Inc. All rights reserved.
*/
#ifndef __LOG_IDL__
#define __LOG_IDL__
/** Device Logging */
module logging {
/** General log info */
structure LogInfo {
long creationTime; ///< Creation time of log; changed by clear()
int idFirst; ///< Serial number of first entry of the log
int idNext; ///< Next unused serial number of the log
};
/** A log entry */
structure LogEntry {
int id; ///< Serial number
time timestamp; ///< Time stamp
string eventClass; ///< Category (aka event class)
string message; ///< Message
};
/** A log chunk */
structure LogChunk {
long logCreationTime; ///< Creation time of log at chunk generation
int idFirst; ///< Serial number of first entry in the chunk
int allEntryCnt; ///< Number of all entries in the chunk
vector<LogEntry> selEntries; ///< Selected entries of the chunk
};
/** Range direction when fetching log entries */
enumeration RangeDirection {
FORWARD, ///< Ascending serial numbers
BACKWARD ///< Descending serial numbers
};
}
#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