IOBlockStorageDriver.h

Overview

This header contains the IOBlockStorageDriver class definition.

Enumerated Types

IOMediaState

The different states that getMediaState() can report.

The different states that getMediaState() can report.

enum { 
    kIOMediaStateOffline = 0, 
    kIOMediaStateOnline = 1, 
    kIOMediaStateBusy = 2 
};  

Constants

Macro Definitions

kIOBlockStorageDriverClass

The name of the IOBlockStorageDriver class.

kIOBlockStorageDriverStatisticsBytesReadKey

Describes the number of bytes read since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsBytesWrittenKey

Describes the number of bytes written since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsKey

Holds a table of numeric values describing the driver's operating statistics.

kIOBlockStorageDriverStatisticsLatentReadTimeKey

Describes the number of nanoseconds of latency during reads since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsLatentWriteTimeKey

Describes the number of nanoseconds of latency during writes since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsReadErrorsKey

Describes the number of read errors encountered since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsReadRetriesKey

Describes the number of read retries required since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsReadsKey

Describes the number of read operations processed since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsTotalReadTimeKey

Describes the number of nanoseconds spent performing reads since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsTotalWriteTimeKey

Describes the number of nanoseconds spent performing writes since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsWriteErrorsKey

Describes the number of write errors encountered since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsWriteRetriesKey

Describes the number of write retries required since the block storage driver was instantiated.

kIOBlockStorageDriverStatisticsWritesKey

Describes the number of write operations processed since the block storage driver was instantiated.

The name of the IOBlockStorageDriver class.

#define kIOBlockStorageDriverClass "IOBlockStorageDriver" 

Describes the number of bytes read since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsBytesReadKey "Bytes (Read)" 

Discussion

This property describes the number of bytes read since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of bytes written since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsBytesWrittenKey "Bytes (Write)" 

Discussion

This property describes the number of bytes written since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Holds a table of numeric values describing the driver's operating statistics.

#define kIOBlockStorageDriverStatisticsKey "Statistics" 

Discussion

This property holds a table of numeric values describing the driver's operating statistics. The table is an OSDictionary, where each entry describes one given statistic.

Describes the number of nanoseconds of latency during reads since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsLatentReadTimeKey "Latency Time (Read)" 

Discussion

This property describes the number of nanoseconds of latency during reads since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of nanoseconds of latency during writes since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsLatentWriteTimeKey "Latency Time (Write)" 

Discussion

This property describes the number of nanoseconds of latency during writes since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of read errors encountered since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsReadErrorsKey "Errors (Read)" 

Discussion

This property describes the number of read errors encountered since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of read retries required since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsReadRetriesKey "Retries (Read)" 

Discussion

This property describes the number of read retries required since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of read operations processed since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsReadsKey "Operations (Read)" 

Discussion

This property describes the number of read operations processed since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of nanoseconds spent performing reads since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsTotalReadTimeKey "Total Time (Read)" 

Discussion

This property describes the number of nanoseconds spent performing reads since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of nanoseconds spent performing writes since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsTotalWriteTimeKey "Total Time (Write)" 

Discussion

This property describes the number of nanoseconds spent performing writes since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of write errors encountered since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsWriteErrorsKey "Errors (Write)" 

Discussion

This property describes the number of write errors encountered since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of write retries required since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsWriteRetriesKey "Retries (Write)" 

Discussion

This property describes the number of write retries required since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Describes the number of write operations processed since the block storage driver was instantiated.

#define kIOBlockStorageDriverStatisticsWritesKey "Operations (Write)" 

Discussion

This property describes the number of write operations processed since the block storage driver was instantiated. It is one of the statistic entries listed under the top-level kIOBlockStorageDriverStatisticsKey property table. It has an OSNumber value.

Last Updated: 2009-10-15