|
ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference
|
IOHIDQueue.h |
| Includes: |
<CoreFoundation/CoreFoundation.h> <IOKit/hid/IOHIDBase.h> |
IOHIDQueue defines an object used to queue values from input parsed items (IOHIDElement) contained within a Human Interface Device (HID) object. This object is useful when you need to keep track of all values of an input element, rather than just the most recent one. IOHIDQueue is a CFType object and as such conforms to all the conventions expected such object.
IOHIDQueue should be considered optional and is only useful for working with complex input elements. These elements include those whose length are greater than sizeof(CFIndex) or elements that are duplicate items. Whenever possible please defer to using IOHIDManagerRegisterInputValueCallback or IOHIDDeviceRegisterInputValueCallback.
Note:Absolute element values (based on a fixed origin) will only be placed on a queue if there is a change in value.
This documentation assumes that you have a basic understanding of the material contained in Accessing Hardware From Applications For definitions of I/O Kit terms used in this documentation, such as matching dictionary, family, and driver, see the overview of I/O Kit terms and concepts in the "Device Access and the I/O Kit" chapter of Accessing Hardware From Applications.
This documentation also assumes you have read Human Interface Device & Force Feedback. Please review documentation before using this reference.
All of the information described in this document is contained in the header file IOHIDQueue.h found at /System/Library/Frameworks/IOKit.framework/Headers/hid/IOHIDQueue.h.
Adds an element to the queue
Queries the queue to determine if elemement has been added.
Dequeues a retained copy of an element value from the head of an IOHIDQueue.
Dequeues a retained copy of an element value from the head of an IOHIDQueue. This method will block until either a value is available or it times out.
Creates an IOHIDQueue object for the specified device.
Obtain the depth of the queue.
Obtain the device associated with the queue.
Returns the type identifier of all IOHIDQueue instances.
Sets callback to be used when the queue transitions to non-empty.
Removes an element from the queue
Schedules queue with run loop.
Sets the depth of the queue. @disussion Set the appropriate depth value based on the number of elements contained in a queue.
Starts element value delivery to the queue.
Stops element value delivery to the queue.
Unschedules queue with run loop.
IOHIDQueueAddElement |
Adds an element to the queue
CF_EXPORT void IOHIDQueueAddElement( IOHIDQueueRef queue, IOHIDElementRef element) ;
queueIOHIDQueue object to be modified.
elementElement to be added to the queue.
IOHIDQueueContainsElement |
Queries the queue to determine if elemement has been added.
CF_EXPORT Boolean IOHIDQueueContainsElement( IOHIDQueueRef queue, IOHIDElementRef element) ;
queueIOHIDQueue object to be queried.
elementElement to be queried.
Returns true or false depending if element is present.
IOHIDQueueCopyNextValue |
Dequeues a retained copy of an element value from the head of an IOHIDQueue.
CF_EXPORT IOHIDValueRef IOHIDQueueCopyNextValue( IOHIDQueueRef queue) ;
queueIOHIDQueue object to be queried.
Returns valid IOHIDValueRef if data is available.
Because the value is a retained copy, it is up to the caller to release the value using CFRelease. Use with setValueCallback to avoid polling the queue for data.
IOHIDQueueCopyNextValueWithTimeout |
Dequeues a retained copy of an element value from the head of an IOHIDQueue. This method will block until either a value is available or it times out.
CF_EXPORT IOHIDValueRef IOHIDQueueCopyNextValueWithTimeout( IOHIDQueueRef queue, CFTimeInterval timeout) ;
queueIOHIDQueue object to be queried.
timeoutTimeout before aborting an attempt to dequeue a value from the head of a queue.
Returns valid IOHIDValueRef if data is available.
Because the value is a retained copy, it is up to the caller to release the value using CFRelease. Use with setValueCallback to avoid polling the queue for data.
IOHIDQueueCreate |
Creates an IOHIDQueue object for the specified device.
CF_EXPORT IOHIDQueueRef IOHIDQueueCreate( CFAllocatorRef allocator, IOHIDDeviceRef device, CFIndex depth, IOOptionBits options) ;
allocatorAllocator to be used during creation.
deviceIOHIDDevice object
depthThe number of values that can be handled by the queue.
optionsReserved for future use.
Returns a new IOHIDQueueRef.
Take care in specifying an appropriate depth to prevent dropping events.
IOHIDQueueGetDepth |
Obtain the depth of the queue.
CF_EXPORT CFIndex IOHIDQueueGetDepth( IOHIDQueueRef queue) ;
queueIOHIDQueue to be queried.
Returns the queue depth.
IOHIDQueueGetDevice |
Obtain the device associated with the queue.
CF_EXPORT IOHIDDeviceRef IOHIDQueueGetDevice( IOHIDQueueRef queue) ;
queueIOHIDQueue to be queried.
Returns the a reference to the device.
IOHIDQueueGetTypeID |
Returns the type identifier of all IOHIDQueue instances.
CF_EXPORT CFTypeID IOHIDQueueGetTypeID( void) ;
IOHIDQueueRegisterValueAvailableCallback |
Sets callback to be used when the queue transitions to non-empty.
CF_EXPORT void IOHIDQueueRegisterValueAvailableCallback( IOHIDQueueRef queue, IOHIDCallback callback, void *context) ;
queueIOHIDQueue object to be modified.
callbackCallback of type IOHIDCallback to be used when data is placed on the queue.
contextPointer to data to be passed to the callback.
In order to make use of asynchronous behavior, the queue needs to be scheduled with the run loop.
IOHIDQueueRemoveElement |
Removes an element from the queue
CF_EXPORT void IOHIDQueueRemoveElement( IOHIDQueueRef queue, IOHIDElementRef element) ;
queueIOHIDQueue object to be modified.
elementElement to be removed from the queue.
IOHIDQueueScheduleWithRunLoop |
Schedules queue with run loop.
CF_EXPORT void IOHIDQueueScheduleWithRunLoop( IOHIDQueueRef queue, CFRunLoopRef runLoop, CFStringRef runLoopMode) ;
queueIOHIDQueue object to be modified.
runLoopRunLoop to be used when scheduling any asynchronous activity.
runLoopModeRun loop mode to be used when scheduling any asynchronous activity.
Formally associates queue with client's run loop. Scheduling this queue with the run loop is necessary before making use of any asynchronous APIs.
IOHIDQueueSetDepth |
Sets the depth of the queue. @disussion Set the appropriate depth value based on the number of elements contained in a queue.
CF_EXPORT void IOHIDQueueSetDepth( IOHIDQueueRef queue, CFIndex depth) ;
queueIOHIDQueue object to be modified.
depthThe new queue depth.
IOHIDQueueStart |
Starts element value delivery to the queue.
CF_EXPORT void IOHIDQueueStart( IOHIDQueueRef queue) ;
queueIOHIDQueue object to be started.
IOHIDQueueStop |
Stops element value delivery to the queue.
CF_EXPORT void IOHIDQueueStop( IOHIDQueueRef queue) ;
queueIOHIDQueue object to be stopped.
IOHIDQueueUnscheduleFromRunLoop |
Unschedules queue with run loop.
CF_EXPORT void IOHIDQueueUnscheduleFromRunLoop( IOHIDQueueRef queue, CFRunLoopRef runLoop, CFStringRef runLoopMode) ;
queueIOHIDQueue object to be modified.
runLoopRunLoop to be used when scheduling any asynchronous activity.
runLoopModeRun loop mode to be used when scheduling any asynchronous activity.
Formally disassociates queue with client's run loop.
IOHIDQueueRef |
typedef struct __IOHIDQueue * IOHIDQueueRef;
This is the type of a reference to the IOHIDQueue.
|
Last Updated: 2009-02-23