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

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::FileIterator:

Collaboration diagram for IceGrid::FileIterator:

Classes
struct	ReadResult
	Encapsulates the results of a call to read. More...

Public Types
using	ProxyType = FileIteratorPrx

Public Member Functions
virtual void	destroy (const ::Ice::Current &current)=0
	Destroy the iterator. More...

virtual ::std::string	ice_id (const ::Ice::Current &current) 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 ::Ice::Current &current) 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 ::Ice::Current &current) const override
	Determines whether this object supports an interface with the given Slice type ID. More...

virtual bool	read (int size, ::Ice::StringSeq &lines, const ::Ice::Current &current)=0
	Read lines from the log file. More...

Public Member Functions inherited from Ice::Object
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 std::string	ice_id (const Current &current) const
	Returns the Slice type ID of the most-derived interface supported by this object. More...

virtual std::vector< std::string >	ice_ids (const Current &current) const
	Returns the Slice type IDs of the interfaces supported by this object. More...

virtual bool	ice_isA (std::string s, const Current &current) const
	Tests whether this object supports a specific Slice interface. More...

virtual void	ice_ping (const Current &current) const
	Tests whether this object can be reached. More...

virtual	~Object ()=default

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

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

Detailed Description

This interface provides access to IceGrid log file contents.

Member Typedef Documentation

◆ ProxyType

using IceGrid::FileIterator::ProxyType = FileIteratorPrx

Member Function Documentation

◆ destroy()

virtual void IceGrid::FileIterator::destroy ( const ::Ice::Current & current )

pure virtual

Destroy the iterator.

Parameters

current The Current object for the invocation.

◆ ice_id()

virtual ::std::string IceGrid::FileIterator::ice_id ( const ::Ice::Current & current ) const

override

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.

◆ ice_ids()

virtual ::std::vector<::std::string> IceGrid::FileIterator::ice_ids ( const ::Ice::Current & current ) const

override

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.

◆ ice_isA()

virtual bool IceGrid::FileIterator::ice_isA	(	::std::string	id,
		const ::Ice::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& IceGrid::FileIterator::ice_staticId ( )

static

Obtains the Slice type ID corresponding to this class.

Returns: A fully-scoped type ID.

◆ read()

virtual bool IceGrid::FileIterator::read	(	int	size,
		::Ice::StringSeq &	lines,
		const ::Ice::Current &	current
	)

pure virtual

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).
current	The Current object for the invocation.

Returns: True if EOF is encountered.

Exceptions

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

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

generated/cpp11/x64/Release/IceGrid/Admin.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ destroy()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

◆ read()