forked from MrDesTinY/CnComm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCnComm.h
2153 lines (1902 loc) · 53.5 KB
/
CnComm.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*! \mainpage CnComm v1.51 多线程串口通讯库
* \section About 关于
*
* \n 版本: CnComm v1.51
* \n 用途: WINDOWS/WINCE 多线程串口通讯库
* \n 语言: C++ (ANSI/UNICODE)
* \n 平台: WINDOWS(WIN98/NT/2000/XP/2003/Vista); WINCE 5.0 模拟器; Pocket PC 2003 模拟器;
* \n 硬件: PC串口; 串口服务器; USB串口; 虚拟串口;
* \n 编译: BC++ 5(free tool); C++ BUILDER 4, 5, 6, X; EVC 4(sp4); G++ 3, 4; Intel C++ 7, 8, 9; VC++ 6(sp6), .NET, 2003, 2005;
* \n 作者: llbird
* \n 邮箱: [email protected]
* \n 博客: http://blog.csdn.net/wujian53 http://www.cppblog.com/llbird
* \n 维护: 2002.10 - 2009.8
*
* \section Announce 说明
* \n 1) 可以自由使用及传播, 请保留相关声明;
* \n 2) 不推荐直接在本代码上修改, 应通过C++继承扩展机制扩展本代码;
* \n 3) 如果您直接修改本代码, 请发一份给我，便于同网友分享您有益的改动;
* \n 4) 不兼容cnComm1.4以下版本, 有很大改动，同时也更名CnComm;
* \n 5) 还是那句老话, 水平有限, 错误在所难免, 欢迎来信指正, 收入有限, 时间有限, 不提供除CnComm内部问题外的咨询;
*
* \section Log 日志
* \n 2009 v1.51 修正版; 考虑到将来的工作中可能不会再和串口打交道，这很可能是最后一版;
* \n 2009 v1.5 增加内置分块链表缓冲区; 增加对WINCE的支持(模拟器下测试通过);
* \n 2008 v1.4 增加对同步IO的多线程支持; 增加C++异常的支持; 改名CnComm; Cn == C Next;
* \n 2007 v1.3 细节部分修订;
* \n 2006 v1.2 细节部分修订;
* \n 2005 v1.1 细节部分修订;
* \n 2004 v1.0 采用VC命名风格(匈牙利), 在多个WINDOW平台、编译器测试通过, 首次公开发布cnComm;
* \n 2002 v0.1 因工作需要开发串口通讯基础类, 传统C++的继承机制, 传统C命名风格;
*/
#ifndef _CN_COMM_H_
#define _CN_COMM_H_
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <windows.h>
#include <tchar.h>
#if defined(UNDER_CE) && !defined(CN_COMM_FOR_CE)
#define CN_COMM_FOR_CE UNDER_CE //!< 配置WINCE的支持
#endif
#ifndef CN_COMM_FOR_CE
#include <mcx.h>
#include <process.h> // WINCE没有process.h
#endif
#ifndef ON_COM_MSG_BASE
#define ON_COM_MSG_BASE WM_USER + 618 //!< 消息编号的基点
#endif
// 送到窗口的消息 WPARAM COM端口号
#define ON_COM_RECEIVE ON_COM_MSG_BASE + 0 //!< EV_RXCHAR
#define ON_COM_RXCHAR ON_COM_MSG_BASE + 0 //!< EV_RXCHAR
#define ON_COM_CTS ON_COM_MSG_BASE + 1 //!< EV_CTS LPARAM==1 CTS ON
#define ON_COM_DSR ON_COM_MSG_BASE + 2 //!< EV_DSR LPARAM==1 DSR ON
#define ON_COM_RING ON_COM_MSG_BASE + 3 //!< EV_RING LPARAM==1 RING ON
#define ON_COM_RLSD ON_COM_MSG_BASE + 4 //!< EV_RLSD LPARAM==1 RLSD ON
#define ON_COM_BREAK ON_COM_MSG_BASE + 5 //!< EV_BREAK
#define ON_COM_TXEMPTY ON_COM_MSG_BASE + 6 //!< EV_TXEMPTY
#define ON_COM_ERROR ON_COM_MSG_BASE + 7 //!< EV_ERR LPARAM Error ID
#define ON_COM_RXFLAG ON_COM_MSG_BASE + 8 //!< EV_RXFLAG
#define ON_COM_POWER ON_COM_MSG_BASE + 9 //!< EV_POWER
#define ON_COM_EVENT1 ON_COM_MSG_BASE + 10//!< EV_EVENT1
#define ON_COM_EVENT2 ON_COM_MSG_BASE + 11//!< EV_EVENT2
#define ON_COM_RX80FULL ON_COM_MSG_BASE + 12//!< EV_RX80FULL
#define ON_COM_PERR ON_COM_MSG_BASE + 13//!< EV_PERR
#ifndef CN_COMM_WAIT_EVENT
#ifdef CN_COMM_FOR_CE
#define CN_COMM_WAIT_EVENT EV_RXCHAR | EV_ERR | EV_CTS | EV_DSR | EV_BREAK | EV_TXEMPTY | EV_RING | EV_RLSD | EV_POWER //!< WINCE 默认的等待事件| EV_RXFLAG
#else
#define CN_COMM_WAIT_EVENT EV_RXCHAR | EV_ERR | EV_CTS | EV_DSR | EV_BREAK | EV_TXEMPTY | EV_RING | EV_RLSD //!< WIN32 默认的等待事件| EV_RXFLAG
#endif
#endif
#ifndef CN_COMM_BUFFER_MIN_BLOCK_SIZE
#define CN_COMM_BUFFER_MIN_BLOCK_SIZE 1024 //!< 定义缓冲区块的最小值
#endif
#if CN_COMM_BUFFER_MIN_BLOCK_SIZE < 4
#error CN_COMM_BUFFER_MIN_BLOCK_SIZE must >= 4 //!< 缓冲区块的最小值不允许小于4
#endif
#ifndef CN_ASSERT
#define CN_2STR(L) _T(#L) //!< 将表达式L转换成字符串
#define CN_LINE(L) CN_2STR(L) //!< 将行号L转换成字符串
/*! 内部断言 启用异常将抛出异常 否则调试版将退出 发行版未启用异常将不做任何处理 */
#define CN_ASSERT(E) ((E) ? true : CnComm::Assert(_T("CN_ASSERT(")_T(#E)_T(") failed; CnComm(")CN_LINE(__LINE__)_T("); ")))
#endif
//CN_COMM_STD_EXCEPTION CN_ASSERT 将抛出标准C++异常
#ifdef CN_COMM_STD_EXCEPTION
#include <stdexcept> //throw runtime_error(msg)
#endif
//CN_COMM_VCL_EXCEPTION CN_ASSERT 将抛出VCL异常(C++ Builder)
#if defined(CN_COMM_VCL_EXCEPTION) && defined(__BORLANDC__)
#include <vcl.h> //throw new Exception(msg)
#endif
//CN_COMM_MFC_EXCEPTION CN_ASSERT 将抛出MFC异常(VC++)
#ifdef CN_COMM_MFC_EXCEPTION
#include <Afx.h> //throw new MfcException(msg)
#endif
/*! \class CnComm
\version 1.5
\date 2002.10-2009.4
\author llbird([email protected] http://www.cppblog.com/llbird http://blog.csdn.net/wujian53)
\brief WIN32/WINCE C++ (ANSI/UNICODE) 多线程串口通讯基础库
\example doc_0.cpp 例子0 \example doc_1.cpp \example doc_2.cpp \example doc_3.cpp \example SerialDlg.cpp
*/
class CnComm
{
public:
//! 临界区
struct InnerLock;
//! 缓冲区类
class BlockBuffer;
//! MFC异常
class MfcException;
//! 用于配置模式的枚举值, 32位掩码
enum OptionEnum
{
EN_THREAD = 0x00000001, //!< 启用监视线程 伴随串口打开启动 WatchThread
EN_OVERLAPPED = 0x00000002, //!< 启用异步重叠IO方式
EN_RX_BUFFER = 0x00000004, //!< 启用读缓冲
EN_TX_BUFFER = 0x00000008, //!< 启用写缓冲
EN_RX_THREAD = 0x00000010, //!< 启动读线程 暂时未用 ReadThread
EN_TX_THREAD = 0x00000020, //!< 启动写线程 用于WINCE的双工操作 应同时启用写缓冲 伴随串口打开启动 WriteThread
EN_SUSPEND = 0x00000040, //!< 启动线程时暂停
EN_ABOVE_NORMAL = 0x00000080, //!< 启动线程优先级高一个级别
EN_FLUSH = 0x00000100, //!< 当关闭串口时输出队列未发送完的数据(端口缓冲区) 并阻塞等待
EN_FLUSH_ALL = 0x00000200 //!< 同上(包括写缓冲及端口队列) 您如果重载了写模块而又没有写好 可能导致线程挂起无法正常关闭
};
//! 构造函数 配置具体应用模式 \param[in] dwOption 根据需要由OptionEnum组合而成
#ifdef CN_COMM_FOR_CE
//! WINCE:默认打开串口时启动监视线程 启用写独立线程 启用写缓冲
CnComm(DWORD dwOption = EN_THREAD )
#else
//! WIN32:默认打开串口时启动监视线程 异步重叠方式
CnComm(DWORD dwOption = EN_THREAD | EN_OVERLAPPED)
#endif
{
Init();
SetOption(dwOption);
}
//! 另一模式构造 兼容cnComm1~1.3 \param[in] bThread 启动监视线程 \param[in] bOverlapped 启用重叠I/O
CnComm(bool bThread, bool bOverlapped)
{
DWORD dwOption = 0;
if (bThread)
dwOption |= EN_THREAD;
if (bOverlapped)
dwOption |= EN_OVERLAPPED;
Init();
SetOption(dwOption);
}
//! 析构 自动关闭串口
virtual ~CnComm()
{
Close();
Destroy();
}
//! 判断串口是或打开
bool IsOpen()
{
return hComm_ != INVALID_HANDLE_VALUE;
}
//! 判断串口是或打开
operator bool ()
{
return hComm_ != INVALID_HANDLE_VALUE;
}
//! 获得串口句炳
HANDLE GetHandle()
{
return hComm_;
}
//! 获得串口句炳
operator HANDLE()
{
return hComm_;
}
//! 获得串口序号
DWORD GetPort()
{
return dwPort_;
}
//! 获得串口全名
LPCTSTR GetPortName()
{
return szName_;
}
//! 获得CnComm的基本配置参数 返回32位配置掩码
DWORD GetOption()
{
return dwOption_;
}
//! 设置CnComm的基本配置参数 在打开串口前设置有意义 \param[in] dwOption 32位配置掩码
void SetOption(DWORD dwOption)
{
CN_ASSERT(!IsOpen());//! 打开状态下不可以设置参数
dwOption_ = dwOption;
#ifdef CN_COMM_FOR_CE
CN_ASSERT(!IsOverlappedMode()); //! WINCE不允许使用重叠IO 即EN_OVERLAPPED掩码
dwOption_ &= (~EN_OVERLAPPED);
#endif
}
//! 修改CnComm的基本配置参数 在打开串口前设置有意义 \param[in] dwRemove 删除的32位配置掩码 \param[in] dwAdd 添加的32位配置掩码
void ModifyOption(DWORD dwRemove, DWORD dwAdd)
{
CN_ASSERT(!IsOpen());//! 打开状态下不可以设置参数
dwOption_ &= ~dwRemove;
dwOption_ |= dwAdd;
#ifdef CN_COMM_FOR_CE
CN_ASSERT(!IsOverlappedMode()); //! WINCE不允许使用重叠IO 即EN_OVERLAPPED掩码
dwOption_ &= (~EN_OVERLAPPED);
#endif
}
//! 是否重叠IO模式
bool IsOverlappedMode()
{
return dwOption_ & EN_OVERLAPPED ? true : false;
}
//! 是否输出缓冲区模式
bool IsTxBufferMode()
{
return dwOption_ & EN_TX_BUFFER ? true : false;
}
//! 是否输入缓冲区模式
bool IsRxBufferMode()
{
return dwOption_ & EN_RX_BUFFER ? true : false;
}
//! 关联消息的窗口句柄
void SetWnd(HWND hWnd)
{
CN_ASSERT(::IsWindow(hWnd));
hNotifyWnd_ = hWnd;
}
//! 关联消息的窗口句柄
HWND GetWnd()
{
return hNotifyWnd_;
}
//! 关联消息的窗口句柄
void SetNotifyThreadId(DWORD dwId)
{
hNotifyThreadId_ = dwId;
}
//! 关联消息的窗口句柄
DWORD GetNotifyThreadId()
{
return hNotifyThreadId_;
}
//! 设定发送通知, 接受字符最小值
void SetNotifyNum(DWORD dwNum)
{
dwNotifyNum_ = dwNum;
}
//! 获得线程句柄 \param[in] iOption EN_THREAD获得hWatchThread_ EN_RX_THREAD获得hReadThread_ EN_TX_THREAD获得hWriteThread_ \return HANDLE 线程句柄
HANDLE GetThread(int iOption = EN_THREAD)
{
return iOption == EN_THREAD ? hWatchThread_ : ((iOption == EN_RX_THREAD) ? hReadThread_ : hWriteThread_);
}
//! 设置要监视的事件， 打开前设置有效
void SetWaitEvent(DWORD dwEvent = CN_COMM_WAIT_EVENT)
{
CN_ASSERT(!IsOpen());///打开状态下不可以设置参数
dwWaitEvent_ = dwEvent;
}
//! 输入缓冲区
BlockBuffer& Input()
{
return I_;
}
//! 输出缓冲区
BlockBuffer& Output()
{
return O_;
}
//! 获得输入输出的计数 \param[in] bInput 为true获得输入计数,默认为true 重叠IO下输出是不精确的 因为输出由系统后台控制 假设完全输出
DWORD GetCounter(bool bInput = true)
{
return bInput ? dwInCount_ : dwOutCount_;
}
//! 输入输出计数器清零
void ResetCounter()
{
dwInCount_ = dwOutCount_ = 0;
}
//! 打开串口 请注意与cnComm1~1.3的区别 cnComm1~1.3将使用9600, n, 8, 1配置端口 而1.5将只打开端口不配置波特率等参数 \param[in] dwPort 串口序号 1~1024
bool Open(DWORD dwPort)
{
if (!CN_ASSERT(dwPort>=1 && dwPort<=1024))
return false;
BindPort(dwPort);
if(!CN_ASSERT(OpenPort()))
return false;
if(!CN_ASSERT(SetupPort()))
return Close(), false;
if ((dwOption_ & (EN_THREAD|EN_RX_THREAD|EN_TX_THREAD)) && !CN_ASSERT(BeginThread()))
return Close(), false;
return true;
}
/*! \param[in] dwPort 串口序号 1~1024 \param[in] dwBaudRate 波特率 \param[in] btParity 奇偶校验 \param[in] btByteSize 数据位数 \param[in] btStopBits 停止位数 */
//! 打开串口 缺省 9600, n, 8, 1 \sa bool Open(DWORD dwPort, LPCTSTR szSetStr)
bool Open(DWORD dwPort, DWORD dwBaudRate, BYTE btParity = NOPARITY, BYTE btByteSize = 8, BYTE btStopBits = ONESTOPBIT)
{
if (!CN_ASSERT(dwPort>=1 && dwPort<=1024))
return false;
BindPort(dwPort);
if (!CN_ASSERT(OpenPort()))
return false;
if (!CN_ASSERT(SetState(dwBaudRate, btParity, btByteSize, btStopBits)))
return Close(), false;
if (!CN_ASSERT(SetupPort()))
return Close(), false;
if ((dwOption_ & (EN_THREAD|EN_RX_THREAD|EN_TX_THREAD)) && !CN_ASSERT(BeginThread()))
return Close(), false;
return true;
}
#ifndef CN_COMM_FOR_CE
/*! \param[in] dwPort 串口序号 1~1024 \param[in] szSetStr 字符串参数 "BBBB,P,D,S" 例: "9600,N,8,1" "1200,O,7,2"
BBBB为波特率 P为奇偶校验(E | M | N | O | S) D为数据位数(4 ~ 8) S为停止位数(1 | 1.5 | 2)
\code Open(1, "9600,E,8,2"); \endcode \b 请注意字符串参数的顺序 并检查返回值
不支持WINCE, 原本我自己写了一个替代函数, 考虑到WINCE硬件的复杂性, 移植性可能不好, 故从这个版本中删除了 */
//! 打开串口, 字符串设置串口
bool Open(DWORD dwPort, LPCTSTR szSetStr)
{
if (!CN_ASSERT(dwPort>=1 && dwPort<=1024))
return false;
BindPort(dwPort);
if (!CN_ASSERT(OpenPort()))
return false;
if (!CN_ASSERT(SetState(szSetStr)))
return Close(), false;
if (!CN_ASSERT(SetupPort()))
return Close(), false;
if ((dwOption_ & (EN_THREAD|EN_RX_THREAD|EN_TX_THREAD)) && !CN_ASSERT(BeginThread()))
return Close(), false;
return true;
}
#endif
/*! \param[in] dwPort 此时该参数没有具体意义，仅用于消息通知中辨别端口号，应注意不和其他端口号重复
\param[in] szPortName 为指定的端口名称, 就像WINDOWS下\\\\.\\COM1或者WINCE下COM1: , 有些虚拟串口可以有特殊的名称
\param[in] dwBaudRate 波特率 \param[in] btParity 奇偶校验 \param[in] btByteSize 数据位数 \param[in] btStopBits 停止位数
\code Open(9999, "COM3:", 2400); \endcode \code Open(1028, "COM3:", 9600, N, 7, ONESTOPBIT); \endcode */
//! 指定的端口名称打开串口
bool Open(DWORD dwPort, LPCTSTR szPortName, DWORD dwBaudRate, BYTE btParity = NOPARITY, BYTE btByteSize = 8, BYTE btStopBits = ONESTOPBIT)
{
if(!CN_ASSERT(_tcslen(szPortName) < 64 - 1))
return false;
_tcscpy(szName_, szPortName);
dwPort_ = dwPort;//用于通知消息
if (!CN_ASSERT(OpenPort()))
return false;
if (!CN_ASSERT(SetState(dwBaudRate, btParity, btByteSize, btStopBits)))
return Close(), false;
if (!CN_ASSERT(SetupPort()))
return Close(), false;
if ((dwOption_ & (EN_THREAD|EN_RX_THREAD|EN_TX_THREAD)) && !CN_ASSERT(BeginThread()))
return Close(), false;
return true;
}
//! 直接读物理端口 \param[out] pBuffer 目标缓冲区 \param[in] dwLength 读取长度 \param[in] dwWaitTime 等待时间(默认INFINITE) \return 返回实际读取字节数
DWORD ReadPort(LPVOID pBuffer, DWORD dwLength, DWORD dwWaitTime = INFINITE)
{
COMSTAT Stat;
DWORD dwError, dwReadResult = 0;
if(!CN_ASSERT(IsOpen()) || !dwLength)
return 0;
if(::ClearCommError(hComm_, &dwError, &Stat) && dwError > 0)
::PurgeComm(hComm_, PURGE_RXABORT);
#ifndef CN_COMM_FOR_CE
if (IsOverlappedMode())//! 重叠I/O下 dwWaitTime==INFINITE 将等待到自然超时或任务完成 具体时间由超时结构决定 默认设定0.5秒
{
if (dwWaitTime == INFINITE)//! 如果你没有启用读反冲 直接读取端口将导致阻塞 相当于原来1.3版本 Read(pBuffer, dwLength, false);
{
if (!::ReadFile(hComm_, pBuffer, dwLength, &dwReadResult, &RO_))
{//! 在界面里使用CnComm推荐使用读缓冲区或者在dwWaitTime指定超时时间
if (CN_ASSERT(::GetLastError() == ERROR_IO_PENDING))
{
while (!CN_ASSERT(::GetOverlappedResult(hComm_, &RO_, &dwReadResult, TRUE)))
;
}
}
}
else//! 重叠I/O下 dwWaitTime!=INFINITE 将等待到超时或任务完成 具体时间由dwWaitTime决定
{ //! dwWaitTime = 0 相当于原来1.3版本的功能
DWORD dwBegin = GetTickCount(), dwEnd, dwCost, uReadLength, uReadReturn;
uReadLength = Stat.cbInQue > dwLength ? dwLength : Stat.cbInQue;
CN_ASSERT(::ReadFile(hComm_, pBuffer, uReadLength, &uReadReturn, &RO_));
dwReadResult += uReadReturn;
do
{
if (!::ReadFile(hComm_, (LPBYTE)pBuffer + dwReadResult, 1, &uReadReturn, &RO_))
{
if (dwWaitTime > 5 && WaitForSingleObject(RO_.hEvent, dwWaitTime) == WAIT_OBJECT_0)
{
dwEnd = GetTickCount();
dwCost = dwEnd>=dwBegin ? dwEnd-dwBegin : DWORD(-1L)-dwBegin+dwEnd;
CN_ASSERT(::GetOverlappedResult(hComm_, &RO_, &uReadReturn, FALSE));
dwWaitTime = dwWaitTime > dwCost ? dwWaitTime-dwCost : 0;
}
else
{
CN_ASSERT(::PurgeComm(hComm_, PURGE_RXABORT));
break;
}
}
}
while (uReadReturn && ++dwReadResult < dwLength);
}
return dwInCount_ += dwReadResult, dwReadResult;
}
#endif
//! 阻塞I/O和WinCE的I/O下 dwWaitTime无意义 超时时间由超时结构决定 默认设定1/4秒
CN_ASSERT(::ReadFile(hComm_, pBuffer, dwLength, &dwReadResult, NULL));
return dwInCount_ += dwReadResult, dwReadResult;
}
//! 读取串口 dwLength个字符到 pBuffer 返回实际读到的字符数 可读任意数据
DWORD Read(LPVOID pBuffer, DWORD dwLength, DWORD dwWaitTime = INFINITE)
{
CN_ASSERT(pBuffer);
if (dwOption_ & EN_RX_BUFFER)
{
BlockBuffer::InnerLock locker(&I_);
return I_.Read(pBuffer, dwLength);
}
#ifdef CN_COMM_FOR_CE
return ReadPort(pBuffer, dwLength, dwWaitTime);
#else
return ReadPort(pBuffer, dwLength, dwWaitTime);
#endif
}
//! 读取串口 dwLength - 1 个ANSI字符到 szBuffer 返回 C 模式字符串指针 适合一般字符通讯
char * ReadString(char *szBuffer, DWORD dwLength, DWORD dwWaitTime = INFINITE)
{
CN_ASSERT(szBuffer);
szBuffer[Read(szBuffer, dwLength - 1, dwWaitTime)] = '\0';
return szBuffer;
}
//! 读取串口 dwLength - 1 个UNICODE字符到 szBuffer 返回 C 模式字符串指针 适合一般字符通讯
wchar_t * ReadString(wchar_t *szBuffer, DWORD dwLength, DWORD dwWaitTime = INFINITE)
{
CN_ASSERT(szBuffer);
szBuffer[(Read(szBuffer, (dwLength - 1)*sizeof(wchar_t), dwWaitTime) +1)/ sizeof(wchar_t)] = L'\0';
return szBuffer;
}
//! 直接写入端口
DWORD WritePort(LPCVOID pBuffer, DWORD dwLength)
{
if(!CN_ASSERT(IsOpen()) || !dwLength)
return 0;
DWORD dwError;
unsigned long uWriteLength = 0;
if(::ClearCommError(hComm_, &dwError, NULL) && dwError > 0)
::PurgeComm(hComm_, PURGE_TXABORT);
#ifndef CN_COMM_FOR_CE
if (IsOverlappedMode())//! 使用重叠IO是返回0，写出计数直接加上待写入长度，即假设写入成功
{//! 重叠IO下超时由超时结构控制 默认为长度*1毫秒+10秒
if(!::WriteFile(hComm_, pBuffer, dwLength, &uWriteLength, &WO_)
&& !CN_ASSERT(::GetLastError() == ERROR_IO_PENDING))
uWriteLength = 0;
else
dwOutCount_ += dwLength;
}
else
#endif //! 使用阻塞IO或WINCE下是返回实际写入长度，写出计数直接加上实际写入长度, 超时默认1/4秒
::WriteFile(hComm_, pBuffer, dwLength, &uWriteLength, NULL), dwOutCount_ += uWriteLength;
return uWriteLength;
}
//! 写 EN_TX_BUFFER 决定写入缓冲区还是直接写入端口
DWORD Write(LPCVOID pBuffer, DWORD dwLength)
{
if (dwLength && (dwOption_&EN_TX_BUFFER))
{
BlockBuffer::InnerLock locker(&O_);
O_.Write(pBuffer, dwLength);
if (dwOption_ & EN_TX_THREAD)
SetEvent(hWatchEvent_);
else
{
#ifdef CN_COMM_FOR_CE
SetCommMask(hComm_, dwWaitEvent_);
#else
if (IsOverlappedMode())
SetCommMask(hComm_, dwWaitEvent_);
else
SetEvent(hWatchEvent_);
#endif
}
return 0;
}
#ifdef CN_COMM_FOR_CE
return WritePort(pBuffer, dwLength);
#else
return WritePort(pBuffer, dwLength);
#endif
}
//! 写串口 ANSI字符 写ANSI C 模式字符串指针
DWORD Write(const char *szBuffer)
{
CN_ASSERT(szBuffer);
return Write((LPCVOID)szBuffer, strlen(szBuffer));
}
//! 写串口 UNICODE字符 写ANSI C 模式字符串指针
DWORD Write(const wchar_t *szBuffer)
{
CN_ASSERT(szBuffer);
return Write((LPCVOID)szBuffer, wcslen(szBuffer)*sizeof(wchar_t));
}
//! 写串口 szBuffer 可以输出格式字符串 包含缓冲区长度
DWORD Write(char *szBuffer, DWORD dwLength, char * szFormat, ...)
{
va_list va;
va_start(va, szFormat);
_vsnprintf(szBuffer, dwLength, szFormat, va);
va_end(va);
return Write(szBuffer);
}
//! 写串口 UNICODE szBuffer 可以输出格式字符串 包含缓冲区长度
DWORD Write(wchar_t *szBuffer, DWORD dwLength, wchar_t * szFormat, ...)
{
va_list va;
va_start(va, szFormat);
_vsnwprintf(szBuffer, dwLength, szFormat, va);
va_end(va);
return Write(szBuffer);
}
//! 写串口 szBuffer 可以输出格式字符串 不检查缓冲区长度 小心溢出
DWORD Write(char *szBuffer, char * szFormat, ...)
{
va_list va;
va_start(va, szFormat);
vsprintf(szBuffer, szFormat, va);
va_end(va);
return Write(szBuffer);
}
//! 写串口 szBuffer 可以输出格式字符串 不检查缓冲区长度 小心溢出
DWORD Write(wchar_t *szBuffer, wchar_t * szFormat, ...)
{
va_list va;
va_start(va, szFormat);
vswprintf(szBuffer, szFormat, va);
va_end(va);
return Write(szBuffer);
}
//! 强制输出队列内数据并等待
void FlushPort()
{
if(CN_ASSERT(IsOpen()))
FlushFileBuffers(hComm_);
}
//! 强制输出写缓冲区并强制输出队列内数据并等待
void Flush()
{
if(CN_ASSERT(IsOpen()))
{
if (dwOption_ & EN_TX_BUFFER)
{
while(O_.SafeSize())
Sleep(50);
}
FlushFileBuffers(hComm_);
}
}
//! 抢先输出字符
bool TransmitChar(char c)
{
if (CN_ASSERT(IsOpen()))
{
if (::TransmitCommChar(hComm_, c))
return dwOutCount_++, true;
}
return false;
}
//! 启动辅助线程控制
bool BeginThread(DWORD dwThreadOption = 0)
{
DWORD dwCreationFlags;
if(CN_ASSERT(!hWatchThread_ && !hReadThread_ && !hWriteThread_))
{//! 必须是没有线程在运行状态下才可以启动线程
bContinue_ = true;
dwCreationFlags = dwOption_ & EN_SUSPEND ? CREATE_SUSPENDED : 0;
if (dwThreadOption)//! 根据配置创建监视线程，独立读或写线程
dwOption_ |= dwThreadOption;
#if defined(_MT) && !defined(CN_COMM_FOR_CE)
unsigned int id, rid, wid;
if (dwOption_ & EN_THREAD)
hWatchThread_ = (HANDLE)_beginthreadex(NULL, 0, WatchThreadProc, this, dwCreationFlags, &id);
if (dwOption_ & EN_RX_THREAD)
hReadThread_ = (HANDLE)_beginthreadex(NULL, 0, ReadThreadProc, this, dwCreationFlags, &rid);
if (dwOption_ & EN_TX_THREAD)
hWriteThread_ = (HANDLE)_beginthreadex(NULL, 0, WriteThreadProc, this, dwCreationFlags, &wid);
#else
DWORD id, rid, wid;
if (dwOption_ & EN_THREAD)
hWatchThread_ = ::CreateThread(NULL, 0, WatchThreadProc, this, dwCreationFlags , &id);
if (dwOption_ & EN_RX_THREAD)
hReadThread_ = ::CreateThread(NULL, 0, ReadThreadProc, this, dwCreationFlags, &rid);
if (dwOption_ & EN_TX_THREAD)
hWriteThread_ = ::CreateThread(NULL, 0, WriteThreadProc, this, dwCreationFlags, &wid);
#endif
if (dwOption_ & EN_THREAD)
{
CN_ASSERT(hWatchThread_ != NULL);
hWatchThreadId_ = id;
if (!hWatchThread_)
{
EndThread();
return false;
}
else
{
if (dwOption_ & EN_ABOVE_NORMAL)
SetThreadPriority(hWatchThread_, THREAD_PRIORITY_ABOVE_NORMAL);
}
}
if (dwOption_ & EN_RX_THREAD)
{
CN_ASSERT(hReadThread_ != NULL);
hReadThreadId_ = rid;
if (!hReadThreadId_)
{
EndThread();
return false;
}
else
{
if (dwOption_ & EN_ABOVE_NORMAL)
SetThreadPriority(hReadThread_, THREAD_PRIORITY_ABOVE_NORMAL);
}
}
if (dwOption_ & EN_TX_THREAD)
{
CN_ASSERT(hWriteThread_ != NULL);
hWriteThreadId_ = wid;
if (!hWriteThreadId_)
{
EndThread();
return false;
}
else
{
if (dwOption_ & EN_ABOVE_NORMAL)
SetThreadPriority(hWriteThread_, THREAD_PRIORITY_ABOVE_NORMAL);
}
}
return true;
}
return false;
}
//! 暂停线程
bool SuspendThread(int iOption = EN_THREAD)
{
return ::SuspendThread(GetThread(iOption)) != 0xFFFFFFFF;
}
//! 恢复线程
bool ResumeThread(int iOption = EN_THREAD)
{
return ::ResumeThread(GetThread(iOption)) != 0xFFFFFFFF;
}
//! 终止线程
bool EndThread(DWORD dwWaitTime = 500)
{
if(hWatchThread_ || hReadThread_ || hWriteThread_)
{
if ((dwOption_&EN_FLUSH_ALL) && (dwOption_&EN_TX_BUFFER))
{//! 如果启用EN_FLUSH_ALL，将循环等待写缓冲区清空，如果写入线程不能正常工作，将挂起
while(O_.Size())
Sleep(50);
}
bContinue_ = false;
#ifdef CN_COMM_FOR_CE
::SetCommMask(hComm_, 0);
#else
if (IsOverlappedMode())
::SetCommMask(hComm_, 0);
#endif
if (hWatchThread_)
{
SetEvent(hWatchEvent_);
if(::WaitForSingleObject(hWatchThread_, dwWaitTime) != WAIT_OBJECT_0)
if(!::TerminateThread(hWatchThread_, 0))
return false;
::CloseHandle(hWatchThread_);
hWatchThread_ = NULL;
}
if (hReadThread_)
{
SetEvent(hReadEvent_);
if(::WaitForSingleObject(hReadThread_, dwWaitTime) != WAIT_OBJECT_0)
if(!::TerminateThread(hReadThread_, 0))
return false;
::CloseHandle(hReadThread_);
hReadThread_ = NULL;
}
if (hWriteThread_)
{
SetEvent(hWriteEvent_);
if(::WaitForSingleObject(hWriteThread_, dwWaitTime) != WAIT_OBJECT_0)
if(!::TerminateThread(hWriteThread_, 0))
return false;
::CloseHandle(hWriteThread_);
hWriteThread_ = NULL;
}
return true;
}
return false;
}
//! 关闭串口 同时也关闭关联线程
virtual void Close(DWORD dwWaitTime = 500)
{
if(IsOpen())
{
EndThread(dwWaitTime);//! 同步结束线程
if (dwOption_&EN_FLUSH || dwOption_&EN_FLUSH_ALL)
FlushFileBuffers(hComm_);
::PurgeComm(hComm_, PURGE_TXABORT | PURGE_TXCLEAR | PURGE_RXCLEAR | PURGE_RXABORT);
::CloseHandle(hComm_);
hComm_ = INVALID_HANDLE_VALUE;
}
}
//! 锁定
void Lock()
{
::EnterCriticalSection(&CS_);
}
//! 解锁
void Unlock()
{
::LeaveCriticalSection(&CS_);
}
//! 自动锁 用于函数内部 利用对象的生命周期完成锁定及解锁
struct InnerLock
{
CnComm* ptr;//!< CnComm 对象指针
//! 锁定
InnerLock(CnComm* p) : ptr(p)
{
ptr->Lock();
}
//! 解锁
~InnerLock()
{
ptr->Unlock();
}
};
//! 获得串口参数 DCB
DCB *GetState(DCB *pDcb = NULL)
{
return CN_ASSERT(IsOpen()) && ::GetCommState(hComm_, pDcb == NULL ? &DCB_ : pDcb) == TRUE ? (pDcb == NULL ? &DCB_ : pDcb) : NULL;
}
//! 设置串口参数 DCB
bool SetState(DCB *pDcb = NULL)
{
return CN_ASSERT(IsOpen()) ? ::SetCommState(hComm_, pDcb == NULL ? &DCB_ : pDcb) == TRUE : false;
}
//! 设置串口参数：波特率，停止位，等 ***
bool SetState(DWORD dwBaudRate, BYTE btParity = NOPARITY, BYTE btByteSize = 8, BYTE btStopBits = ONESTOPBIT)
{
if(CN_ASSERT(IsOpen()))
{
if(::GetCommState(hComm_, &DCB_) != TRUE)
return false;
DCB_.BaudRate = dwBaudRate;
DCB_.ByteSize = btByteSize;
DCB_.Parity = btParity;
DCB_.StopBits = btStopBits;
DCB_.fParity = (btParity != NOPARITY);
return ::SetCommState(hComm_, &DCB_) == TRUE;
}
return false;
}
#ifndef CN_COMM_FOR_CE
//! 设置串口参数 支持设置字符串 "9600, n, 8, 1"
bool SetState(LPCTSTR szSetStr)
{
if(CN_ASSERT(IsOpen()))
{
if(!::GetCommState(hComm_, &DCB_))
return false;
if(!BuildCommDCB(szSetStr, &DCB_))
return false;
DCB_.fParity = (DCB_.Parity != NOPARITY);
return ::SetCommState(hComm_, &DCB_) == TRUE;
}
return false;
}
#endif
//! 获得超时结构
LPCOMMTIMEOUTS GetTimeouts(LPCOMMTIMEOUTS lpCO = NULL)
{
return CN_ASSERT(IsOpen()) && ::GetCommTimeouts(hComm_, lpCO ? lpCO : &CO_) == TRUE ? (lpCO ? lpCO : &CO_) : NULL;
}
//! 设置超时
bool SetTimeouts(LPCOMMTIMEOUTS lpCO = NULL)
{
return CN_ASSERT(IsOpen()) ? ::SetCommTimeouts(hComm_, lpCO ? lpCO : &CO_) == TRUE : false;
}
//! 设置串口的I/O缓冲区大小
bool Setup(DWORD dwInputSize = 4096, DWORD dwOutputSize = 4096)
{
return CN_ASSERT(IsOpen()) ? ::SetupComm(hComm_, dwInputSize, dwOutputSize) == TRUE : false;
}
//! 调整端口功能
bool Escape(DWORD dwType)
{
return CN_ASSERT(IsOpen()) ? EscapeCommFunction(hComm_, dwType) != 0 : false;
}
//! 获得调制解调器相关信号状态
DWORD GetModemStatus()
{
DWORD dwModemStat = 0;
return CN_ASSERT(IsOpen()) && GetCommModemStatus(hComm_, &dwModemStat) ? dwModemStat : 0;
}
//! 获得端口参数 \param[in] pCP 结构指针 如果pCP==NULL, CnComm将从堆分配内存, 并由CnComm负责释放, 用户不需要自己释放内存
LPCOMMPROP GetProperties(LPCOMMPROP pCP = NULL)
{
if (CN_ASSERT(IsOpen()))
{
if (!pCP)
{
#ifdef CN_COMM_FOR_CE
USHORT dwSize = sizeof(COMMPROP);
#else
USHORT dwSize = sizeof(COMMPROP) + sizeof(MODEMDEVCAPS);
#endif
if (!pCP_)
pCP_ = (LPCOMMPROP) new BYTE[dwSize];
if (pCP_)
{
memset(pCP_, 0, dwSize);
pCP_->wPacketLength = dwSize;
#ifndef CN_COMM_FOR_CE
pCP_->dwProvSubType = PST_MODEM;
#endif
pCP_->dwProvSpec1 = COMMPROP_INITIALIZED;
pCP = pCP_;
}
}
}
return pCP && GetCommProperties(hComm_, pCP) ? pCP : NULL;
}
//! 获取事件标识
DWORD GetMask()
{
DWORD dwMask;
return CN_ASSERT(IsOpen()) && GetCommMask(hComm_, &dwMask) ? dwMask : 0;
}
//! 清除端口缓冲区
bool Purge(DWORD dwPara = PURGE_TXABORT | PURGE_TXCLEAR | PURGE_RXABORT | PURGE_RXCLEAR)
{
return CN_ASSERT(IsOpen()) ? ::PurgeComm(hComm_, dwPara)==TRUE : false;
}
//! 获得错误代码
DWORD ClearError()
{
DWORD dwError;
return CN_ASSERT(IsOpen()) && ::ClearCommError(hComm_, &dwError, NULL) ? dwError : 0;
}
//! 获得读物理缓冲区的字符数
DWORD GetQueueCount(bool bInput = true)
{
COMSTAT Stat;
DWORD dwError;
return CN_ASSERT(IsOpen()) && ::ClearCommError(hComm_, &dwError, &Stat) ? (bInput ? Stat.cbInQue : Stat.cbOutQue) : (DWORD)-1L;
}
//! 调制解调器 CTS ON
bool CheckCTS()
{
return (GetModemStatus()&MS_CTS_ON) != 0;
}
//! 调制解调器 DSR ON
bool CheckDSR()
{
return (GetModemStatus()&MS_DSR_ON) != 0;
}
//! 调制解调器 Ring ON
bool CheckRING()
{
return (GetModemStatus()&MS_RING_ON) != 0;
}
//! 调制解调器 RLSD ON
bool CheckRLSD()
{
return (GetModemStatus()&MS_RLSD_ON) != 0;
}
//! DTR 电平控制
bool SetDTR(bool bSetOrClr = true)
{
return Escape(bSetOrClr ? SETDTR : CLRDTR);
}
//! RTS 电平控制
bool SetRTS(bool bSetOrClr = true)
{
return Escape(bSetOrClr ? SETRTS : CLRRTS);
}
//! 调制解调器
bool SetBreak(bool bSetOrClr = true)
{