serial/serialdefs.h

   1 /***************************************************************************//**
   2  * Project Name : quicksms
   3  *
   4  * \file serialdefs.h this file contains some enums used by CSerialPort.
   5  * \package quicksms
   6  ******************************************************************************/
   7 #ifndef SERIALDEFS_H
   8 #define SERIALDEFS_H
   9
  10 namespace serial
  11 {
  12
  13   /*********************************************************************//**
  14    * \brief parity.
  15    *
  16    * Use it to select correct port parity checking.
  17    ***********************************************************************/
  18
  19   enum Parity
  20   {
  21     PAR_NONE, ///< no parity checking
  22     PAR_EVEN, ///< 'even' parity checking
  23     PAR_ODD ///< 'odd' parity checking
  24   };//Parity
  25
  26   enum Baudrate
  27   {
  28     BAUD_DEFAULT
  29   };
  30
  31
  32
  33  /*********************************************************************//**
  34   * \brief flow control.
  35   *
  36   * Used to select port flow control
  37   *
  38   ************************************************************************/
  39   enum FlowControl
  40   {
  41     FLOW_NONE, ///< no flow control
  42     FLOW_SOFTWARE, ///< XON/XOFF flow control
  43     FLOW_HARDWARE ///< hardware flow control
  44   };//FlowControl
  45
  46   /*********************************************************************//**
  47    * \brief port status.
  48    *
  49    * this enum is used to indicate port state. Constant names are
  50    * self-explainable.
  51    ************************************************************************/
  52   enum Status
  53   {
  54     STAT_OK, ///< everything's correct
  55     STAT_BUSY, ///< an r/w operation is in progress
  56     STAT_IO_ERROR, ///< I/O error occured
  57     STAT_FILE_ALREADY_OPEN, ///< port is already open, maybe by another app, or you called open() twice?
  58     STAT_FILE_NOT_FOUND, ///< port name / path is incorrect.
  59     STAT_TIMEOUT, ///< a read / write / open timeout occured
  60     STAT_UNKNOWN ///< port uninitalized or in unknown state
  61   };//Status
  62
  63
  64  /*********************************************************************//**
  65   * \brief pointer to read callback function
  66   * \param[in] pSize how many bytes are available?
  67   * \param[in,out] pBuffer this points to recieved data
  68   *
  69   * if callback function is non-zero, then we can use it
  70   * to immediately process incoming data as soon as it becomes available
  71   *
  72   ************************************************************************/
  73   typedef int (*ReadCallback)(void* pBuffer, int &pSize);
  74
  75 };//serial
  76
  77 #endif //SERIALDEFS_H