Mac OS X Reference Library Apple Developer
Search

IOHIDEventService.h

Includes:

Overview

Use the links in the table of contents to the left to access the documentation.



Classes

IOHIDPointing


Functions

handleClose

Handle a client close on the interface.

handleIsOpen

Query whether a client has an open on the interface.

handleOpen

Handle a client open on the interface.

handleStart

Prepare the hardware and driver to support I/O operations.

handleStop

Quiesce the hardware and stop the driver.


handleClose


Handle a client close on the interface.


virtual void handleClose(
    IOService *client,
    IOOptionBits options);  
Parameters
client

The client object that requested the close.

options

Options passed to IOService::close().

Discussion

This method is called by IOService::close() with the arbitration lock held. This method will in turn call handleClientClose() to notify interested subclasses about the client close. If this represents the last close, then the interface will also close the controller before this method returns. The controllerWillClose() method will be called before closing the controller. Subclasses should not override this method.


handleIsOpen


Query whether a client has an open on the interface.


virtual bool handleIsOpen(
    const IOService *client) const;  
Return Value

true if the specified client, or any client if none (0) is specified, presently has an open on this object.

Discussion

This method is always called by IOService with the arbitration lock held. Subclasses should not override this method.


handleOpen


Handle a client open on the interface.


virtual bool handleOpen(
    IOService *client, 
    IOOptionBits options, 
    void *argument);  
Parameters
client

The client object that requested the open.

options

Options passed to IOService::open().

argument

Argument passed to IOService::open().

Return Value

true to accept the client open, false otherwise.

Discussion

This method is called by IOService::open() with the arbitration lock held, and must return true to accept the client open. This method will in turn call handleClientOpen() to qualify the client requesting the open.


handleStart


Prepare the hardware and driver to support I/O operations.


virtual bool handleStart(
    IOService *provider );  
Parameters
provider

The provider argument passed to start().

Return Value

True on success, or false otherwise. Returning false will cause start() to fail and return false.

Discussion

IOHIDEventService will call this method from start() before any I/O operations are issued to the concrete subclass. Methods such as getReportElements() are only called after handleStart() has returned true. A subclass that overrides this method should begin its implementation by calling the version in super, and then check the return value.


handleStop


Quiesce the hardware and stop the driver.


virtual void handleStop(
    IOService *provider );  
Parameters
provider

The provider argument passed to stop().

Discussion

IOHIDEventService will call this method from stop() to signal that the hardware should be quiesced and the driver stopped. A subclass that overrides this method should end its implementation by calling the version in super.

Globals

_reserved
reserved

_reserved


Discussion

Reserved for future use. (Internal use only)

See Also


reserved


Discussion

Reserved for future use. (Internal use only)

See Also

 

Did this document help you? Yes It's good, but... Not helpful...

Last Updated: 2010-07-29