Ice 3.6 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 //
3 // Copyright (c) 2003-2018 ZeroC, Inc. All rights reserved.
4 //
5 // This copy of Ice is licensed to you under the terms described in the
6 // ICE_LICENSE file included in this distribution.
7 //
8 // **********************************************************************
9 
10 #pragma once
11 
12 #include <Ice/BuiltinSequences.ice>
13 
14 [["cpp:header-ext:h", "objc:header-dir:objc", "js:ice-build"]]
15 [["cpp:include:list"]]
16 
17 ["objc:prefix:ICE"]
18 module Ice
19 {
20 
27 {
34 
41 
48 
55 };
56 
57 
63 sequence<LogMessageType> LogMessageTypeSeq;
64 
65 
71 struct LogMessage
72 {
79 
86  long timestamp;
87 
94  string traceCategory;
95 
101  string message;
102 };
103 
104 
110 ["cpp:type:std::list<LogMessage>"]
111 sequence<LogMessage> LogMessageSeq;
112 
113 
121 interface RemoteLogger
122 {
132  void init(string prefix, LogMessageSeq logMessages);
133 
141  void log(LogMessage message);
142 };
143 
144 
151 {
152 };
153 
160 interface LoggerAdmin
161 {
183  void attachRemoteLogger(RemoteLogger* prx, LogMessageTypeSeq messageTypes, StringSeq traceCategories,
184  int messageMax)
186 
196  bool detachRemoteLogger(RemoteLogger* prx);
197 
217  LogMessageSeq getLog(LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax, out string prefix);
218 };
219 
220 };
221 
The Ice core library.
Definition: BuiltinSequences.ice:15
long timestamp
The date and time when the Logger received this message, expressed as the number of microseconds sinc...
Definition: RemoteLogger.ice:86
The Logger received an error message.
Definition: RemoteLogger.ice:54
The Ice remote logger interface.
Definition: RemoteLogger.ice:121
sequence< LogMessageType > LogMessageTypeSeq
A sequence of LogMessageType.
Definition: RemoteLogger.ice:63
LogMessageType
An enumeration representing the different types of log messages.
Definition: RemoteLogger.ice:26
The interface of the admin object that allows an Ice application the attach its RemoteLogger to the L...
Definition: RemoteLogger.ice:160
A complete log message.
Definition: RemoteLogger.ice:71
The Logger received a print message.
Definition: RemoteLogger.ice:33
The Logger received a warning message.
Definition: RemoteLogger.ice:47
LogMessageType type
The type of message sent to the Logger.
Definition: RemoteLogger.ice:78
The Logger received a trace message.
Definition: RemoteLogger.ice:40
sequence< string > StringSeq
A sequence of strings.
Definition: BuiltinSequences.ice:40
string message
The log message itself.
Definition: RemoteLogger.ice:101
Thrown when the provided RemoteLogger was previously attached to a LoggerAdmin.
Definition: RemoteLogger.ice:150
sequence< LogMessage > LogMessageSeq
A sequence of LogMessage.
Definition: RemoteLogger.ice:111
string traceCategory
For a message of type trace, the trace category of this log message; otherwise, the empty string...
Definition: RemoteLogger.ice:94