Mac Developer Library

Developer

IOBlockStorageDriver.h Reference

Options
Deployment Target:

On This Page

IOBlockStorageDriver.h Reference

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.

  • Declaration

    #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.

    • kIOBlockStorageDriverStatisticsBytesReadKey

      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.

    • kIOBlockStorageDriverStatisticsBytesWrittenKey

      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.

    • kIOBlockStorageDriverStatisticsKey

      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.

    • kIOBlockStorageDriverStatisticsLatentReadTimeKey

      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.

    • kIOBlockStorageDriverStatisticsLatentWriteTimeKey

      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.

    • kIOBlockStorageDriverStatisticsReadErrorsKey

      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.

    • kIOBlockStorageDriverStatisticsReadRetriesKey

      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.

    • kIOBlockStorageDriverStatisticsReadsKey

      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.

    • kIOBlockStorageDriverStatisticsTotalReadTimeKey

      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.

    • kIOBlockStorageDriverStatisticsTotalWriteTimeKey

      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.

    • kIOBlockStorageDriverStatisticsWriteErrorsKey

      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.

    • kIOBlockStorageDriverStatisticsWriteRetriesKey

      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.

    • kIOBlockStorageDriverStatisticsWritesKey

      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.

  • The different states that getMediaState() can report.

    Declaration

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

    Constants

    • kIOMediaStateOffline

      Media is not available.

    • kIOMediaStateOnline

      Media is available and ready for operations.

    • kIOMediaStateBusy

      Media is available, but not ready for operations.