StreamingLogReader (core 5.2.0-rc1-20240327 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CompletableIterator<LogEvent>, java.util.Iterator<LogEvent>, LogEventIterator, OffsetIterator<LogEvent>

All Known Subinterfaces:

ReverseSeekingStreamingLogReader, StreamingLogReaderPlugin
```
public interface StreamingLogReader
extends LogEventIterator, java.io.Closeable
```
Reads log events in a streaming manner, and supports resuming from a specified offset.

See Also:

LogEventIterator, OffsetIterator, Closeable, CompletableIterator

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.Date`	`getLastModified()`	Return the last modification time of the log (e.g.
`long`	`getTotalSize()`	Return the total size
`void`	`openStream(java.lang.Long offset)`	Read log entries starting at the specified offset

Methods inherited from interface java.io.Closeable
close

Methods inherited from interface com.dtolabs.rundeck.core.logging.CompletableIterator
isComplete

Methods inherited from interface java.util.Iterator
forEachRemaining, hasNext, next, remove

Methods inherited from interface com.dtolabs.rundeck.core.logging.OffsetIterator
getOffset

- Method Detail
  - openStream
```
void openStream(java.lang.Long offset)
         throws java.io.IOException
```
    Read log entries starting at the specified offset
    
    Parameters:
    
    offset - offset value
    
    Throws:
    
    java.io.IOException - if an io error occurs
  - getTotalSize
```
long getTotalSize()
```
    Return the total size
    
    Returns:
    
    total size
  - getLastModified
```
java.util.Date getLastModified()
```
    Return the last modification time of the log (e.g. last log entry time, or null if not modified)
    
    Returns:
    
    last modified date