Package io.sbk.api

Interface Reader<T>

All Superinterfaces:

DataReader<T>, DataRecordsReader<T>

public non-sealed interface Reader<T>
extends DataRecordsReader<T>

Interface for Readers.

Nested Class Summary

Nested classes/interfaces inherited from interface io.sbk.api.DataRecordsReader

DataRecordsReader.RecordTime<T>, DataRecordsReader.RecordTimeRequests<T>

Method Summary

Modifier and Type	Method	Description
void	close()	Close the Reader.
T	read()	Read the data.
default void	recordRead(DataType<T> dType, int size, io.time.Time time, Status status, io.perl.api.PerlChannel perlChannel)	Default implementation for Reading data using read() and recording the benchmark statistics.
default void	recordRead(DataType<T> dType, int size, io.time.Time time, Status status, io.perl.api.PerlChannel perlChannel, int id, ReadRequestsLogger logger)	Default implementation for Reading data using read() and recording the benchmark statistics.
default void	recordReadTime(DataType<T> dType, int size, io.time.Time time, Status status, io.perl.api.PerlChannel perlChannel)	Default implementation for Reading data using read(), extracting start time from data and recording the benchmark statistics.
default void	recordReadTime(DataType<T> dType, int size, io.time.Time time, Status status, io.perl.api.PerlChannel perlChannel, int id, ReadRequestsLogger logger)	Default implementation for Reading data using read(), extracting start time from data and recording the benchmark statistics.

Methods inherited from interface io.sbk.api.DataRecordsReader

genericRecordsReader, genericRecordsReader, genericRecordsReaderRateControl, genericRecordsReaderRateControl, genericRecordsTimeReader, genericRecordsTimeReader, genericRecordsTimeReaderRateControl, genericRecordsTimeReaderRateControl, RecordsReader, RecordsReader, RecordsReaderRateControl, RecordsReaderRateControl, RecordsReaderRW, RecordsReaderRW, RecordsReaderRWRateControl, RecordsReaderRWRateControl, RecordsTimeReader, RecordsTimeReader, RecordsTimeReaderRateControl, RecordsTimeReaderRateControl, RecordsTimeReaderRW, RecordsTimeReaderRW, RecordsTimeReaderRWRateControl, RecordsTimeReaderRWRateControl

Method Details

read

T read()
throws EOFException,
IOException

Read the data.

Returns:

T return the data.

Throws:

EOFException - If the End of the file occurred.

IOException - If an exception occurred.

close

void close()
    throws IOException

Close the Reader.

Specified by:

close in interface DataReader<T>

Throws:

IOException - If an exception occurred.

recordRead

default void recordRead(DataType<T> dType,
 int size,
 io.time.Time time,
 Status status,
 io.perl.api.PerlChannel perlChannel)
                 throws EOFException,
IOException

Default implementation for Reading data using read() and recording the benchmark statistics. The end time of the status parameter Status.endTime of this method determines the terminating condition for time based reader performance benchmarking. If you are intend to not use read() then you can override this method. If you are intend to read multiple records then you can override this method. otherwise, use the default implementation and don't override this method.

Specified by:

recordRead in interface DataRecordsReader<T>

Parameters:

dType - dataType

size - size of the data in bytes

time - time interface

status - Timestamp

perlChannel - to call for benchmarking

Throws:

EOFException - If the End of the file occurred.

IOException - If an exception occurred.

recordRead

default void recordRead(DataType<T> dType,
 int size,
 io.time.Time time,
 Status status,
 io.perl.api.PerlChannel perlChannel,
 int id,
 ReadRequestsLogger logger)
                 throws EOFException,
IOException

Default implementation for Reading data using read() and recording the benchmark statistics. The end time of the status parameter Status.endTime of this method determines the terminating condition for time based reader performance benchmarking. If you are intend to not use read() then you can override this method. If you are intend to read multiple records then you can override this method. otherwise, use the default implementation and don't override this method.

Specified by:

recordRead in interface DataRecordsReader<T>

Parameters:

dType - dataType

size - size of the data in bytes

time - time interface

status - Timestamp

perlChannel - to call for benchmarking

id - reader id

logger - Read Request logger

Throws:

EOFException - If the End of the file occurred.

IOException - If an exception occurred.

recordReadTime

default void recordReadTime(DataType<T> dType,
 int size,
 io.time.Time time,
 Status status,
 io.perl.api.PerlChannel perlChannel)
                     throws EOFException,
IOException

Default implementation for Reading data using read(), extracting start time from data and recording the benchmark statistics. The end time of the status parameter Status.endTime of this method determines the terminating condition for time based reader performance benchmarking. If you are intend to not use read() then you can override this method. If you are intend to read multiple records then you can override this method. otherwise, use the default implementation and don't override this method.

Specified by:

recordReadTime in interface DataRecordsReader<T>

Parameters:

dType - dataType

size - size of the data in bytes

time - time interface

status - Timestamp

perlChannel - to call for benchmarking

Throws:

EOFException - If the End of the file occurred.

IOException - If an exception occurred.

recordReadTime

default void recordReadTime(DataType<T> dType,
 int size,
 io.time.Time time,
 Status status,
 io.perl.api.PerlChannel perlChannel,
 int id,
 ReadRequestsLogger logger)
                     throws EOFException,
IOException

Default implementation for Reading data using read(), extracting start time from data and recording the benchmark statistics. The end time of the status parameter Status.endTime of this method determines the terminating condition for time based reader performance benchmarking. If you are intend to not use read() then you can override this method. If you are intend to read multiple records then you can override this method. otherwise, use the default implementation and don't override this method.

Specified by:

recordReadTime in interface DataRecordsReader<T>

Parameters:

dType - dataType

size - size of the data in bytes

time - time interface

status - Timestamp

perlChannel - to call for benchmarking

id - Reader id

logger - log read requests

Throws:

EOFException - If the End of the file occurred.

IOException - If an exception occurred.