devicenotifier.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#if !defined (__DEVICE_NOTIFIER_H__)
    #define __DEVICE_NOTIFIER_H__

    #include <CoreFoundation/CoreFoundation.h>
    #include <Carbon/Carbon.h>
    #include <IOKit/IOMessage.h>
    #include <IOKit/usb/IOUSBLib.h>
    #include <vector>
    #include <map>
    #include <list>

    #define kAJADeviceInitialOpen   0xAA1
    #define kAJADeviceTerminate     0xAA2


    typedef void (*DeviceClientCallback)(unsigned long message, void * refcon);


    class DeviceNotifier
    {
    //  Instance Methods
    public:
                                        
                                                DeviceNotifier (DeviceClientCallback callback, void *refcon);
        virtual                                 ~DeviceNotifier ();
        virtual bool                            Install (CFMutableDictionaryRef dict = NULL);
        virtual void                            Uninstall ();
        
        // alternate way to set callback
        virtual void                            SetCallback (DeviceClientCallback callback, void *refcon);
        
    protected:
        // override these
        inline virtual CFMutableDictionaryRef   CreateMatchingDictionary ()                                 {return NULL;}
        virtual CFMutableDictionaryRef          CreateMatchingDictionary (CFStringRef deviceDriverName);

        // callbacks
        virtual void                            DeviceAdded (io_iterator_t iterator);
        virtual void                            DeviceRemoved (io_iterator_t iterator);
        virtual void                            DeviceChanged (io_service_t unitService, natural_t messageType, void* message);

        // util
        virtual void                            AddGeneralInterest (io_object_t service);

    //  Class Methods
    public:
        //static void                           SetDebugLogging (const uint64_t inWhichUserClientCommands);
        static std::string                      MessageTypeToStr (const natural_t messageType);

        //  Non-Public Class Methods
        static void                             DeviceAddedCallback (   DeviceNotifier* thisObject, io_iterator_t iterator);
        static void                             DeviceRemovedCallback ( DeviceNotifier* thisObject, io_iterator_t iterator);
        static void                             DeviceChangedCallback ( DeviceNotifier *    thisObject,
                                                                        io_service_t        unitService,
                                                                        natural_t           messageType,
                                                                        void *              message);
    //  Instance Data
    protected:
        void *                          m_refcon;
        DeviceClientCallback            m_clientCallback;
        mach_port_t                     m_masterPort;
        IONotificationPortRef           m_notificationPort;
        CFMutableDictionaryRef          m_matchingDictionary;
        std::list<io_object_t>          m_deviceMatchList;
        std::list<io_object_t>          m_deviceInterestList;

    };  //  DeviceNotifier


    class KonaNotifier : public DeviceNotifier
    {
    public:
        inline                  KonaNotifier (DeviceClientCallback callback, void *refcon)
                                    :   DeviceNotifier (callback, refcon)   {}
        inline virtual          ~KonaNotifier ()                            {}
        virtual bool            Install (CFMutableDictionaryRef dict = NULL);
    };

#endif  //  __DEVICE_NOTIFIER_H__