Ice 3.7 Slice API Reference
All Classes Interfaces Structs Exceptions Modules Files Operations Constants Sequences Dictionaries Enumerations Enumerator Pages
RemoteLogger.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
8 
9 [["cpp:dll-export:ICE_API"]]
10 [["cpp:doxygen:include:Ice/Ice.h"]]
11 [["cpp:header-ext:h"]]
12 [["cpp:include:list"]]
13 
14 [["ice-prefix"]]
15 
16 [["js:module:ice"]]
17 [["js:cjs-module"]]
18 
19 [["objc:dll-export:ICE_API"]]
20 [["objc:header-dir:objc"]]
21 
22 [["python:pkgdir:Ice"]]
23 
24 #ifndef __SLICE2JAVA_COMPAT__
25 [["java:package:com.zeroc"]]
26 #endif
27 
28 ["objc:prefix:ICE"]
29 module Ice
30 {
31 
38 {
45 
52 
59 
66 }
67 
73 sequence<LogMessageType> LogMessageTypeSeq;
74 
80 struct LogMessage
81 {
88 
95  long timestamp;
96 
104 
110  string message;
111 }
112 
118 ["cpp:type:std::list<LogMessage>"]
119 sequence<LogMessage> LogMessageSeq;
120 
128 interface RemoteLogger
129 {
139  void init(string prefix, LogMessageSeq logMessages);
140 
148  void log(LogMessage message);
149 }
150 
157 {
158 }
159 
166 interface LoggerAdmin
167 {
189  void attachRemoteLogger(RemoteLogger* prx, LogMessageTypeSeq messageTypes, StringSeq traceCategories,
190  int messageMax)
192 
203 
223  LogMessageSeq getLog(LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax, out string prefix);
224 }
225 
226 }
Ice::LogMessageTypeSeq
sequence< LogMessageType > LogMessageTypeSeq
A sequence of LogMessageType.
Definition: RemoteLogger.ice:73
Ice::RemoteLogger::init
void init(string prefix, LogMessageSeq logMessages)
init is called by attachRemoteLogger when a RemoteLogger proxy is attached.
BuiltinSequences.ice
Ice::StringSeq
sequence< string > StringSeq
A sequence of strings.
Definition: BuiltinSequences.ice:51
Ice::LogMessageSeq
sequence< LogMessage > LogMessageSeq
A sequence of LogMessage.
Definition: RemoteLogger.ice:119
Ice::ErrorMessage
@ ErrorMessage
The Logger received an error message.
Definition: RemoteLogger.ice:65
Ice::LoggerAdmin::getLog
LogMessageSeq getLog(LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax, out string prefix)
Retrieves log messages recently logged.
Ice::LoggerAdmin
The interface of the admin object that allows an Ice application the attach its RemoteLogger to the L...
Definition: RemoteLogger.ice:167
Ice::LogMessage::timestamp
long timestamp
The date and time when the Logger received this message, expressed as the number of microseconds sinc...
Definition: RemoteLogger.ice:95
Ice::LogMessage::message
string message
The log message itself.
Definition: RemoteLogger.ice:110
Ice::LoggerAdmin::attachRemoteLogger
void attachRemoteLogger(RemoteLogger *prx, LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax)
Attaches a RemoteLogger object to the local logger.
Ice::RemoteLogger::log
void log(LogMessage message)
Log a LogMessage.
Ice::TraceMessage
@ TraceMessage
The Logger received a trace message.
Definition: RemoteLogger.ice:51
Ice::RemoteLogger
The Ice remote logger interface.
Definition: RemoteLogger.ice:129
Ice
The Ice core library.
Definition: BuiltinSequences.ice:27
Ice::PrintMessage
@ PrintMessage
The Logger received a print message.
Definition: RemoteLogger.ice:44
Ice::LogMessage::traceCategory
string traceCategory
For a message of type trace, the trace category of this log message; otherwise, the empty string.
Definition: RemoteLogger.ice:103
Ice::LogMessage
A complete log message.
Definition: RemoteLogger.ice:81
Ice::WarningMessage
@ WarningMessage
The Logger received a warning message.
Definition: RemoteLogger.ice:58
Ice::RemoteLoggerAlreadyAttachedException
Thrown when the provided RemoteLogger was previously attached to a LoggerAdmin.
Definition: RemoteLogger.ice:157
Ice::LoggerAdmin::detachRemoteLogger
bool detachRemoteLogger(RemoteLogger *prx)
Detaches a RemoteLogger object from the local logger.
Ice::LogMessageType
LogMessageType
An enumeration representing the different types of log messages.
Definition: RemoteLogger.ice:38
Ice::LogMessage::type
LogMessageType type
The type of message sent to the Logger.
Definition: RemoteLogger.ice:87