IOBlockStorageDriver.h Reference

Declared in
IOBlockStorageDriver.h

Overview

This header contains the IOBlockStorageDriver class definition.

Included Headers

  • <IOKit/IOTypes.h>

  • <IOKit/storage/IOBlockStorageDevice.h>

  • <IOKit/storage/IOMedia.h>

  • <IOKit/storage/IOStorage.h>

Constants

See the Overview section above for header-level documentation.

Miscellaneous Defines

   
#define kIOBlockStorageDriverClass "IOBlockStorageDriver"
#define kIOBlockStorageDriverStatisticsBytesReadKey "Bytes (Read)"
#define kIOBlockStorageDriverStatisticsBytesWrittenKey "Bytes (Write)"
#define kIOBlockStorageDriverStatisticsKey "Statistics"
#define kIOBlockStorageDriverStatisticsLatentReadTimeKey "Latency Time (Read)"
#define kIOBlockStorageDriverStatisticsLatentWriteTimeKey "Latency Time (Write)"
#define kIOBlockStorageDriverStatisticsReadErrorsKey "Errors (Read)"
#define kIOBlockStorageDriverStatisticsReadRetriesKey "Retries (Read)"
#define kIOBlockStorageDriverStatisticsReadsKey "Operations (Read)"
#define kIOBlockStorageDriverStatisticsTotalReadTimeKey "Total Time (Read)"
#define kIOBlockStorageDriverStatisticsTotalWriteTimeKey "Total Time (Write)"
#define kIOBlockStorageDriverStatisticsWriteErrorsKey "Errors (Write)"
#define kIOBlockStorageDriverStatisticsWriteRetriesKey "Retries (Write)"
#define kIOBlockStorageDriverStatisticsWritesKey "Operations (Write)"
Constants
kIOBlockStorageDriverClass

The name of the IOBlockStorageDriver class.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsBytesReadKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsBytesWrittenKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsLatentReadTimeKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsLatentWriteTimeKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsReadErrorsKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsReadRetriesKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsReadsKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsTotalReadTimeKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsTotalWriteTimeKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsWriteErrorsKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsWriteRetriesKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

kIOBlockStorageDriverStatisticsWritesKey

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

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.

Available in OS X v10.0 and later.

Declared in IOBlockStorageDriver.h.

IOMediaState

The different states that getMediaState() can report.

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

Media is not available.

Available in OS X v10.4 and later.

Declared in IOBlockStorageDriver.h.

kIOMediaStateOnline

Media is available and ready for operations.

Available in OS X v10.4 and later.

Declared in IOBlockStorageDriver.h.

kIOMediaStateBusy

Media is available, but not ready for operations.

Available in OS X v10.4 and later.

Declared in IOBlockStorageDriver.h.