cn_comm.h

我用VC编的一个小小的串口应用程序,里面用到了一个库CComm。挺简单的。

/*
这个版本是12月份的稳定版本， 有不少网友试用过， 也给我不少宝贵的意见， 
因为较稳定， 也适合大多数应用场合， 不会有太多的改动，故我决定版本定位1.0;欢迎来信反馈;
修正内容:
Read()函数不在读取内容后加'\0';
新增ReadString()函数在读取内容后加'\0';
这个修改可能会引起原来的代码出错;
其他为零星的修改, 且不会影响原来的代码;
 if(Stat.cbInQue >= _dwNotifyNum) 这里原来为> 改为 >=
*/
/*
Comm Base Library(WIN98/NT/2000) ver 1.0

Compile by： BC++ 5; C++ BUILDER 4, 5, 6, X; VC++ 5, 6; VC.NET;  GCC;

copyright(c) 2004.5 - 2004.12  llbird [e-mail]

注: 作为基础代码, 为保证源码的正确性, 请勿修改以下代码, 有问题可直接联系, 可以继承扩展你所需要的功能
*/

#ifndef _CN_COMM_H_
#define _CN_COMM_H_

#pragma warning(disable: 4530)
#pragma warning(disable: 4786)
#pragma warning(disable: 4800)

#include <assert.h>
#include <stdio.h>
#include <windows.h>

//送到窗口的消息  WPARAM 端口号
#define ON_COM_RECEIVE WM_USER + 618    
#define ON_COM_CTS     WM_USER + 619 //LPARAM 1 valid 
#define ON_COM_DSR     WM_USER + 621 //LPARAM 1 valid
#define ON_COM_RING    WM_USER + 623
#define ON_COM_RLSD    WM_USER + 624
#define ON_COM_BREAK   WM_USER + 625
#define ON_COM_TXEMPTY WM_USER + 626
#define ON_COM_ERROR   WM_USER + 627 //LPARAM save Error ID
#define DEFAULT_COM_MASK_EVENT  EV_RXCHAR | EV_ERR | EV_CTS | EV_DSR | EV_BREAK | EV_TXEMPTY | EV_RING | EV_RLSD

class cnComm    
{
public:

//------------------------------Construction-----------------------------------
//第1个参数为是否在打开串口时启动监视线程， 第2个参数为IO方式 阻塞方式（0）/ 异步重叠方式（默认）
 cnComm(bool fAutoBeginThread = true, DWORD dwIOMode = FILE_FLAG_OVERLAPPED)
  : _dwIOMode(dwIOMode), _fAutoBeginThread(fAutoBeginThread)
 {
  Init(); 
 }

