IOHIDDeviceQueueInterface

Объект Вы используете для доступа к очереди HID от пространства пользователя, возвращенного версией 1.5 IOHIDFamily.

Функции, перечисленные здесь, будут работать с любой версией IOHIDDeviceQueueInterface. Когда необходимо отслеживать все значения входного элемента, а не просто новое, это поведение полезно.

Примечание: Если будет изменение в значении, абсолютные значения элемента (на основе фиксированного источника) будут только помещены в очередь.

Наследование

Не применимый

Соответствует

Не применимый

Оператор импорта

Не применимый не применимый

Прочие условия


    
    addElement
    - addElement

Добавляет элемент к этому экземпляру IOHIDDeviceQueueInterface.

Объявление

C++

IOReturn ( *addElement)( void *self, IOHIDElementRef element, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`element`	IOHIDElementRef, ссылающийся на элемент, который будет добавлен к очереди.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.


    
    containsElement
    - containsElement

Определяет, был ли элемент добавлен к этому экземпляру IOHIDDeviceQueueInterface.

Объявление

C++

IOReturn ( *containsElement)( void *self, IOHIDElementRef element, Boolean *pValue, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`element`	IOHIDElementRef, ссылающийся на элемент, чтобы быть быть найденным в очереди.
`pValue`	Указатель на булевскую переменную, чтобы возвратиться, был ли элемент найден в очереди.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.


    
    copyNextValue
    - copyNextValue

Исключает сохраненную копию из очереди значения элемента от главы IOHIDDeviceQueueInterface.

Объявление

C++

IOReturn ( *copyNextValue)( void *self, IOHIDValueRef *pValue, uint32_t timeout, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`pValue`	Указатель на IOHIDValueRef для возврата значения во главе очереди.
`timeout`	Тайм-аут в миллисекундах прежде, чем прервать попытку исключить значение из очереди от главы очереди.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

Возвращаемое значение

Возвраты kIOReturnSuccess в случае успеха, kIOReturnUnderrun, если данные являются unavailble или kern_return_t, если неуспешный.

Обсуждение

Поскольку значение является сохраненной копией, это до вызывающей стороны для выпуска значения с помощью CFRelease. Используйте с setValueCallback, чтобы избежать опрашивать очередь относительно данных.


    
    getAsyncEventSource
    - getAsyncEventSource

Получает источник события для этого экземпляра IOHIDDeviceQueueInterface.

Объявление

C++

IOReturn ( *getAsyncEventSource)( void *self, CFTypeRef *pSource);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`pSource`	Указатель на CFType для возврата источника события цикла выполнения.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.

Обсуждение

Возвращенный источник события может иметь тип CFRunLoopSourceRef или CFRunLoopTimerRef.


    
    getDepth
    - getDepth

Получает глубину очереди для этого экземпляра IOHIDDeviceQueueInterface.

Объявление

C++

IOReturn ( *getDepth)( void *self, uint32_t *pDepth);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`pDepth`	Указатель на uint32_t для получения числа элементов, которое может быть обслужено очередью.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.


    
    removeElement
    - removeElement

Удаляет элемент из этого экземпляра IOHIDDeviceQueueInterface.

Объявление

C++

IOReturn ( *removeElement)( void *self, IOHIDElementRef element, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`element`	IOHIDElementRef, ссылающийся на элемент, который будет удален из очереди.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.


    
    setDepth
    - setDepth

Устанавливает глубину для этого экземпляра IOHIDDeviceQueueInterface.

Объявление

C++

IOReturn ( *setDepth)( void *self, uint32_t depth, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceTransactionInterface.
`depth`	Максимальное количество элементов в очереди перед самыми старыми элементами в очереди начинает теряться.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.

Обсуждение

Независимо от размера значения элемента очередь гарантирует, что будут обслуживаться n=depth элементы.


    
    setValueAvailableCallback
    - setValueAvailableCallback

Обратный вызов наборов, который будет использоваться, когда переходы очереди, чтобы неопустеть.

Объявление

C++

IOReturn ( *setValueAvailableCallback)( void *self, IOHIDCallback callback, void *context);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`callback`	Обратный вызов типа IOHIDCallback, который будет использоваться, когда данные помещаются в очередь.
`context`	Указатель на данные, которые будут переданы обратному вызову.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.

Обсуждение

Для использования асинхронного поведения источник события получил использование getAsyncEventSource, должен быть добавлен к циклу выполнения.


    
    запустить
    - запустить

Запускает поставку значения элемента очереди.

Объявление

C++

IOReturn ( *start)( void *self, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.


    
    остановиться
    - остановиться

Элемент остановок оценивает поставку очереди.

Объявление

C++

IOReturn ( *stop)( void *self, IOOptionBits options);

Параметры

`self`	Указатель на IOHIDDeviceQueueInterface.
`options`	Зарезервированный для будущего использования. Проигнорированный в текущей реализации. Обнулить.

Возвращаемое значение

Возвраты kIOReturnSuccess, если успешный или kern_return_t, если неуспешный.