Mac Developer Library

Developer

IOMessage.h Reference

Options
Deployment Target:

On This Page

IOMessage.h Reference

Defines message type constants for several IOKit messaging API's.

Included Headers

  • <IOKit/IOReturn.h>

  • <IOKit/IOTypes.h>

Functions

  • Declaration

    Objective-C

    #define iokit_vendor_specific_msg(message) (UInt32)(sys_iokit|sub_iokit_vendor_specific|message)

    Discussion

    iokit_vendor_specific_msg passes messages in the sub_iokit_vendor_specific subsystem. It can be used to generate messages that are used for private communication between vendor specific code with the IOService::message() etc. APIs.

    Import Statement

    Availability

    Available in OS X v10.4 and later.

Constants

See the Overview section above for header-level documentation.

  • Declaration

    Objective-C

    #define kIOMessageCanDevicePowerOff iokit_common_msg(0x200) #define kIOMessageCanSystemPowerOff iokit_common_msg(0x240) #define kIOMessageCanSystemSleep iokit_common_msg(0x270) #define kIOMessageDeviceHasPoweredOff iokit_common_msg(0x225) #define kIOMessageDeviceHasPoweredOn iokit_common_msg(0x230) #define kIOMessageDeviceWillNotPowerOff iokit_common_msg(0x220) #define kIOMessageDeviceWillPowerOff iokit_common_msg(0x210) #define kIOMessageDeviceWillPowerOn iokit_common_msg(0x215) #define kIOMessageSystemHasPoweredOn iokit_common_msg(0x300) #define kIOMessageSystemPagingOff iokit_common_msg(0x255) #define kIOMessageSystemWillNotPowerOff iokit_common_msg(0x260) #define kIOMessageSystemWillNotSleep iokit_common_msg(0x290) #define kIOMessageSystemWillPowerOff iokit_common_msg(0x250) #define kIOMessageSystemWillPowerOn iokit_common_msg(0x320) #define kIOMessageSystemWillRestart iokit_common_msg(0x310) #define kIOMessageSystemWillSleep iokit_common_msg(0x280)

    Constants

    • kIOMessageCanDevicePowerOff

      kIOMessageCanDevicePowerOff

      Delivered to kIOAppPowerStateInterest clients of devices that implement their own idle timeouts. This message type is almost never used.

      Available in OS X v10.0 and later.

    • kIOMessageCanSystemPowerOff

      kIOMessageCanSystemPowerOff

      Available in OS X v10.0 and later.

    • kIOMessageCanSystemSleep

      kIOMessageCanSystemSleep

      Announces/Requests permission to proceed to system sleep. Delivered to in-kernel IOKit drivers via kIOGeneralInterest and kIOPriorityPowerStateInterest. Delivered to user clients of IORegisterForSystemPower.

      Available in OS X v10.0 and later.

    • kIOMessageDeviceHasPoweredOff

      kIOMessageDeviceHasPoweredOff

      IOService power mgt does not send kIOMessageDeviceHasPoweredOff.

      Available in OS X v10.7 and later.

    • kIOMessageDeviceHasPoweredOn

      kIOMessageDeviceHasPoweredOn

      Indicates the device has just moved to a higher power state. Sent to IOKit interest notification clients of type kIOAppPowerStateInterest and kIOGeneralInterest.

      Available in OS X v10.0 and later.

    • kIOMessageDeviceWillNotPowerOff

      kIOMessageDeviceWillNotPowerOff

      This IOKit interest notification is largely unused; it's not very interesting.

      Available in OS X v10.0 and later.

    • kIOMessageDeviceWillPowerOff

      kIOMessageDeviceWillPowerOff

      Indicates the device is about to move to a lower power state. Sent to IOKit interest notification clients of type kIOAppPowerStateInterest and kIOGeneralInterest.

      Available in OS X v10.0 and later.

    • kIOMessageDeviceWillPowerOn

      kIOMessageDeviceWillPowerOn

      IOService power mgt does not send kIOMessageDeviceWillPowerOn.

      Available in OS X v10.7 and later.

    • kIOMessageSystemHasPoweredOn

      kIOMessageSystemHasPoweredOn

      Announces that the system and its devices have woken up. Delivered to in-kernel IOKit drivers via kIOGeneralInterest and kIOPriorityPowerStateInterest. Delivered to user clients of IORegisterForSystemPower.

      Available in OS X v10.0 and later.

    • kIOMessageSystemPagingOff

      kIOMessageSystemPagingOff

      Indicates an imminent system shutdown, paging device now unavailable. Recipients have a limited amount of time to respond, otherwise the system will timeout and shutdown even without a response. Delivered to clients of registerPrioritySleepWakeInterest(). Never delivered to user space notification clients.

      Available in OS X v10.7 and later.

    • kIOMessageSystemWillNotPowerOff

      kIOMessageSystemWillNotPowerOff

      Available in OS X v10.0 and later.

    • kIOMessageSystemWillNotSleep

      kIOMessageSystemWillNotSleep

      Announces that the system has retracted a previous attempt to sleep; it follows kIOMessageCanSystemSleep. Delivered to in-kernel IOKit drivers via kIOGeneralInterest and kIOPriorityPowerStateInterest. Delivered to user clients of IORegisterForSystemPower.

      Available in OS X v10.0 and later.

    • kIOMessageSystemWillPowerOff

      kIOMessageSystemWillPowerOff

      Indicates an imminent system shutdown. Recipients have a limited amount of time to respond, otherwise the system will timeout and shutdown even without a response. Delivered to in-kernel IOKit drivers via IOService::systemWillShutdown(), and to clients of registerPrioritySleepWakeInterest(). Never delivered to user space notification clients.

      Available in OS X v10.0 and later.

    • kIOMessageSystemWillPowerOn

      kIOMessageSystemWillPowerOn

      Announces that the system is beginning to power the device tree; most devices are unavailable at this point.. Delivered to in-kernel IOKit drivers via kIOGeneralInterest and kIOPriorityPowerStateInterest. Delivered to user clients of IORegisterForSystemPower.

      Available in OS X v10.3 and later.

    • kIOMessageSystemWillRestart

      kIOMessageSystemWillRestart

      Indicates an imminent system restart. Recipients have a limited amount of time to respond, otherwise the system will timeout and restart even without a response. Delivered to in-kernel IOKit drivers via IOService::systemWillShutdown(), and to clients of registerPrioritySleepWakeInterest(). Never delivered to user space notification clients.

      Available in OS X v10.1 and later.

    • kIOMessageSystemWillSleep

      kIOMessageSystemWillSleep

      Announces that sleep is beginning. Delivered to in-kernel IOKit drivers via kIOGeneralInterest and kIOPriorityPowerStateInterest. Delivered to user clients of IORegisterForSystemPower.

      Available in OS X v10.0 and later.

    Import Statement