 virtual ~cnComm()
 {
  Close(); 
  UnInit();
 }

//----------------------------------Attributes----------------------------------
 //判断串口是或打开
 inline bool IsOpen()
 {
  return _hCommHandle != INVALID_HANDLE_VALUE;
 }
 //判断串口是或打开
 operator bool ()
 {
  return _hCommHandle != INVALID_HANDLE_VALUE;
 }
 //获得串口句炳
 inline HANDLE GetHandle()
 {
  return _hCommHandle;
 }
 //获得串口句炳
 operator HANDLE()
 {
  return _hCommHandle;
 }
 //获得串口参数 DCB
 DCB *GetState()
 {
  return IsOpen() && ::GetCommState(_hCommHandle, &_DCB) ? &_DCB : NULL;
 }
 //设置串口参数 DCB
 bool SetState(DCB *pdcb = NULL)
 {
  return IsOpen() ? ::SetCommState(_hCommHandle, pdcb == NULL ? &_DCB : pdcb) == TRUE : false;
 }
 //设置串口参数：波特率，停止位，等 支持设置字符串 "9600, 8, n, 1"
 bool SetState(char *szSetStr) 
 {
  if(IsOpen())
  {
   if(!::GetCommState(_hCommHandle, &_DCB))
    return false;
   if(!::BuildCommDCB(szSetStr, &_DCB))
    return false;
   return ::SetCommState(_hCommHandle, &_DCB) == TRUE;
  }
  return false;
 }
 //设置串口参数：波特率，停止位，等
 bool SetState(DWORD dwBaudRate, DWORD dwByteSize = 8, DWORD dwParity = NOPARITY, DWORD dwStopBits = ONESTOPBIT)
 {
  if(IsOpen())
  {
   if(!::GetCommState(_hCommHandle, &_DCB))
    return false;
   _DCB.BaudRate = dwBaudRate;
      _DCB.ByteSize = (unsigned char)dwByteSize;
      _DCB.Parity   = (unsigned char)dwParity;
   _DCB.StopBits = (unsigned char)dwStopBits;
   return ::SetCommState(_hCommHandle, &_DCB) == TRUE;
  }
  return false;
 }
 //获得超时结构
 LPCOMMTIMEOUTS GetTimeouts(void)
 {
  return IsOpen() && ::GetCommTimeouts(_hCommHandle, &_CO) ? &_CO : NULL;
 }
 //设置超时
 bool SetTimeouts(LPCOMMTIMEOUTS lpCO)
 {
  return IsOpen() ? ::SetCommTimeouts(_hCommHandle, lpCO) == TRUE : false;
 }
 //设置串口的I/O缓冲区大小
 bool SetBufferSize(DWORD dwInputSize, DWORD dwOutputSize)
 {
  return IsOpen() ? ::SetupComm(_hCommHandle, dwInputSize, dwOutputSize) == TRUE : false; 
 }
 //关联消息的窗口句柄
 inline void SetWnd(HWND hWnd)
 {
  assert(::IsWindow(hWnd));
  _hNotifyWnd = hWnd;
 }
 //设定发送通知, 接受字符最小值
 inline void SetNotifyNum(DWORD dwNum)
 {
  _dwNotifyNum = dwNum;
 }
 //线程是否运行
 inline bool IsThreadRunning()
 {
  return _hThreadHandle != NULL;
 }
 //获得线程句柄
 inline HANDLE GetThread()
 {
  return _hThreadHandle;
 }
 //设置要监视的事件， 打开前设置有效
 void SetMaskEvent(DWORD dwEvent = DEFAULT_COM_MASK_EVENT)
 {
  _dwMaskEvent = dwEvent;
 }
 //获得读缓冲区的字符数
 int GetInputSize()
 {
  COMSTAT Stat;
  DWORD dwError;

  return ::ClearCommError(_hCommHandle, &dwError, &Stat) ? Stat.cbInQue : (DWORD)-1L;
 }

//----------------------------------Operations----------------------------------
 //打开串口 缺省 9600, 8, n, 1
 bool Open(DWORD dwPort)
 {
  return Open(dwPort, 9600);
 }
 //打开串口 缺省 baud_rate, 8, n, 1
 bool Open(DWORD dwPort, DWORD dwBaudRate)
 {
  if(dwPort < 1 || dwPort > 1024)
   return false;

  BindCommPort(dwPort);

  if(!OpenCommPort())
   return false;

  if(!SetupPort())
   return false;

  return SetState(dwBaudRate);
 }
 //打开串口, 使用类似"9600, 8, n, 1"的设置字符串设置串口
 bool Open(DWORD dwPort, char *szSetStr)
 {
  if(dwPort < 1 || dwPort > 1024)
   return false;

  BindCommPort(dwPort);

  if(!OpenCommPort())
   return false;

  if(!SetupPort())
   return false;

  return SetState(szSetStr);
 }
 //读取串口 dwBufferLength个字符到 Buffer 返回实际读到的字符数  可读任意数据
 DWORD Read(LPVOID Buffer, DWORD dwBufferLength, DWORD dwWaitTime = 20)
 {
  if(!IsOpen())
   return 0;

  COMSTAT  Stat;
  DWORD dwError;

  if(::ClearCommError(_hCommHandle, &dwError, &Stat) && dwError > 0)
  {
   ::PurgeComm(_hCommHandle, PURGE_RXABORT | PURGE_RXCLEAR);
   return 0;
  }

  if(!Stat.cbInQue) // 缓冲区无数据
   return 0;

  unsigned long uReadLength = 0;

  dwBufferLength = dwBufferLength > Stat.cbInQue ? Stat.cbInQue : dwBufferLength;

  if(!::ReadFile(_hCommHandle, Buffer, dwBufferLength, &uReadLength, &_ReadOverlapped)) 
  {
   if(::GetLastError() == ERROR_IO_PENDING) 
   {
    WaitForSingleObject(_ReadOverlapped.hEvent, dwWaitTime); // 结束异步I/O
    if(!::GetOverlappedResult(_hCommHandle, &_ReadOverlapped, &uReadLength, false))
    {
     if(::GetLastError() != ERROR_IO_INCOMPLETE)
       uReadLength = 0;
    }
   }
   else
    uReadLength = 0;
  }
   
  return uReadLength;
 }
 //读取串口 dwBufferLength - 1 个字符到 szBuffer 返回ANSI C 模式字符串指针 适合一般字符通讯
 char * ReadString(char *szBuffer, DWORD dwBufferLength, DWORD dwWaitTime = 20)
 {
  unsigned long uReadLength = Read(szBuffer, dwBufferLength - 1, dwWaitTime);
  szBuffer[uReadLength] = '\0';
  return szBuffer;
 }
 //写串口 可写任意数据 "abcd" or "\x0\x1\x2"
 DWORD Write(LPVOID Buffer, DWORD dwBufferLength)
 {
  if(!IsOpen())
   return 0;
  
  DWORD dwError;

  if(::ClearCommError(_hCommHandle, &dwError, NULL) && dwError > 0) 
   ::PurgeComm(_hCommHandle, PURGE_TXABORT | PURGE_TXCLEAR); 

  unsigned long uWriteLength = 0;

  if(!::WriteFile(_hCommHandle, Buffer, dwBufferLength, &uWriteLength, &_WriteOverlapped))
   if(::GetLastError() != ERROR_IO_PENDING)
    uWriteLength = 0;

  return uWriteLength;
 }
 //写串口 写ANSI C 模式字符串指针 
 DWORD Write(const char *szBuffer)
 {
  assert(szBuffer);

  return Write((void *)szBuffer, strlen(szBuffer));
 }
 //写串口 同步应用
 DWORD WriteSync(LPVOID Buffer, DWORD dwBufferLength)
 {
  if(!IsOpen())
   return 0;
  
  DWORD dwError;

  if(::ClearCommError(_hCommHandle, &dwError, NULL) && dwError > 0) 
   ::PurgeComm(_hCommHandle, PURGE_TXABORT | PURGE_TXCLEAR); 

  unsigned long uWriteLength = 0;

  ::WriteFile(_hCommHandle, Buffer, dwBufferLength, &uWriteLength, NULL);

  return uWriteLength;
 }
 //写串口 szBuffer 可以输出格式字符串 包含缓冲区长度
 DWORD Write(char *szBuffer, DWORD dwBufferLength, char * szFormat, ...)
 {
  if(!IsOpen())
   return 0;
  
  va_list va;
  va_start(va, szFormat);
  _vsnprintf(szBuffer, dwBufferLength, szFormat, va);
  va_end(va);

  return Write(szBuffer);
 }
 //写串口 szBuffer 可以输出格式字符串 不检查缓冲区长度 小心溢出
 DWORD Write(char *szBuffer, char * szFormat, ...)
 {
  if(!IsOpen())
   return 0;
  
  va_list va;
  va_start(va, szFormat);
  vsprintf(szBuffer, szFormat, va);
  va_end(va);

  return Write(szBuffer);
 }
 //关闭串口 同时也关闭关联线程
 virtual void Close()
 {
  if(IsOpen())  
  {
   PurgeComm(_hCommHandle, PURGE_TXABORT | PURGE_TXCLEAR); 

   EndThread();
   ::CloseHandle(_hCommHandle);

   _hCommHandle = INVALID_HANDLE_VALUE;
  }