tcpserial.h

Go to the documentation of this file.

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

#ifndef TCP_SERIAL_H_
#define TCP_SERIAL_H_

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

#if SDH_USE_VCC
# include <sys/timeb.h>
# include <time.h>
# include <winsock.h>
#else
# include <sys/time.h>
#endif
#include <string>

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

#include "sdhexception.h"
#include "serialbase.h"
#include "basisdef.h"

#include "sdhlibrary_settings.h"

//----------------------------------------------------------------------
// Defines, enums, unions, structs,
//----------------------------------------------------------------------

NAMESPACE_SDH_START

//----------------------------------------------------------------------
// Global variables
//----------------------------------------------------------------------


//----------------------------------------------------------------------
// Function and class member declarations
//----------------------------------------------------------------------


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


class VCC_EXPORT cTCPSerial : public cSerialBase
{

protected:

    std::string tcp_adr;

    int tcp_port;

#if SDH_USE_VCC
    SOCKET fd;
#else
    int    fd;
    static const int INVALID_SOCKET = -1;
#endif
private:
    struct  timeval timeout_timeval;
    long    timeout_us;

public:
    static double const TIMEOUT_WAIT_FOR_EVER_S;
    static double const TIMEOUT_RETURN_IMMEDITELY_S;
    static long const   TIMEOUT_WAIT_FOR_EVER_US;
    static long const   TIMEOUT_RETURN_IMMEDITELY_US;

    cTCPSerial( char const* _tcp_adr, int _tcp_port, double _timeout )
        throw (cTCPSerialException*);

    void Open( void )
        throw (cTCPSerialException*);

    bool IsOpen( void )
        throw();

    void Close( void )
        throw (cTCPSerialException*);


    int write( char const *ptr, int len=0 )
        throw (cTCPSerialException*);

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

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

    virtual tErrorCode GetErrorNumber()
    {
#if SDH_USE_VCC
        return WSAGetLastError();
#else
        return errno;
#endif
    }
};
//======================================================================

NAMESPACE_SDH_END

#endif


//======================================================================
/*
  Here are some settings for the emacs/xemacs editor (and can be safely ignored):
  (e.g. to explicitely set C++ mode for *.h header files)

  Local Variables:
  mode:C++
  mode:ELSE
  End:
*/
//======================================================================