Package com.zeroc.IceGrid

Interface FileIterator

All Superinterfaces:

Object

public interface FileIterator
extends Object

This interface provides access to IceGrid log file contents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	FileIterator.ReadResult	Holds the result of operation read.

Nested classes/interfaces inherited from interface com.zeroc.Ice.Object

Object.Ice_invokeResult

Method Summary

Modifier and Type	Method	Description
void	destroy(Current current)	Destroy the iterator.
default String	ice_id(Current current)	Returns the Slice type ID of the most-derived interface supported by this object.
default String[]	ice_ids(Current current)	Returns the Slice type IDs of the interfaces supported by this object.
static String	ice_staticId()	Returns the Slice type ID of the interface supported by this object.
FileIterator.ReadResult	read(int size, Current current)	Read lines from the log file.

Methods inherited from interface com.zeroc.Ice.Object

ice_dispatch, ice_isA, ice_ping

Method Details

read

FileIterator.ReadResult read(int size,
 Current current)
                      throws FileNotAvailableException

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.

current - The Current object for the invocation.

Returns:

An instance of FileIterator.ReadResult.

Throws:

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

destroy

void destroy(Current current)

Destroy the iterator.

Parameters:

current - The Current object for the invocation.

ice_ids

default String[] ice_ids(Current current)

Description copied from interface: Object

Returns the Slice type IDs of the interfaces supported by this object.

Specified by:

ice_ids in interface Object

Parameters:

current - The Current object for the invocation.

Returns:

The Slice type IDs of the interfaces supported by this object, in base-to-derived order. The first element of the returned array is always ::Ice::Object.

ice_id

default String ice_id(Current current)

Description copied from interface: Object

Returns the Slice type ID of the most-derived interface supported by this object.

Specified by:

ice_id in interface Object

Parameters:

current - The Current object for the invocation.

Returns:

The Slice type ID of the most-derived interface.

ice_staticId

static String ice_staticId()

Description copied from interface: Object

Returns the Slice type ID of the interface supported by this object.

Returns:

The return value is always ::Ice::Object.