rs232-vcc.h

Go to the documentation of this file.

//======================================================================
//======================================================================

#ifndef RS232_VCC_h
#define RS232_VCC_h

#include "sdhlibrary_settings.h"

#if SDH_USE_VCC
# pragma warning(disable : 4996)
# pragma warning(disable : 4290)
# pragma once
#endif

//----------------------------------------------------------------------
// System Includes - include with <>
//----------------------------------------------------------------------

#include <windows.h>

//----------------------------------------------------------------------
// Project Includes - include with ""
//----------------------------------------------------------------------

#include "sdhexception.h"
#include "serialbase.h"
#include "sdhlibrary_settings.h"


//#define RS_232_TEST
#define SDH_RS232_VCC_ASYNC 0

NAMESPACE_SDH_START

class VCC_EXPORT cRS232Exception: public cSerialBaseException
{
public:
    cRS232Exception( cMsg const & _msg )
    : cSerialBaseException( "cRS232Exception", _msg )
    {}
};

class VCC_EXPORT cRS232 : public cSerialBase
{
private:
#ifndef RS_232_TEST
    HANDLE       _hCOM;
#endif
#if SDH_RS232_VCC_ASYNC
    OVERLAPPED   o;
#endif
    COMMTIMEOUTS comm_timeouts;
    long         read_timeout_us; // for caching the read timeout in ms

protected:
    int port;

    unsigned long baudrate;


public:
    cRS232( int _port, unsigned long _baudrate, double _timeout, char const* _device_format_string = "" );
    ~cRS232(void);

    void Open( void )
    throw (cRS232Exception*);
    void Close( void )
    throw (cRS232Exception*);

    virtual void SetTimeout( double _timeout )
        throw (cSerialBaseException*);

#ifndef RS_232_TEST
    bool IsOpen()
    throw()
    { return _hCOM != NULL; }
#else
    bool IsOpen() { return true; }
#endif
    int write( char const *ptr, int len=0 )
    throw (cRS232Exception*);

    ssize_t Read( void *data, ssize_t size, long timeout_us, bool return_on_less_data )
    throw (cRS232Exception*);

    char* readline(char* line, int size, char* eol, bool return_on_less_data)
    throw (cRS232Exception*);

    virtual bool UseCRC16()
    {
        return true;
    }
};

NAMESPACE_SDH_END

#endif