HSS1394.h

Go to the documentation of this file.

//
//-----------------------------------------------------------------------------

#ifndef _HSS1394_
#define _HSS1394_


#if defined(_WIN32)
#if defined(HSS1394_EXPORT_DLL)
#define HSS1394_CLASS_CONVENTION __declspec(dllexport)
#elif defined(HSS1394_IMPORT_DLL)
#define HSS1394_CLASS_CONVENTION __declspec(dllimport)
#else
#define HSS1394_CLASS_CONVENTION  // static import
#endif

#else // _WIN32

#define HSS1394_CLASS_CONVENTION  // static import

#endif // _WIN32


//*** Includes
//*****************************************************************************
#include <string>                       // STL string class
#include "HSS1394Types.h"


//*** Types
//*****************************************************************************
namespace hss1394 {

        // TNodeInfo
        //-------------------------------------------------------------------------
        typedef struct {
                std::string sName;                      
                uint64 uGUID;                           
                uint16 uProtocolVersion;        
        }TNodeInfo;
};


//*** Class declarations
//*****************************************************************************
namespace hss1394 {

        // Listener::
        //-----------------------------------------------------------------------------
        class HSS1394_CLASS_CONVENTION Listener {
                public:
                        virtual void Do(void) = 0;
        };


        // ChannelListener::
        //-----------------------------------------------------------------------------
        class HSS1394_CLASS_CONVENTION ChannelListener {
                public:
                        // :: Process is called when data has arrived. The arguments present
                        virtual void Process(const uint8 *pBuffer, uint uBufferSize) { }

                        // ::Disconnected is called when the node attached to this channel becomes
                        virtual void Disconnected(void) { }

                        // ::Reconnected is called when the node attached to this channel becomes
                        virtual void Reconnected(void) { }
        };


        // Channel::
        //-----------------------------------------------------------------------------
        class HSS1394_CLASS_CONVENTION Channel {
                public:
                        virtual void Stop(void) = 0;

                        virtual void Restart(void) = 0;

                        virtual void Flush(void) = 0;

                        virtual void GetNodeInfo(TNodeInfo &tNodeInfo) = 0;

                        virtual uint SendChannelBytes(const uint8 *pBuffer, uint uBufferSize, bool bForce = true) = 0;

                        virtual uint SendChannelEcho(const uint8 *pBuffer, uint uBufferSize) = 0;

                        virtual uint GetRetries(void) = 0;

                        virtual uint ReceiveChannelBytes(uint8 *pBuffer, uint uBufferSize) = 0;

                        virtual bool InstallChannelListener(ChannelListener *pListener) = 0;

                        virtual bool ChannelListenerExists(void) = 0;

                        virtual uint SendUserControl(uint8 uUserTag, const uint8 *pUserData, uint uDataBytes) = 0;
        };


        // Node::
        //-----------------------------------------------------------------------------
        class HSS1394_CLASS_CONVENTION Node {
                protected:
                        static Node *mspInstance;       

                        // Dispose of class and reclaim all resources. Closes all channels.
                        // All channel objects created by the interface will be destroyed. It
                        // is up to the caller to clean up any pointers remaining to channel
                        // objects.
                        virtual ~Node() { };
                
                public:
                        static Node *Instance(void);

                        static void Shutdown(void);

                        virtual void InstallConnectionListener(Listener *pListener) = 0;

                        virtual uint GetNodeCount(void) = 0;

                        virtual bool GetNodeInfo(TNodeInfo &tNodeInfo, uint uNode, bool *pbAvailable = NULL, bool *pbInstalled = NULL) = 0;

                        virtual Channel *OpenChannel(uint uNode) = 0;

                        virtual bool ReleaseChannel(Channel *pChannel) = 0;
        };


};      // namespace hss1394


#endif // _HSS1394_