Package org.apache.jackrabbit.oak.segment.spi.monitor

Interface IOMonitor

All Known Implementing Classes:

CompositeIOMonitor, DiskCacheIOMonitor, IOMonitorAdapter, IOTraceMonitor, MetricsIOMonitor, RedisCacheIOMonitor

public interface IOMonitor

Callback interface that eases the collection of statistics about I/O operations.

Method Summary

Modifier and Type	Method	Description
void	afterSegmentRead(File file, long msb, long lsb, int length, long elapsed)	Called after a segment is read from the file system.
void	afterSegmentWrite(File file, long msb, long lsb, int length, long elapsed)	Called after a segment is written to the file system.
void	beforeSegmentRead(File file, long msb, long lsb, int length)	Called before a segment is read from the file system.
void	beforeSegmentWrite(File file, long msb, long lsb, int length)	Called before a segment is written to the file system.

Method Detail

beforeSegmentRead

void beforeSegmentRead(File file,
                       long msb,
                       long lsb,
                       int length)

Called before a segment is read from the file system.

Parameters:

file - File containing the segment.

msb - Most significant bits of the segment ID.

lsb - Least significant bits of the segment ID.

length - Size of the segment.

afterSegmentRead

void afterSegmentRead(File file,
                      long msb,
                      long lsb,
                      int length,
                      long elapsed)

Called after a segment is read from the file system. This is called only in case of successful operations.

Parameters:

file - File containing the segment.

msb - Most significant bits of the segment ID.

lsb - Least significant bits of the segment ID.

length - Size of the segment.

elapsed - Time spent by the read operation, in nanoseconds.

beforeSegmentWrite

void beforeSegmentWrite(File file,
                        long msb,
                        long lsb,
                        int length)

Called before a segment is written to the file system.

Parameters:

file - File containing the segment.

msb - Most significant bits of the segment ID.

lsb - Least significant bits of the segment ID.

length - Size of the segment.

afterSegmentWrite

void afterSegmentWrite(File file,
                       long msb,
                       long lsb,
                       int length,
                       long elapsed)

Called after a segment is written to the file system. This is called only in case of successful operations.

Parameters:

file - File containing the segment.

msb - Most significant bits of the segment ID.

lsb - Least significant bits of the segment ID.

length - Size of the segment.

elapsed - Time spent by the write operation, in nanoseconds.