FileIterator

All Superinterfaces:: Object

public interface FileIterator extends Object

Iterates over an IceGrid log file.

Remarks: The Slice compiler generated this skeleton interface from Slice interface ::IceGrid::FileIterator.

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)

Destroys the iterator.

default CompletionStage<OutgoingResponse>

dispatch(IncomingRequest request)

Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.

static String

ice_staticId()

Gets the type ID of the associated Slice interface.

FileIterator.ReadResult

read(int size, Current current)

Read lines from the log file.

Methods inherited from interface com.zeroc.Ice.Object
ice_id, ice_ids, 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 of the incoming request
  
  Returns:
  
  an instance of FileIterator.ReadResult
  
  Throws:
  
  FileNotAvailableException - Thrown when the implementation failed to read from the file.
- destroy
  
  void destroy(Current current)
  
  Destroys the iterator.
  
  Parameters:
  
  current - the Current object of the incoming request
- ice_staticId
  
  static String ice_staticId()
  
  Gets the type ID of the associated Slice interface.
  
  Returns:
  
  the string "::IceGrid::FileIterator"
- dispatch
  
  default CompletionStage<OutgoingResponse> dispatch(IncomingRequest request) throws UserException
  
  Dispatches an incoming request to one of the methods of this generated interface, based on the operation name carried by the request.
  
  Specified by:
  
  dispatch in interface Object
  
  Parameters:
  
  request - the incoming request
  
  Returns:
  
  the outgoing response
  
  Throws:
  
  UserException - if a UserException is thrown, Ice will marshal it as the response payload.