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...
#include <Ice/Ice.h>
|
virtual void | attachRemoteLogger (::std::shared_ptr< RemoteLoggerPrx > prx, LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax, const Current ¤t)=0 |
| Attaches a RemoteLogger object to the local logger. More...
|
|
virtual bool | detachRemoteLogger (::std::shared_ptr< RemoteLoggerPrx > prx, const Current ¤t)=0 |
| Detaches a RemoteLogger object from the local logger. More...
|
|
virtual LogMessageSeq | getLog (LogMessageTypeSeq messageTypes, StringSeq traceCategories, int messageMax, ::std::string &prefix, const Current ¤t)=0 |
| Retrieves log messages recently logged. More...
|
|
virtual ::std::string | ice_id (const Current ¤t) const override |
| Obtains a Slice type ID representing the most-derived interface supported by this object. More...
|
|
virtual ::std::vector<::std::string > | ice_ids (const Current ¤t) const override |
| Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...
|
|
virtual bool | ice_isA (::std::string id, const Current ¤t) const override |
| Determines whether this object supports an interface with the given Slice type ID. More...
|
|
virtual bool | ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr) |
| Dispatches an invocation to a servant. More...
|
|
virtual bool | ice_isA (std::string s, const Current ¤t) const |
| Tests whether this object supports a specific Slice interface. More...
|
|
virtual void | ice_ping (const Current ¤t) const |
| Tests whether this object can be reached. More...
|
|
virtual | ~Object ()=default |
|
|
static const ::std::string & | ice_staticId () |
| Obtains the Slice type ID corresponding to this class. More...
|
|
static const std::string & | ice_staticId () |
| Obtains the Slice type ID of this type. More...
|
|
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.
◆ ProxyType
◆ attachRemoteLogger()
Attaches a RemoteLogger object to the local logger.
attachRemoteLogger calls init on the provided RemoteLogger proxy.
- Parameters
-
prx | A proxy to the remote logger. |
messageTypes | The list of message types that the remote logger wishes to receive. An empty list means no filtering (send all message types). |
traceCategories | The 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). |
messageMax | The maximum number of log messages (of all types) to be provided to init. A negative value requests all messages available. |
current | The Current object for the invocation. |
- Exceptions
-
◆ detachRemoteLogger()
virtual bool Ice::LoggerAdmin::detachRemoteLogger |
( |
::std::shared_ptr< RemoteLoggerPrx > |
prx, |
|
|
const Current & |
current |
|
) |
| |
|
pure virtual |
Detaches a RemoteLogger object from the local logger.
- Parameters
-
prx | A proxy to the remote logger. |
current | The Current object for the invocation. |
- Returns
- True if the provided remote logger proxy was detached, and false otherwise.
◆ getLog()
Retrieves log messages recently logged.
- Parameters
-
messageTypes | The list of message types that the caller wishes to receive. An empty list means no filtering (send all message types). |
traceCategories | The 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). |
messageMax | The maximum number of log messages (of all types) to be returned. A negative value requests all messages available. |
prefix | The prefix of the associated local logger. |
current | The Current object for the invocation. |
- Returns
- The Log messages.
◆ ice_id()
virtual ::std::string Ice::LoggerAdmin::ice_id |
( |
const Current & |
current | ) |
const |
|
overridevirtual |
Obtains a Slice type ID representing the most-derived interface supported by this object.
- Parameters
-
current | The Current object for the invocation. |
- Returns
- A fully-scoped type ID.
Reimplemented from Ice::Object.
◆ ice_ids()
virtual ::std::vector<::std::string> Ice::LoggerAdmin::ice_ids |
( |
const Current & |
current | ) |
const |
|
overridevirtual |
Obtains a list of the Slice type IDs representing the interfaces supported by this object.
- Parameters
-
current | The Current object for the invocation. |
- Returns
- A list of fully-scoped type IDs.
Reimplemented from Ice::Object.
◆ ice_isA()
virtual bool Ice::LoggerAdmin::ice_isA |
( |
::std::string |
id, |
|
|
const Current & |
current |
|
) |
| const |
|
overridevirtual |
Determines whether this object supports an interface with the given Slice type ID.
- Parameters
-
id | The fully-scoped Slice type ID. |
current | The Current object for the invocation. |
- Returns
- True if this object supports the interface, false, otherwise.
◆ ice_staticId()
static const ::std::string& Ice::LoggerAdmin::ice_staticId |
( |
| ) |
|
|
static |
Obtains the Slice type ID corresponding to this class.
- Returns
- A fully-scoped type ID.
The documentation for this class was generated from the following file: