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

    Objective-C

    #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

      kIOBlockStorageDriverClass

      The name of the IOBlockStorageDriver class.

      Available in OS X v10.0 and later.

    • kIOBlockStorageDriverStatisticsBytesReadKey

      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.

    • kIOBlockStorageDriverStatisticsBytesWrittenKey

      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.

    • kIOBlockStorageDriverStatisticsKey

      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.

    • kIOBlockStorageDriverStatisticsLatentReadTimeKey

      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.

    • kIOBlockStorageDriverStatisticsLatentWriteTimeKey

      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.

    • kIOBlockStorageDriverStatisticsReadErrorsKey

      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.

    • kIOBlockStorageDriverStatisticsReadRetriesKey

      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.

    • kIOBlockStorageDriverStatisticsReadsKey

      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.

    • kIOBlockStorageDriverStatisticsTotalReadTimeKey

      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.

    • kIOBlockStorageDriverStatisticsTotalWriteTimeKey

      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.

    • kIOBlockStorageDriverStatisticsWriteErrorsKey

      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.

    • kIOBlockStorageDriverStatisticsWriteRetriesKey

      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.

    • kIOBlockStorageDriverStatisticsWritesKey

      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.

    Import Statement

  • The different states that getMediaState() can report.

    Declaration

    Objective-C

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

    Constants

    • kIOMediaStateOffline

      kIOMediaStateOffline

      Media is not available.

      Available in OS X v10.4 and later.

    • kIOMediaStateOnline

      kIOMediaStateOnline

      Media is available and ready for operations.

      Available in OS X v10.4 and later.

    • kIOMediaStateBusy

      kIOMediaStateBusy

      Media is available, but not ready for operations.

      Available in OS X v10.4 and later.

    Import Statement