This interface provides access to IceGrid log file contents. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::FileIteratorPrx:

Collaboration diagram for IceGrid::FileIteratorPrx:

Public Member Functions
void	destroy (const ::Ice::Context &context=::Ice::noExplicitContext)
	Destroy the iterator. More...

::std::function< void()>	destroyAsync (::std::function< void()> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Destroy the iterator. More...

template<template< typename > class P = ::std::promise>
auto	destroyAsync (const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< void >>().get_future())
	Destroy the iterator. More...

bool	read (int size, ::Ice::StringSeq &lines, const ::Ice::Context &context=::Ice::noExplicitContext)
	Read lines from the log file. More...

::std::function< void()>	readAsync (int size, ::std::function< void(bool, ::Ice::StringSeq)> response, ::std::function< void(::std::exception_ptr)> ex=nullptr, ::std::function< void(bool)> sent=nullptr, const ::Ice::Context &context=::Ice::noExplicitContext)
	Read lines from the log file. More...

template<template< typename > class P = ::std::promise>
auto	readAsync (int size, const ::Ice::Context &context=::Ice::noExplicitContext) -> decltype(::std::declval< P< FileIterator::ReadResult >>().get_future())
	Read lines from the log file. More...

Public Member Functions inherited from Ice::Proxy< FileIteratorPrx, ::Ice::ObjectPrx >
::std::shared_ptr< FileIteratorPrx >	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< FileIteratorPrx >	ice_batchDatagram () const
	Obtains a proxy that is identical to this proxy, but uses batch datagram invocations. More...

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

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

::std::shared_ptr< FileIteratorPrx >	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< FileIteratorPrx >	ice_connectionCached (bool b) const
	Obtains a proxy that is identical to this proxy, except for connection caching. More...

::std::shared_ptr< FileIteratorPrx >	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< FileIteratorPrx >	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< FileIteratorPrx >	ice_datagram () const
	Obtains a proxy that is identical to this proxy, but uses datagram invocations. More...

::std::shared_ptr< FileIteratorPrx >	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< FileIteratorPrx >	ice_endpoints (const ::Ice::EndpointSeq &endpoints) const
	Obtains a proxy that is identical to this proxy, except for the endpoints. More...

::std::shared_ptr< FileIteratorPrx >	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< FileIteratorPrx >	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< FileIteratorPrx >	ice_invocationTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the invocation timeout. More...

::std::shared_ptr< FileIteratorPrx >	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< FileIteratorPrx >	ice_locatorCacheTimeout (int timeout) const
	Obtains a proxy that is identical to this proxy, except for the locator cache timeout. More...

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

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

::std::shared_ptr< FileIteratorPrx >	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< FileIteratorPrx >	ice_secure (bool b) const
	Obtains a proxy that is identical to this proxy, except for how it selects endpoints. More...

::std::shared_ptr< FileIteratorPrx >	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< FileIteratorPrx >	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

This interface provides access to IceGrid log file contents.

Member Function Documentation

◆ destroy()

void IceGrid::FileIteratorPrx::destroy ( const ::Ice::Context & context = ::Ice::noExplicitContext )

inline

Destroy the iterator.

Parameters

context The Context map to send with the invocation.

◆ destroyAsync() [1/2]

::std::function<void()> IceGrid::FileIteratorPrx::destroyAsync	(	::std::function< void()>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Destroy the iterator.

Parameters

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.

◆ destroyAsync() [2/2]

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

auto IceGrid::FileIteratorPrx::destroyAsync ( const ::Ice::Context & context = ::Ice::noExplicitContext ) -> decltype(::std::declval<P<void>>().get_future())

inline

Destroy the iterator.

Parameters

context The Context map to send with the invocation.

Returns: The future object for the invocation.

◆ ice_staticId()

static const ::std::string& IceGrid::FileIteratorPrx::ice_staticId ( )

static

Obtains the Slice type ID of this interface.

Returns: The fully-scoped type ID.

◆ read()

bool IceGrid::FileIteratorPrx::read	(	int	size,
		::Ice::StringSeq &	lines,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Read lines from the log file.

Parameters

size	Specifies the maximum number of bytes to be received. The server will ensure that the returned message doesn't exceed the given size.
lines	The lines read from the file. If there was nothing to read from the file since the last call to read, an empty sequence is returned. The last line of the sequence is always incomplete (and therefore no ' ' should be added when writing the last line to the to the output device).
context	The Context map to send with the invocation.

Returns: True if EOF is encountered.

Exceptions

IceGrid::FileNotAvailableException Raised if there was a problem to read lines from the file.

◆ readAsync() [1/2]

::std::function<void()> IceGrid::FileIteratorPrx::readAsync	(	int	size,
		::std::function< void(bool, ::Ice::StringSeq)>	response,
		::std::function< void(::std::exception_ptr)>	ex = `nullptr`,
		::std::function< void(bool)>	sent = `nullptr`,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)

inline

Read lines from the log file.

Parameters

size	Specifies the maximum number of bytes to be received. The server will ensure that the returned message doesn't exceed the given size.
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.

◆ readAsync() [2/2]

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

auto IceGrid::FileIteratorPrx::readAsync	(	int	size,
		const ::Ice::Context &	context = `::Ice::noExplicitContext`
	)		-> decltype(::std::declval<P<FileIterator::ReadResult>>().get_future())

inline

Read lines from the log file.

Parameters

size	Specifies the maximum number of bytes to be received. The server will ensure that the returned message doesn't exceed the given size.
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/IceGrid/Admin.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ destroy()

◆ destroyAsync() [1/2]

◆ destroyAsync() [2/2]

◆ ice_staticId()

◆ read()

◆ readAsync() [1/2]

◆ readAsync() [2/2]