struct Core::Usb::IUsbHidManager

Overview

#include <coreusbhid.h>

struct IUsbHidManager: public Core::IPropertyHandler
{
    // fields

    static const InterfaceID kIID = FOUR_CHAR_ID('U', 'H', 'I', 'M');

    // methods

    virtual ErrorCode startup() = 0;
    virtual ErrorCode shutdown() = 0;

    virtual ErrorCode registerObserver(
        IUsbHidObserver* observer,
        const UsbIdFilter& filter
    ) = 0;

    virtual ErrorCode unregisterObserver(IUsbHidObserver* observer) = 0;

    virtual ErrorCode openDevice(
        IUsbHidInstance*& device,
        const UsbDeviceInfo& info
    ) = 0;

    virtual ErrorCode closeDevice(IUsbHidInstance* device) = 0;
};

Inherited Members

public:
    // fields

    static const InterfaceID kIID = 0;

    // methods

    virtual void setProperty(const Property& value) = 0;
    virtual void getProperty(Property& value) = 0;
    virtual void release() = 0;

Detailed Documentation

Methods

virtual ErrorCode startup() = 0

This method must be called before any other method in the IUsbHidManager interface.

virtual ErrorCode shutdown() = 0

Release all allocated memory owned by the IUsbHidManager.

virtual ErrorCode registerObserver(
    IUsbHidObserver* observer,
    const UsbIdFilter& filter
) = 0

Registers an observer to receive notifications about USB HID devices.

The IUsbHidManager will call onDeviceAdded() for all currently available devices that match the provided filter. If no filter is provided, it will call onDeviceAdded() for all available devices.

virtual ErrorCode unregisterObserver(IUsbHidObserver* observer) = 0

Unregister an observer.

virtual ErrorCode openDevice(
    IUsbHidInstance*& device,
    const UsbDeviceInfo& info
) = 0

Open a device for writing and reading data.

The caller is responsible for closing the device using closeDevice() when done.

virtual ErrorCode closeDevice(IUsbHidInstance* device) = 0

Close a device.