The Ice remote logger interface. More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::RemoteLoggerPrx:

Collaboration diagram for Ice::RemoteLoggerPrx:

Public Member Functions
void	init (const ::std::string &prefix, const LogMessageSeq &logMessages, const Context &context=noExplicitContext)
	init is called by attachRemoteLogger when a RemoteLogger proxy is attached. More...

::std::function< void()>	initAsync (const ::std::string &prefix, const LogMessageSeq &logMessages, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	init is called by attachRemoteLogger when a RemoteLogger proxy is attached. More...

template<template< typename > class P = ::std::promise>
auto	initAsync (const ::std::string &prefix, const LogMessageSeq &logMessages, const Context &context=noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	init is called by attachRemoteLogger when a RemoteLogger proxy is attached. More...

void	log (const LogMessage &message, const Context &context=noExplicitContext)
	Log a LogMessage. More...

::std::function< void()>	logAsync (const LogMessage &message, ::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const Context &context=noExplicitContext)
	Log a LogMessage. More...

template<template< typename > class P = ::std::promise>
auto	logAsync (const LogMessage &message, const Context &context=noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Log a LogMessage. More...

Public Member Functions inherited from Ice::Proxy< RemoteLoggerPrx, ObjectPrx >
::std::shared_ptr< RemoteLoggerPrx >	ice_adapterId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for the adapter ID. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_batchOneway () const
	Obtains a proxy that is identical to this proxy, but uses batch oneway invocations. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_collocationOptimized (bool b) const
	Obtains a proxy that is identical to this proxy, except for collocation optimization. More...

::std::shared_ptr< RemoteLoggerPrx >	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. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_connectionId (const ::std::string &id) const
	Obtains a proxy that is identical to this proxy, except for its connection ID. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_context (const ::Ice::Context &context) const
	Obtains a proxy that is identical to this proxy, except for the per-proxy context. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_encodingVersion (const ::Ice::EncodingVersion &version) const
	Obtains a proxy that is identical to this proxy, except for the encoding used to marshal parameters. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_endpointSelection (::Ice::EndpointSelectionType type) const
	Obtains a proxy that is identical to this proxy, except for the endpoint selection policy. More...

::std::shared_ptr< RemoteLoggerPrx >	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. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_locator (const ::std::shared_ptr<::Ice::LocatorPrx > &locator) const
	Obtains a proxy that is identical to this proxy, except for the locator. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_oneway () const
	Obtains a proxy that is identical to this proxy, but uses oneway invocations. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_preferSecure (bool b) const
	Obtains a proxy that is identical to this proxy, except for its endpoint selection policy. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_router (const ::std::shared_ptr<::Ice::RouterPrx > &router) const
	Obtains a proxy that is identical to this proxy, except for the router. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< RemoteLoggerPrx >	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. More...

::std::shared_ptr< RemoteLoggerPrx >	ice_twoway () const
	Obtains a proxy that is identical to this proxy, but uses twoway invocations. More...

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

Detailed Description

The Ice remote logger interface.

An application can implement a RemoteLogger to receive the log messages sent to the local Logger of another Ice application.

Member Function Documentation

◆ ice_staticId()

static const ::std::string& Ice::RemoteLoggerPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

◆ init()

void Ice::RemoteLoggerPrx::init	(	const ::std::string &	prefix,
		const LogMessageSeq &	logMessages,
		const Context &	context = `noExplicitContext`
	)

inline

init is called by attachRemoteLogger when a RemoteLogger proxy is attached.

Parameters

prefix	The prefix of the associated local Logger.
logMessages	Old log messages generated before "now".
context	The Context map to send with the invocation.

◆ initAsync() [1/2]

::std::function<void()> Ice::RemoteLoggerPrx::initAsync	(	const ::std::string &	prefix,
		const LogMessageSeq &	logMessages,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

init is called by attachRemoteLogger when a RemoteLogger proxy is attached.

Parameters

prefix	The prefix of the associated local Logger.
logMessages	Old log messages generated before "now".
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.

◆ initAsync() [2/2]

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

auto Ice::RemoteLoggerPrx::initAsync	(	const ::std::string &	prefix,
		const LogMessageSeq &	logMessages,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<void>>().get_future())

inline

init is called by attachRemoteLogger when a RemoteLogger proxy is attached.

Parameters

prefix	The prefix of the associated local Logger.
logMessages	Old log messages generated before "now".
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ log()

void Ice::RemoteLoggerPrx::log	(	const LogMessage &	message,
		const Context &	context = `noExplicitContext`
	)

inline

Log a LogMessage.

Note that log may be called by LoggerAdmin before init.

Parameters

message	The message to log.
context	The Context map to send with the invocation.

◆ logAsync() [1/2]

::std::function<void()> Ice::RemoteLoggerPrx::logAsync	(	const LogMessage &	message,
		::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const Context &	context = `noExplicitContext`
	)

inline

Log a LogMessage.

Note that log may be called by LoggerAdmin before init.

Parameters

message	The message to log.
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.

◆ logAsync() [2/2]

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

auto Ice::RemoteLoggerPrx::logAsync	(	const LogMessage &	message,
		const Context &	context = `noExplicitContext`
	)		-> decltype(::std::declval<P<void>>().get_future())

inline

Log a LogMessage.

Note that log may be called by LoggerAdmin before init.

Parameters

message	The message to log.
context	The Context map to send with the invocation.

Returns: The future object for the invocation.

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

◆ ice_staticId()

◆ init()

◆ initAsync() [1/2]

◆ initAsync() [2/2]

◆ log()

◆ logAsync() [1/2]

◆ logAsync() [2/2]