serxinterface.h

#ifndef _SerXInterface_
#define _SerXInterface_
 
#define SerXInterface_Name "com.bisque.TheSkyX.staticlibs.serx.SerXInterface/1.0"
 
class SerXInterface
{
public:
        SerXInterface(){setAbortTimeout(false);}
        virtual ~SerXInterface(){}
 
        enum Parity  
        {
                B_NOPARITY,             
                B_ODDPARITY,    
                B_EVENPARITY,   
                B_MARKPARITY,   
                B_SPACEPARITY   
        };
 
public:
        virtual int open(const char          * pszPort, 
                   const unsigned long & dwBaudRate = 9600, 
                   const Parity        & parity = B_NOPARITY, 
                   const char          * pszSession = 0) = 0;
 
        virtual int close() = 0;
 
        virtual bool isConnected(void) const = 0;
 
        virtual int flushTx(void) = 0;
 
        virtual int purgeTxRx(void) = 0;
 
        virtual int waitForBytesRx(const int& nNumber, 
                             const int& nTimeOutMilli) = 0;
 
        virtual int readFile(void* lpBuf, 
                       const unsigned long dwTot, 
                       unsigned long& dwRed, 
                                                                       const unsigned long& dwTimeOut = 1000) = 0;
 
        virtual int writeFile(void* lpBuf,
                        const unsigned long& dwTot, 
                        unsigned long& dwRote) = 0;
 
        virtual int bytesWaitingRx(int &nBytesWaiting) = 0;
 
        virtual void abortTimeout(){setAbortTimeout(true);}
        virtual bool didAbortTimeout() const {return m_bAbortTimeout;}
        virtual void setAbortTimeout(const bool& bYes) {m_bAbortTimeout=bYes;}
 
private:
        bool m_bAbortTimeout;
};
 
#endif // _SerXInterface_
 
//Linux wants a 'newline' at the end of every source file - don't delete the one after this line