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

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::FileIterator:

[legend]

Collaboration diagram for IceGrid::FileIterator:

[legend]

Public Types
typedef FileIteratorPtr	PointerType
typedef FileIteratorPrx	ProxyType

Public Member Functions
virtual void	destroy (const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Destroy the iterator.
virtual const ::std::string &	ice_id (const ::Ice::Current &current=::Ice::emptyCurrent) const
	Obtains a Slice type ID representing the most-derived interface supported by this object.
virtual ::std::vector< ::std::string >	ice_ids (const ::Ice::Current &current=::Ice::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 ::Ice::Current &current=::Ice::emptyCurrent) const
	Determines whether this object supports an interface with the given Slice type ID.
virtual bool	read (::Ice::Int size, ::Ice::StringSeq &lines, const ::Ice::Current &current=::Ice::emptyCurrent)=0
	Read lines from the log file.
virtual	~FileIterator ()
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 const std::string &	ice_id (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type ID of the most-derived interface supported by this object.
virtual std::vector< std::string >	ice_ids (const Current &current=Ice::emptyCurrent) const
	Returns the Slice type IDs of the interfaces supported by this object.
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

This interface provides access to IceGrid log file contents.

Member Typedef Documentation

◆ PointerType

typedef FileIteratorPtr IceGrid::FileIterator::PointerType

◆ ProxyType

typedef FileIteratorPrx IceGrid::FileIterator::ProxyType

Constructor & Destructor Documentation

◆ ~FileIterator()

virtual IceGrid::FileIterator::~FileIterator ( )

virtual

Member Function Documentation

◆ destroy()

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

pure virtual

Destroy the iterator.

Parameters

current The Current object for the invocation.

◆ ice_id()

virtual const ::std::string & IceGrid::FileIterator::ice_id ( const ::Ice::Current & current = ::Ice::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.

◆ ice_ids()

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

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

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/cpp98/x64/Release/IceGrid/Admin.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PointerType

◆ ProxyType

Constructor & Destructor Documentation

◆ ~FileIterator()

Member Function Documentation

◆ destroy()

◆ ice_id()

◆ ice_ids()

◆ ice_isA()

◆ ice_staticId()

◆ read()