Ice 3.7 Slice API Reference
All Classes Interfaces Structs Exceptions Modules Files Operations Constants Sequences Dictionaries Enumerations Enumerator Pages
Operations | List of all members
Ice::LoggerAdmin Interface Reference

The interface of the admin object that allows an Ice application the attach its RemoteLogger to the Logger of this admin object's Ice communicator. More...

defined in <Ice/RemoteLogger.ice>

interface LoggerAdmin { ... }

Operations

void attachRemoteLogger (RemoteLogger *prx, LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax) throws RemoteLoggerAlreadyAttachedException
 Attaches a RemoteLogger object to the local logger. More...
 
bool detachRemoteLogger (RemoteLogger *prx)
 Detaches a RemoteLogger object from the local logger. More...
 
LogMessageSeq getLog (LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax, out string prefix)
 Retrieves log messages recently logged. More...
 

Detailed Description

The interface of the admin object that allows an Ice application the attach its RemoteLogger to the Logger of this admin object's Ice communicator.

Operation Documentation

◆ attachRemoteLogger()

void attachRemoteLogger ( RemoteLogger prx,
LogMessageTypeSeq  messageTypes,
StringSeq  traceCategories,
int  messageMax 
) throws RemoteLoggerAlreadyAttachedException

Attaches a RemoteLogger object to the local logger.

attachRemoteLogger calls init on the provided RemoteLogger proxy.

Parameters
prxA proxy to the remote logger.
messageTypesThe list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types).
traceCategoriesThe categories of traces that the remote logger wishes to receive. This parameter is ignored if messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace categories).
messageMaxThe maximum number of log messages (of all types) to be provided to init. A negative value requests all messages available.
Exceptions
RemoteLoggerAlreadyAttachedExceptionRaised if this remote logger is already attached to this admin object.

◆ detachRemoteLogger()

bool detachRemoteLogger ( RemoteLogger prx)

Detaches a RemoteLogger object from the local logger.

Parameters
prxA proxy to the remote logger.
Returns
True if the provided remote logger proxy was detached, and false otherwise.

◆ getLog()

LogMessageSeq getLog ( LogMessageTypeSeq  messageTypes,
StringSeq  traceCategories,
int  messageMax,
out string  prefix 
)

Retrieves log messages recently logged.

Parameters
messageTypesThe list of message types that the caller wishes to receive. An empty list means no filtering (send all message types).
traceCategoriesThe categories of traces that caller wish to receive. This parameter is ignored if messageTypes is not empty and does not include trace. An empty list means no filtering (send all trace categories).
messageMaxThe maximum number of log messages (of all types) to be returned. A negative value requests all messages available.
prefixThe prefix of the associated local logger.
Returns
The Log messages.

The documentation for this interface was generated from the following file: