Class FileIterator`Abstract`

Iterates over an IceGrid log file.

Remarks

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

Hierarchy (View Summary)

Object
- FileIterator

Index

Constructors

Methods

destroy dispatch ice_id ice_ids ice_isA ice_ping read ice_staticId

Constructors

constructor

new FileIterator(): FileIterator
Returns FileIterator
Inherited from Object.constructor

Methods

`Abstract`destroy

destroy(current: Current): void | PromiseLike<void>
Destroys the iterator.
Parameters
- current: Current
  The Current object for the dispatch.
Returns void | PromiseLike<void>
A promise like object representing the result of the dispatch.

dispatch

dispatch(
request: IncomingRequest,
): OutgoingResponse | PromiseLike<OutgoingResponse>
Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.
Parameters
- request: IncomingRequest
  The incoming request.
Returns OutgoingResponse | PromiseLike<OutgoingResponse>
The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

Remarks
Ice marshals any exception thrown by this method into the response.

Overrides Object.dispatch

ice_id

ice_id(current: Current): string | PromiseLike<string>
Returns the Slice type ID of the most-derived interface supported by this object.
Parameters
- current: Current
  The Current object for the invocation.
Returns string | PromiseLike<string>
The Slice type ID of the most-derived interface.

Inherited from Object.ice_id

ice_ids

ice_ids(current: Current): string[] | PromiseLike<string[]>
Returns the Slice type IDs of the interfaces supported by this object.
Parameters
- current: Current
  The Current object for the invocation.
Returns string[] | PromiseLike<string[]>
The Slice type IDs of the interfaces supported by this object, in alphabetical order.

Inherited from Object.ice_ids

ice_isA

ice_isA(typeID: string, current: Current): boolean | PromiseLike<boolean>
Tests whether this object supports a specific Slice interface.
Parameters
- typeID: string
  The type ID of the Slice interface to test against.
- current: Current
  The Current object for the invocation.
Returns boolean | PromiseLike<boolean>
True if this object has the interface specified by typeID or derives from the interface specified by typeID.

Inherited from Object.ice_isA

ice_ping

ice_ping(current: Current): void | PromiseLike<void>
Tests whether this object can be reached.
Parameters
- current: Current
  The Current object for the invocation.
Returns void | PromiseLike<void>
Inherited from Object.ice_ping

`Abstract`read

read(
size: number,
current: Current,
): [boolean, string[]] | PromiseLike<[boolean, string[]]>
Read lines from the log file.
Parameters
- size: number
  Specifies the maximum number of bytes to be received. The server will ensure that the returned message doesn't exceed the given size.
- current: Current
  The Current object for the dispatch.
Returns [boolean, string[]] | PromiseLike<[boolean, string[]]>
A promise like object representing the result of the dispatch, which resolves to an array with the following entries:
- boolean : true if EOF is encountered.
- string[] : 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 newline character should be added when writing the last line to the to the output device).
Throws
IceGrid.FileNotAvailableException Thrown when the implementation failed to read from the file.

`Static`ice_staticId

ice_staticId(): string
Obtains the Slice type ID of this type.

Returns string
The return value is always "::IceGrid::FileIterator".

Overrides Object.ice_staticId