AsyncSerial.h

Go to the documentation of this file.

 
#ifndef SERIAL_INCLUDED
#define SERIAL_INCLUDED
 
 
/****************************************************************************
 *
 * System Includes
 *
 ****************************************************************************/
 
#include <sigc++/sigc++.h>
#include <termios.h>
#include <unistd.h>
 
#include <string>
 
 
/****************************************************************************
 *
 * Project Includes
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Local Includes
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Forward declarations
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Namespace
 *
 ****************************************************************************/
 
namespace Async
{
 
 
/****************************************************************************
 *
 * Forward declarations of classes inside of the declared namespace
 *
 ****************************************************************************/
 
class FdWatch;
class SerialDevice;
  
 
/****************************************************************************
 *
 * Defines & typedefs
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Exported Global Variables
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Class definitions
 *
 ****************************************************************************/
 
class Serial : public sigc::trackable
{
  public:
    typedef enum
    {
      PARITY_NONE,  
      PARITY_EVEN,  
      PARITY_ODD    
    } Parity;
 
    typedef enum
    {
      FLOW_NONE,    
      FLOW_HW,      
      FLOW_XONOFF   
    } Flow;
    
    typedef enum
    {
      PIN_NONE, 
      PIN_RTS,  
      PIN_DTR,  
      PIN_CTS,  
      PIN_DSR,  
      PIN_DCD,  
      PIN_RI    
    } Pin;
    
    static const int READ_BUFSIZE = 1024;
        
 
    explicit Serial(const std::string& serial_port);
  
    ~Serial(void);
    
    bool setParams(int speed, Parity parity, int bits, int stop_bits,
                   Flow flow);
    
    bool open(bool flush=false);
    
    bool close(void);
    
    int write(const char *buf, size_t count)
    {
      return ::write(fd, buf, count);
    }
 
    bool setCanonical(bool canonical);
    
    bool stopInput(bool stop);
 
    bool setPin(Pin pin, bool set);
    
    bool getPin(Pin pin, bool &is_set);
 
    sigc::signal<void, char*, int> charactersReceived;
    
      
  protected:
    
  private:    
    const std::string   serial_port;
    bool                canonical;
    
    int                 fd;
    struct termios      port_settings;
    SerialDevice        *dev;
    
 
};  /* class Serial */
 
 
} /* namespace */
 
#endif /* SERIAL_INCLUDED */
 
 
 
/*
 * This file has not been truncated
 */