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>

Inheritance diagram for Ice::LoggerAdmin:

[legend]

Collaboration diagram for Ice::LoggerAdmin:

[legend]

Public Types
typedef LoggerAdminPtr	PointerType
typedef LoggerAdminPrx	ProxyType

Public Member Functions
virtual void	attachRemoteLogger (const RemoteLoggerPrx &prx, const LogMessageTypeSeq &messageTypes, const StringSeq &traceCategories, Int messageMax, const Current &current=emptyCurrent)=0
	Attaches a RemoteLogger object to the local logger.
virtual bool	detachRemoteLogger (const RemoteLoggerPrx &prx, const Current &current=emptyCurrent)=0
	Detaches a RemoteLogger object from the local logger.
virtual LogMessageSeq	getLog (const LogMessageTypeSeq &messageTypes, const StringSeq &traceCategories, Int messageMax, ::std::string &prefix, const Current &current=emptyCurrent)=0
	Retrieves log messages recently logged.
virtual const ::std::string &	ice_id (const Current &current=emptyCurrent) const
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string >	ice_ids (const Current &current=emptyCurrent) const
	Obtains a list of the Slice type IDs representing the interfaces supported by this object.
virtual bool	ice_isA (const ::std::string &id, const Current &current=emptyCurrent) const
	Determines whether this object supports an interface with the given Slice type ID.
virtual	~LoggerAdmin ()
Public Member Functions inherited from Ice::Object
virtual ObjectPtr	ice_clone () const
	Returns a shallow copy of the object.
virtual void	ice_collectable (bool b)
	Determines whether this object, and by extension the graph of all objects reachable from this object, are eligible for garbage collection when all external references to the graph have been released.
virtual bool	ice_dispatch (Ice::Request &request, const DispatchInterceptorAsyncCallbackPtr &cb=0)
	Dispatches an invocation to a servant.
virtual SlicedDataPtr	ice_getSlicedData () const
	Obtains the sliced data associated with this instance.
virtual bool	ice_isA (const std::string &s, const Current &current=Ice::emptyCurrent) const
	Tests whether this object supports a specific Slice interface.
virtual Int	ice_operationAttributes (const std::string &operation) const
	Returns the Freeze metadata attributes for an operation.
virtual void	ice_ping (const Current &current=Ice::emptyCurrent) const
	Tests whether this object can be reached.
virtual void	ice_postUnmarshal ()
	The Ice run time invokes this method vafter unmarshaling an object's data members.
virtual void	ice_preMarshal ()
	The Ice run time invokes this method prior to marshaling an object's data members.
virtual bool	operator< (const Object &) const
virtual bool	operator== (const Object &) const
Public Member Functions inherited from IceUtil::Shared
void	__clearFlag (unsigned char flag)
virtual void	__decRef ()
virtual int	__getRef () const
bool	__hasFlag (unsigned char flag)
virtual void	__incRef ()
void	__setFlag (unsigned char flag)
virtual void	__setNoDelete (bool)
Shared &	operator= (const Shared &)
	Shared ()
	Shared (const Shared &)
virtual	~Shared ()

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID corresponding to this class.
Static Public Member Functions inherited from Ice::Object
static const std::string &	ice_staticId ()
	Obtains the Slice type ID of this type.

Additional Inherited Members
Static Public Attributes inherited from IceUtil::Shared
static const unsigned char	NoDelete
Protected Member Functions inherited from Ice::Object
	Object ()
virtual	~Object ()
Protected Attributes inherited from IceUtil::Shared
unsigned char	_flags
IceUtilInternal::Atomic	_ref

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.

Member Typedef Documentation

◆ PointerType

typedef LoggerAdminPtr Ice::LoggerAdmin::PointerType

◆ ProxyType

typedef LoggerAdminPrx Ice::LoggerAdmin::ProxyType

Constructor & Destructor Documentation

◆ ~LoggerAdmin()

virtual Ice::LoggerAdmin::~LoggerAdmin ( )

virtual

Member Function Documentation

◆ attachRemoteLogger()

virtual void Ice::LoggerAdmin::attachRemoteLogger	(	const RemoteLoggerPrx &	prx,
		const LogMessageTypeSeq &	messageTypes,
		const StringSeq &	traceCategories,
		Int	messageMax,
		const Current &	current = emptyCurrent )

pure virtual

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

Ice::RemoteLoggerAlreadyAttachedException Raised if this remote logger is already attached to this admin object.

◆ detachRemoteLogger()

virtual bool Ice::LoggerAdmin::detachRemoteLogger	(	const RemoteLoggerPrx &	prx,
		const Current &	current = emptyCurrent )

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()

virtual LogMessageSeq Ice::LoggerAdmin::getLog	(	const LogMessageTypeSeq &	messageTypes,
		const StringSeq &	traceCategories,
		Int	messageMax,
		::std::string &	prefix,
		const Current &	current = emptyCurrent )

pure virtual

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 const ::std::string & Ice::LoggerAdmin::ice_id ( const Current & current = emptyCurrent ) const

virtual

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 = emptyCurrent ) const

virtual

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	(	const ::std::string &	id,
		const Current &	current = emptyCurrent ) const

virtual

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()

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:

generated/cpp98/x64/Release/Ice/RemoteLogger.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~LoggerAdmin()

Member Function Documentation

◆ attachRemoteLogger()

◆ detachRemoteLogger()

◆ getLog()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()