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::LoggerAdminPrx:

[legend]

Collaboration diagram for Ice::LoggerAdminPrx:

[legend]

Public Member Functions
void	attachRemoteLogger (const ::std::shared_ptr< RemoteLoggerPrx > &prx, const LogMessageTypeSeq &messageTypes, const StringSeq &traceCategories, int messageMax, const Context &context=noExplicitContext)
	Attaches a RemoteLogger object to the local logger.
::std::function< void()>	attachRemoteLoggerAsync (const ::std::shared_ptr< RemoteLoggerPrx > &prx, const LogMessageTypeSeq &messageTypes, const StringSeq &traceCategories, int messageMax, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Attaches a RemoteLogger object to the local logger.
template<template< typename > class P = ::std::promise>
auto	attachRemoteLoggerAsync (const ::std::shared_ptr< RemoteLoggerPrx > &prx, const LogMessageTypeSeq &messageTypes, const StringSeq &traceCategories, int messageMax, const Context &context=noExplicitContext) -> decltype(::std::declval< P< void > >().get_future())
	Attaches a RemoteLogger object to the local logger.
bool	detachRemoteLogger (const ::std::shared_ptr< RemoteLoggerPrx > &prx, const Context &context=noExplicitContext)
	Detaches a RemoteLogger object from the local logger.
::std::function< void()>	detachRemoteLoggerAsync (const ::std::shared_ptr< RemoteLoggerPrx > &prx, ::std::function< void(bool)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Detaches a RemoteLogger object from the local logger.
template<template< typename > class P = ::std::promise>
auto	detachRemoteLoggerAsync (const ::std::shared_ptr< RemoteLoggerPrx > &prx, const Context &context=noExplicitContext) -> decltype(::std::declval< P< bool > >().get_future())
	Detaches a RemoteLogger object from the local logger.
LogMessageSeq	getLog (const LogMessageTypeSeq &messageTypes, const StringSeq &traceCategories, int messageMax, ::std::string &prefix, const Context &context=noExplicitContext)
	Retrieves log messages recently logged.
::std::function< void()>	getLogAsync (const LogMessageTypeSeq &messageTypes, const StringSeq &traceCategories, int messageMax, ::std::function< void(::Ice::LogMessageSeq, ::std::string)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Retrieves log messages recently logged.
template<template< typename > class P = ::std::promise>
auto	getLogAsync (const LogMessageTypeSeq &messageTypes, const StringSeq &traceCategories, int messageMax, const Context &context=noExplicitContext) -> decltype(::std::declval< P< LoggerAdmin::GetLogResult > >().get_future())
	Retrieves log messages recently logged.
Public Member Functions inherited from Ice::Proxy< LoggerAdminPrx, ObjectPrx >
::std::shared_ptr< LoggerAdminPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID.
::std::shared_ptr< LoggerAdminPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations.
::std::shared_ptr< LoggerAdminPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations.
::std::shared_ptr< LoggerAdminPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization.
::std::shared_ptr< LoggerAdminPrx >	ice_compress (bool b) const
	Obtains a proxy that is identical to this proxy, except for its compression setting which overrides the compression setting from the proxy endpoints.
::std::shared_ptr< LoggerAdminPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching.
::std::shared_ptr< LoggerAdminPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID.
::std::shared_ptr< LoggerAdminPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context.
::std::shared_ptr< LoggerAdminPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations.
::std::shared_ptr< LoggerAdminPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters.
::std::shared_ptr< LoggerAdminPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints.
::std::shared_ptr< LoggerAdminPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy.
::std::shared_ptr< LoggerAdminPrx >	ice_fixed (const ::std::shared_ptr<::Ice::Connection > &connection) const
	Obtains a proxy that is identical to this proxy, except it's a fixed proxy bound the given connection.
::std::shared_ptr< LoggerAdminPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout.
::std::shared_ptr< LoggerAdminPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator.
::std::shared_ptr< LoggerAdminPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout.
::std::shared_ptr< LoggerAdminPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations.
::std::shared_ptr< LoggerAdminPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy.
::std::shared_ptr< LoggerAdminPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router.
::std::shared_ptr< LoggerAdminPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints.
::std::shared_ptr< LoggerAdminPrx >	ice_timeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for its connection timeout setting which overrides the timeot setting from the proxy endpoints.
::std::shared_ptr< LoggerAdminPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations.

Static Public Member Functions
static const ::std::string &	ice_staticId ()
	Obtains the Slice type ID of this interface.

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 Function Documentation

◆ attachRemoteLogger()

void Ice::LoggerAdminPrx::attachRemoteLogger	(	const ::std::shared_ptr< RemoteLoggerPrx > &	prx,
		const LogMessageTypeSeq &	messageTypes,
		const StringSeq &	traceCategories,
		int	messageMax,
		const Context &	context = noExplicitContext )

inline

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.
context	The Context map to send with the invocation.

Exceptions

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

◆ attachRemoteLoggerAsync() [1/2]

::std::function< void()> Ice::LoggerAdminPrx::attachRemoteLoggerAsync	(	const ::std::shared_ptr< RemoteLoggerPrx > &	prx,
		const LogMessageTypeSeq &	messageTypes,
		const StringSeq &	traceCategories,
		int	messageMax,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = nullptr,
		::std::function< void(bool)>	sent = nullptr,
		const Context &	context = noExplicitContext )

inline

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.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ attachRemoteLoggerAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Ice::LoggerAdminPrx::attachRemoteLoggerAsync	(	const ::std::shared_ptr< RemoteLoggerPrx > &	prx,
		const LogMessageTypeSeq &	messageTypes,
		const StringSeq &	traceCategories,
		int	messageMax,
		const Context &	context = noExplicitContext ) -> decltype(::std::declval< P< void > >().get_future())

inline

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.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ detachRemoteLogger()

bool Ice::LoggerAdminPrx::detachRemoteLogger	(	const ::std::shared_ptr< RemoteLoggerPrx > &	prx,
		const Context &	context = noExplicitContext )

inline

Detaches a RemoteLogger object from the local logger.

Parameters

prx	A proxy to the remote logger.
context	The Context map to send with the invocation.

Returns: True if the provided remote logger proxy was detached, and false otherwise.

◆ detachRemoteLoggerAsync() [1/2]

::std::function< void()> Ice::LoggerAdminPrx::detachRemoteLoggerAsync	(	const ::std::shared_ptr< RemoteLoggerPrx > &	prx,
		::std::function< void(bool)>	response,
		::std::function< void(::std::exception_ptr)>	ex = nullptr,
		::std::function< void(bool)>	sent = nullptr,
		const Context &	context = noExplicitContext )

inline

Detaches a RemoteLogger object from the local logger.

Parameters

prx	A proxy to the remote logger.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ detachRemoteLoggerAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Ice::LoggerAdminPrx::detachRemoteLoggerAsync	(	const ::std::shared_ptr< RemoteLoggerPrx > &	prx,
		const Context &	context = noExplicitContext ) -> decltype(::std::declval< P< bool > >().get_future())

inline

Detaches a RemoteLogger object from the local logger.

Parameters

prx	A proxy to the remote logger.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ getLog()

LogMessageSeq Ice::LoggerAdminPrx::getLog	(	const LogMessageTypeSeq &	messageTypes,
		const StringSeq &	traceCategories,
		int	messageMax,
		::std::string &	prefix,
		const Context &	context = noExplicitContext )

inline

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.
context	The Context map to send with the invocation.

Returns: The Log messages.

◆ getLogAsync() [1/2]

::std::function< void()> Ice::LoggerAdminPrx::getLogAsync	(	const LogMessageTypeSeq &	messageTypes,
		const StringSeq &	traceCategories,
		int	messageMax,
		::std::function< void(::Ice::LogMessageSeq, ::std::string)>	response,
		::std::function< void(::std::exception_ptr)>	ex = nullptr,
		::std::function< void(bool)>	sent = nullptr,
		const Context &	context = noExplicitContext )

inline

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.
response	The response callback.
ex	The exception callback.
sent	The sent callback.
context	The Context map to send with the invocation.

Returns: A function that can be called to cancel the invocation locally.

◆ getLogAsync() [2/2]

template<template< typename > class P = ::std::promise>

auto Ice::LoggerAdminPrx::getLogAsync	(	const LogMessageTypeSeq &	messageTypes,
		const StringSeq &	traceCategories,
		int	messageMax,
		const Context &	context = noExplicitContext ) -> decltype(::std::declval< P< LoggerAdmin::GetLogResult > >().get_future())

inline

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.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ ice_staticId()

const ::std::string & Ice::LoggerAdminPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ attachRemoteLogger()

◆ attachRemoteLoggerAsync() [1/2]

◆ attachRemoteLoggerAsync() [2/2]

◆ detachRemoteLogger()

◆ detachRemoteLoggerAsync() [1/2]

◆ detachRemoteLoggerAsync() [2/2]

◆ getLog()

◆ getLogAsync() [1/2]

◆ getLogAsync() [2/2]

◆ ice_staticId()