public interface LogMessage
String.format(String, Object...)
-Method should used to display the text.
But the values may be also important for evaluating the message in the destination.
The meaning of the values depends on the kind of message, identified by the number.
java.util.Date
Object.
In a realtime system, compiled with C-Language, the struct Date may have a microsecond resolution
and another base year, but it should be absolute.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
sVersion
Version, history and license.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
A call of this method closes the devices, which processed the message.
|
void |
flush()
A call of this method causes an activating of transmission of all messages since last flush.
|
boolean |
isOnline()
Checks whether the message output is available.
|
boolean |
sendMsg(int identNumber,
java.lang.String text,
java.lang.Object... args)
Sends a message.
|
boolean |
sendMsgTime(int identNumber,
OS_TimeStamp creationTime,
java.lang.String text,
java.lang.Object... args)
Sends a message.
|
boolean |
sendMsgVaList(int identNumber,
OS_TimeStamp creationTime,
java.lang.String text,
Va_list args)
Sends a message.
|
static final java.lang.String sVersion
sendMsg(int, String, Object...)
described.
It was not defined and maybe not used in the last 8 years.
boolean sendMsg(int identNumber, java.lang.String text, java.lang.Object... args)
#sendMsg(int, OS_TimeStamp, String, Object...)
.identNumber
- of the message. If it is negative, it is the same message as positive number,
but with information 'going state', where the positive number is 'coming state'.text
- The text representation of the message, format string, see java.lang.String.format(..).args
- 0, 1 or more arguments of any type.
The interpretation of the arguments is controlled by param text.boolean sendMsgTime(int identNumber, OS_TimeStamp creationTime, java.lang.String text, java.lang.Object... args)
identNumber
- of the message. If it is negative, it is the same message as positive number,
but with information 'going state', where the positive number is 'coming state'.creationTime
- absolute time stamp. @Java2C=perValue.text
- The text representation of the message, format string, see java.lang.String.format(..).args
- 0, 1 or more arguments of any type.
The interpretation of the arguments is controlled by param text.boolean sendMsgVaList(int identNumber, OS_TimeStamp creationTime, java.lang.String text, Va_list args)
#sendMsg(int, OS_TimeStamp, String, Object...)
, but the parameter args is varied:identNumber
- creationTime
- text
- The text of the message: Hint for Java2C: This is a StringJc, not a simple char const*.
That is necessary because the String may be replaced.typeArgs
- Type chars, ZCBSIJFD for boolean, char, byte, short, int, long, float double.args
- Reference to a buffer which contains the values for a variable argument list.
vprintf(buffer, text, args)
.
The referenced instance shouldn't accepted as persistent outside processing time
of the called routine. Therefore stack content is able to provide.
void close()
close
mean.
If the device is a log file writer it should be clearly.
close
may mean, the processing of messages is finite temporary.
An open
occurs automatically, if a new message is dispatched.void flush()
flush
mean.
If the device is a log file writer it should be clearly.
flush
may mean, the processing of messages is ready to transmit yet.boolean isOnline()