Module com.zeroc.icegrid
Package com.zeroc.IceGrid

Interface AsyncFileIterator

All Superinterfaces:
Object
public interface AsyncFileIterator extends Object
Iterates over an IceGrid log file.

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

  • Method Details

    • readAsync

      CompletionStage<FileIterator.ReadResult> readAsync(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:
      a completion stage that the servant will complete with an instance of FileIterator.ReadResult
      Throws:
      FileNotAvailableException - Thrown when the implementation failed to read from the file.

    • destroyAsync

      CompletionStage<Void> destroyAsync(Current current)
      Destroys the iterator.
      Parameters:
      current - the Current object of the incoming request
      Returns:
      a completion stage that the servant will complete when the invocation completes

    • 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.