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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
| unit Pipes;
interface
uses
Windows, SysUtils, Classes, Messages;
resourcestring
// Exception resource strings
resPipeActive = 'Cannot change property while server is active!';
resPipeConnected = 'Cannot change property when client is connected!';
resBadPipeName = 'Invalid pipe name specified!';
const
// Maximum and minimum constants
MAX_THREADS = 101; // 1 Listener and 100 Workers
MIN_BUFFER = 4096;
MAX_BUFFER = MaxWord;
const
// Pipe window messages
WM_PIPEERROR_L = WM_USER + 100;
WM_PIPEERROR_W = Succ(WM_PIPEERROR_L);
WM_PIPECONNECT = Succ(WM_PIPEERROR_W);
WM_PIPEDISCONNECT = Succ(WM_PIPECONNECT);
WM_PIPESEND = Succ(WM_PIPEDISCONNECT);
WM_PIPEMESSAGE = Succ(WM_PIPESEND);
type
// Define the pipe data type
HPIPE = THandle;
// Pipe exceptions
EPipeException = class(Exception);
// Forward declarations
TPipeServer = class;
TPipeClient = class;
// Pipe write data structure
PPipeWrite = ^TPipeWrite;
TPipeWrite = packed record
Buffer: PChar;
Count: Integer;
end;
// Writer queue node structure
PWriteNode = ^TWriteNode;
TWriteNode = packed record
PipeWrite: PPipeWrite;
NextNode: PWriteNode;
end;
// Writer queue class
TWriteQueue = class(TObject)
private
// Private declarations
FCount: Integer;
FDataEv: THandle;
FHead: PWriteNode;
FTail: PWriteNode;
protected
// Protected declarations
procedure Clear;
function NewNode(PipeWrite: PPipeWrite): PWriteNode;
public
// Public declarations
constructor Create;
destructor Destroy; override;
procedure Enqueue(PipeWrite: PPipeWrite);
function Dequeue: PPipeWrite;
property DataEvent: THandle read FDataEv;
property Count: Integer read FCount;
end;
// Base class pipe thread that exposes SafeSynchronize method
TPipeThread = class(TThread)
private
// Private declarations
protected
// Protected declarations
procedure SafeSynchronize(Method: TThreadMethod);
public
// Public declarations
end;
// Pipe Listen thread class
TPipeListenThread = class(TPipeThread)
private
// Private declarations
FNotify: HWND;
FErrorCode: Integer;
FPipe: HPIPE;
FPipeName: string;
FConnected: Boolean;
FEvents: array[0..1] of THandle;
FOlapConnect: TOverlapped;
FPipeServer: TPipeServer;
FSA: TSecurityAttributes;
protected
// Protected declarations
function CreateServerPipe: Boolean;
procedure DoWorker;
procedure Execute; override;
public
// Public declarations
constructor Create(PipeServer: TPipeServer; KillEvent: THandle);
destructor Destroy; override;
end;
// Pipe Server worker thread class
TPipeServerThread = class(TPipeThread)
private
// Private declarations
FNotify: HWND;
FPipe: HPIPE;
FErrorCode: Integer;
FPipeServer: TPipeServer;
FWrite: DWORD;
FPipeWrite: PPipeWrite;
FRcvRead: DWORD;
FPendingRead: Boolean;
FPendingWrite: Boolean;
FRcvStream: TMemoryStream;
FRcvBuffer: PChar;
FRcvSize: DWORD;
FEvents: array[0..3] of THandle;
FOlapRead: TOverlapped;
FOlapWrite: TOverlapped;
protected
// Protected declarations
function QueuedRead: Boolean;
function CompleteRead: Boolean;
function QueuedWrite: Boolean;
function CompleteWrite: Boolean;
procedure DoMessage;
procedure DoDequeue;
procedure Execute; override;
public
// Public declarations
constructor Create(PipeServer: TPipeServer; Pipe: HPIPE; KillEvent,
DataEvent: THandle);
destructor Destroy; override;
property Pipe: HPIPE read FPipe;
end;
// Pipe info record stored by the TPipeServer component for each working thread
PPipeInfo = ^TPipeInfo;
TPipeInfo = packed record
Pipe: HPIPE;
WriteQueue: TWriteQueue;
end;
// Pipe context for error messages
TPipeContext = (pcListener, pcWorker);
// Pipe Events
TOnPipeConnect = procedure(Sender: TObject; Pipe: HPIPE) of object;
TOnPipeDisconnect = procedure(Sender: TObject; Pipe: HPIPE) of object;
TOnPipeMessage = procedure(Sender: TObject; Pipe: HPIPE; Stream: TStream) of
object;
TOnPipeSent = procedure(Sender: TObject; Pipe: HPIPE; Size: DWORD) of object;
TOnPipeError = procedure(Sender: TObject; Pipe: HPIPE; PipeContext:
TPipeContext; ErrorCode: Integer) of object;
// Pipe Server component
TPipeServer = class(TComponent)
private
// Private declarations
FHwnd: HWND;
FPipeName: string;
FActive: Boolean;
FInShutDown: Boolean;
FKillEv: THandle;
FClients: TList;
FListener: TPipeListenThread;
FThreadCount: Integer;
FSA: TSecurityAttributes;
FOPS: TOnPipeSent;
FOPC: TOnPipeConnect;
FOPD: TOnPipeDisconnect;
FOPM: TOnPipeMessage;
FOPE: TOnPipeError;
procedure DoStartup;
procedure DoShutdown;
protected
// Protected declarations
function Dequeue(Pipe: HPIPE): PPipeWrite;
function GetClient(Index: Integer): HPIPE;
function GetActiveClients: Integer;
procedure WndMethod(var Message: TMessage);
procedure RemoveClient(Pipe: HPIPE);
procedure SetActive(Value: Boolean);
procedure SetPipeName(Value: string);
procedure AddWorkerThread(Pipe: HPIPE);
procedure RemoveWorkerThread(Sender: TObject);
procedure RemoveListenerThread(Sender: TObject);
public
// Public declarations
constructor Create(AOwner: TComponent); override;
destructor Destroy; override;
function Write(Pipe: HPIPE; var Buffer; Count: Integer): Boolean;
property WindowHandle: HWND read FHwnd;
property ActiveClients: Integer read GetActiveClients;
property Clients[Index: Integer]: HPIPE read GetClient;
published
// Published declarations
property Active: Boolean read FActive write SetActive;
property OnPipeSent: TOnPipeSent read FOPS write FOPS;
property OnPipeConnect: TOnPipeConnect read FOPC write FOPC;
property OnPipeDisconnect: TOnPipeDisconnect read FOPD write FOPD;
property OnPipeMessage: TOnPipeMessage read FOPM write FOPM;
property OnPipeError: TOnPipeError read FOPE write FOPE;
property PipeName: string read FPipeName write SetPipeName;
end;
// Pipe Client worker thread class
TPipeClientThread = class(TPipeThread)
private
// Private declarations
FNotify: HWND;
FPipe: HPIPE;
FErrorCode: Integer;
FPipeClient: TPipeClient;
FWrite: DWORD;
FPipeWrite: PPipeWrite;
FRcvRead: DWORD;
FPendingRead: Boolean;
FPendingWrite: Boolean;
FRcvStream: TMemoryStream;
FRcvBuffer: PChar;
FRcvSize: DWORD;
FEvents: array[0..3] of THandle;
FOlapRead: TOverlapped;
FOlapWrite: TOverlapped;
protected
// Protected declarations
function QueuedRead: Boolean;
function CompleteRead: Boolean;
function QueuedWrite: Boolean;
function CompleteWrite: Boolean;
procedure DoMessage;
procedure DoDequeue;
procedure Execute; override;
public
// Public declarations
constructor Create(PipeClient: TPipeClient; Pipe: HPIPE; KillEvent,
DataEvent: THandle);
destructor Destroy; override;
end;
// Pipe Client component
TPipeClient = class(TComponent)
private
// Private declarations
FHwnd: HWND;
FPipe: HPIPE;
FPipeName: string;
FServerName: string;
FConnected: Boolean;
FWriteQueue: TWriteQueue;
FWorker: TPipeClientThread;
FKillEv: THandle;
FSA: TSecurityAttributes;
FOPE: TOnPipeError;
FOPD: TOnPipeDisconnect;
FOPM: TOnPipeMessage;
FOPS: TOnPipeSent;
protected
// Protected declarations
procedure SetPipeName(Value: string);
procedure SetServerName(Value: string);
function Dequeue: PPipeWrite;
procedure RemoveWorkerThread(Sender: TObject);
procedure WndMethod(var Message: TMessage);
public
// Public declarations
constructor Create(AOwner: TComponent); override;
destructor Destroy; override;
function Connect: Boolean;
procedure Disconnect;
function Write(var Buffer; Count: Integer): Boolean;
property Connected: Boolean read FConnected;
property WindowHandle: HWND read FHwnd;
published
// Published declarations
property PipeName: string read FPipeName write SetPipeName;
property ServerName: string read FServerName write SetServerName;
property OnPipeDisconnect: TOnPipeDisconnect read FOPD write FOPD;
property OnPipeMessage: TOnPipeMessage read FOPM write FOPM;
property OnPipeSent: TOnPipeSent read FOPS write FOPS;
property OnPipeError: TOnPipeError read FOPE write FOPE;
end;
// Pipe write helper functions
function AllocPipeWrite(const Buffer; Count: Integer): PPipeWrite;
procedure DisposePipeWrite(PipeWrite: PPipeWrite);
procedure CheckPipeName(Value: string);
// Security helper functions
procedure InitializeSecurity(var SA: TSecurityAttributes);
procedure FinalizeSecurity(var SA: TSecurityAttributes);
// Component register procedure
procedure Register;
implementation
////////////////////////////////////////////////////////////////////////////////
//
// TPipeClient
//
////////////////////////////////////////////////////////////////////////////////
constructor TPipeClient.Create(AOwner: TComponent);
begin
// Perform inherited
inherited Create(AOwner);
// Set properties
InitializeSecurity(FSA);
FKillEv := CreateEvent(@FSA, True, False, nil);
FPipe := INVALID_HANDLE_VALUE;
FConnected := False;
FWriteQueue := TWriteQueue.Create;
FWorker := nil;
FPipeName := 'PipeServer';
FServerName := '';
FHwnd := AllocateHWnd(WndMethod);
end;
destructor TPipeClient.Destroy;
begin
// Disconnect if connected
Disconnect;
// Free resources
FinalizeSecurity(FSA);
CloseHandle(FKillEv);
FWriteQueue.Free;
DeAllocateHWnd(FHwnd);
// Perform inherited
inherited Destroy;
end;
function TPipeClient.Connect: Boolean;
var
szname: string;
lpname: array[0..1023] of Char;
resolved: Boolean;
dwmode: DWORD;
dwSize: DWORD;
begin
// Optimistic result
result := True;
// Exit if already connected
if FConnected then
exit;
// Set server name resolution
resolved := False;
// Check name against local computer name first
dwSize := SizeOf(lpname);
if GetComputerName(lpname, dwSize) then
begin
// Compare names
if (CompareText(lpname, FServerName) = 0) then
begin
// Server name represents local computer, switch to the
// preferred use of "." for the name
szname := '.';
resolved := True;
end;
end;
// Resolve the server name
if not (resolved) then
begin
// Blank name also indicates local computer
if (FServerName = '') then
szname := '.'
else
szname := FServerName;
end;
// Build the full pipe name
StrCopy(lpname, PChar(Format('\\%s\pipe\%s', [szname, FPipeName])));
// Attempt to wait for the pipe first
if WaitNamedPipe(@lpname, NMPWAIT_USE_DEFAULT_WAIT) then
begin
// Attempt to create client side handle
FPipe := CreateFile(@lpname, GENERIC_READ or GENERIC_WRITE, 0, @FSA,
OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL or FILE_FLAG_OVERLAPPED, 0);
// Success if we have a valid handle
result := (FPipe <> INVALID_HANDLE_VALUE);
// Need to set message mode
if result then
begin
dwmode := PIPE_READMODE_MESSAGE or PIPE_WAIT;
SetNamedPipeHandleState(FPipe, dwmode, nil, nil);
// Create thread to handle the pipe IO
FWorker := TPipeClientThread.Create(Self, FPipe, FKillEv,
FWriteQueue.DataEvent);
FWorker.OnTerminate := RemoveWorkerThread;
end;
end
else
// Failure
result := False;
// Set connected flag
FConnected := result;
end;
procedure TPipeClient.Disconnect;
begin
// Exit if not connected
if not (FConnected) then
exit;
// Signal the kill event
SetEvent(FKillEv);
// Terminate and wait for the worker thread to finish
if Assigned(FWorker) then
begin
FWorker.Terminate;
FWorker.WaitFor;
end;
// Set new state
FConnected := False;
end;
function TPipeClient.Write(var Buffer; Count: Integer): Boolean;
begin
// Set default result (depends on connected state)
result := FConnected;
// Exit if not connected
if not (result) then
exit;
// Enqueue the data
FWriteQueue.Enqueue(AllocPipeWrite(Buffer, Count));
end;
procedure TPipeClient.SetPipeName(Value: string);
begin
// Raise error if pipe is connected
if FConnected then
raise EPipeException.CreateRes(@resPipeConnected);
// Check the pipe name
CheckPipeName(Value);
// Set the pipe name
FPipeName := Value;
end;
procedure TPipeClient.SetServerName(Value: string);
begin
// Raise error if pipe is connected
if FConnected then
raise EPipeException.CreateRes(@resPipeConnected);
// Set the server name
FServerName := Value;
end;
function TPipeClient.Dequeue: PPipeWrite;
begin
// Dequeue the record and break
result := FWriteQueue.Dequeue;
end;
procedure TPipeClient.RemoveWorkerThread(Sender: TObject);
begin
// Notify of disconnect
if not (csDestroying in ComponentState) and Assigned(FOPD) then
FOPD(Self, FPipe);
// Set thread variable to nil
FWorker := nil;
FPipe := INVALID_HANDLE_VALUE;
// Set state to disconneted
FConnected := False;
end;
procedure TPipeClient.WndMethod(var Message: TMessage);
var
MemStream: TMemoryStream;
lpmsg: PChar;
dwmem: Integer;
begin
// Handle the pipe messages
case Message.Msg of
WM_PIPEERROR_W:
if Assigned(FOPE) then
FOPE(Self, Message.wParam, pcWorker, Message.lParam);
WM_PIPEDISCONNECT:
if Assigned(FOPD) then
FOPD(Self, Message.wParam);
WM_PIPESEND:
if Assigned(FOPS) then
FOPS(Self, Message.wParam, Message.lParam);
WM_PIPEMESSAGE:
begin
dwmem := GlobalSize(Message.lParam);
if (dwmem > 0) then
begin
MemStream := TMemoryStream.Create;
lpmsg := GlobalLock(Message.lParam);
try
// Copy the actual stream contents over
MemStream.Write(lpmsg^, dwmem);
MemStream.Position := 0;
// Call the OnMessage event if assigned
if Assigned(FOPM) then
FOPM(Self, Message.wParam, MemStream);
finally
MemStream.Free;
GlobalUnLock(Message.lParam);
end;
end;
GlobalFree(Message.lParam);
end;
else
// Call default window procedure
DefWindowProc(FHwnd, Message.Msg, Message.wParam, Message.lParam);
end;
end;
////////////////////////////////////////////////////////////////////////////////
//
// TPipeClientThread
//
////////////////////////////////////////////////////////////////////////////////
constructor TPipeClientThread.Create(PipeClient: TPipeClient; Pipe: HPIPE;
KillEvent, DataEvent: THandle);
begin
// Set starting parameters
FreeOnTerminate := True;
FPipe := Pipe;
FPipeClient := PipeClient;
FNotify := PipeClient.WindowHandle;
FErrorCode := ERROR_SUCCESS;
FPendingRead := False;
FPendingWrite := False;
FPipeWrite := nil;
FRcvSize := MIN_BUFFER;
FRcvBuffer := AllocMem(FRcvSize);
FRcvStream := TMemoryStream.Create;
FOlapRead.Offset := 0;
FOlapRead.OffsetHigh := 0;
FOlapRead.hEvent := CreateEvent(nil, True, False, nil);
FOlapWrite.hEvent := CreateEvent(nil, True, False, nil);
ResetEvent(KillEvent);
FEvents[0] := KillEvent;
FEvents[1] := FOlapRead.hEvent;
FEvents[2] := FOlapWrite.hEvent;
FEvents[3] := DataEvent;
// Perform inherited
inherited Create(False);
end;
destructor TPipeClientThread.Destroy;
begin
// Free the write buffer we may be holding on to
if FPendingWrite and Assigned(FPipeWrite) then
DisposePipeWrite(FPipeWrite);
// Free the receiver stream and buffer memory
FreeMem(FRcvBuffer);
FRcvStream.Free;
// Perform inherited
inherited Destroy;
end;
function TPipeClientThread.QueuedRead: Boolean;
var
bRead: Boolean;
begin
// Set default result
result := True;
// If we already have a pending read then nothing to do
if not (FPendingRead) then
begin
// Set defaults for reading
FRcvStream.Clear;
FRcvSize := MIN_BUFFER;
ReAllocMem(FRcvBuffer, FRcvSize);
// Keep reading all available data until we get a pending read or a failure
while result and not (FPendingRead) do
begin
// Perform a read
bRead := ReadFile(FPipe, FRcvBuffer^, FRcvSize, FRcvRead, @FOlapRead);
// Get the last error code
FErrorCode := GetLastError;
// Check the read result
if bRead then
begin
// We read a full message
FRcvStream.Write(FRcvBuffer^, FRcvRead);
// Call the OnData
DoMessage;
end
else
begin
// Handle cases where message is larger than read buffer used
if (FErrorCode = ERROR_MORE_DATA) then
begin
// Write the current data
FRcvStream.Write(FRcvBuffer^, FRcvSize);
// Determine how much we need to expand the buffer to
if PeekNamedPipe(FPipe, nil, 0, nil, nil, @FRcvSize) then
ReallocMem(FRcvBuffer, FRcvSize)
else
begin
// Failure
FErrorCode := GetLastError;
result := False;
end;
end
// Pending read
else
if (FErrorCode = ERROR_IO_PENDING) then
// Set pending flag
FPendingRead := True
else
// Failure
result := False;
end;
end;
end;
end;
function TPipeClientThread.CompleteRead: Boolean;
begin
// Reset the read event and pending flag
ResetEvent(FOlapRead.hEvent);
// Check the overlapped results
result := GetOverlappedResult(FPipe, FOlapRead, FRcvRead, True);
// Handle failure
if not (result) then
begin
// Get the last error code
FErrorCode := GetLastError;
// Check for more data
if (FErrorCode = ERROR_MORE_DATA) then
begin
// Write the current data
FRcvStream.Write(FRcvBuffer^, FRcvSize);
// Determine how much we need to expand the buffer to
result := PeekNamedPipe(FPipe, nil, 0, nil, nil, @FRcvSize);
if result then
begin
// Realloc mem to read in rest of message
ReallocMem(FRcvBuffer, FRcvSize);
// Read from the file again
result := ReadFile(FPipe, FRcvBuffer^, FRcvSize, FRcvRead, @FOlapRead);
// Handle error
if not (result) then
begin
// Set error code
FErrorCode := GetLastError;
// Check for pending again, which means our state hasn't changed
if (FErrorCode = ERROR_IO_PENDING) then
begin
// Bail out and wait for this operation to complete
result := True;
exit;
end;
end;
end
else
// Set error code
FErrorCode := GetLastError;
end;
end;
// Handle success
if result then
begin
// We read a full message
FRcvStream.Write(FRcvBuffer^, FRcvRead);
// Call the OnData
DoMessage;
// Reset the pending read
FPendingRead := False;
end;
end;
function TPipeClientThread.QueuedWrite: Boolean;
var
bWrite: Boolean;
begin
// Set default result
result := True;
// If we already have a pending write then nothing to do
if not (FPendingWrite) then
begin
// Check state of data event
if (WaitForSingleObject(FEvents[3], 0) = WAIT_OBJECT_0) then
begin
// Pull the data from the queue
SafeSynchronize(DoDequeue);
// Is the record assigned?
if Assigned(FPipeWrite) then
begin
// Write the data to the client
bWrite := WriteFile(FPipe, FPipeWrite^.Buffer^, FPipeWrite^.Count,
FWrite, @FOlapWrite);
// Get the last error code
FErrorCode := GetLastError;
// Check the write operation
if bWrite then
begin
// Call the OnData in the main thread
PostMessage(FNotify, WM_PIPESEND, FPipe, FWrite);
// Free the pipe write data
DisposePipeWrite(FPipeWrite);
FPipeWrite := nil;
// Reset the write event
ResetEvent(FOlapWrite.hEvent);
end
else
begin
// Only acceptable error is pending
if (FErrorCode = ERROR_IO_PENDING) then
// Set pending flag
FPendingWrite := True
else
// Failure
result := False;
end;
end;
end;
end;
end;
function TPipeClientThread.CompleteWrite: Boolean;
begin
// Reset the write event and pending flag
ResetEvent(FOlapWrite.hEvent);
// Check the overlapped results
result := GetOverlappedResult(FPipe, FOlapWrite, FWrite, True);
// Handle failure
if not (result) then
// Get the last error code
FErrorCode := GetLastError
else
// We sent a full message so call the OnSent in the main thread
PostMessage(FNotify, WM_PIPESEND, FPipe, FWrite);
// We are done either way. Make sure to free the queued pipe data
// and to reset the pending flag
if Assigned(FPipeWrite) then
begin
DisposePipeWrite(FPipeWrite);
FPipeWrite := nil;
end;
FPendingWrite := False;
end;
procedure TPipeClientThread.DoDequeue;
begin
// Get the next queued data event
FPipeWrite := FPipeClient.Dequeue;
end;
procedure TPipeClientThread.DoMessage;
var
lpmem: DWORD;
lpmsg: PChar;
begin
// Convert the memory to global memory and send to pipe server
lpmem := GlobalAlloc(GHND, FRcvStream.Size);
lpmsg := GlobalLock(lpmem);
// Copy from the pipe
FRcvStream.Position := 0;
FRcvStream.Read(lpmsg^, FRcvStream.Size);
// Unlock the memory
GlobalUnlock(lpmem);
// Send to the pipe server to manage
PostMessage(FNotify, WM_PIPEMESSAGE, FPipe, lpmem);
// Clear the read stream
FRcvStream.Clear;
end;
procedure TPipeClientThread.Execute;
var
dwEvents: Integer;
bOK: Boolean;
begin
// Loop while not terminated
while not (Terminated) do
begin
// Make sure we always have an outstanding read and write queued up
bOK := (QueuedRead and QueuedWrite);
if bOK then
begin
// If we are in a pending write then we need will not wait for the
// DataEvent, because we are already waiting for a write to finish
dwEvents := 4;
if FPendingWrite then
Dec(dwEvents);
// Handle the event that was signalled (or failure)
case WaitForMultipleObjects(dwEvents, @FEvents, False, INFINITE) of
// Killed by pipe server
WAIT_OBJECT_0: Terminate;
// Read completed
WAIT_OBJECT_0 + 1: bOK := CompleteRead;
// Write completed
WAIT_OBJECT_0 + 2: bOK := CompleteWrite;
// Data waiting to be sent
WAIT_OBJECT_0 + 3: ; // Data available to write
else
// General failure
FErrorCode := GetLastError;
bOK := False;
end;
end;
// Check status
if not (bOK) then
begin
// Call OnError in the main thread if this is not a disconnect. Disconnects
// have their own event, and are not to be considered an error
if (FErrorCode <> ERROR_PIPE_NOT_CONNECTED) then
PostMessage(FNotify, WM_PIPEERROR_W, FPipe, FErrorCode);
// Terminate
Terminate;
end;
end;
// Make sure the handle is still valid
if (FErrorCode <> ERROR_INVALID_HANDLE) then
begin
DisconnectNamedPipe(FPipe);
CloseHandle(FPipe);
end;
// Close all open handles that we own
CloseHandle(FOlapRead.hEvent);
CloseHandle(FOlapWrite.hEvent);
end;
////////////////////////////////////////////////////////////////////////////////
//
// TServerPipe
//
////////////////////////////////////////////////////////////////////////////////
constructor TPipeServer.Create(AOwner: TComponent);
begin
// Perform inherited
inherited Create(AOwner);
// Initialize the security attributes
InitializeSecurity(FSA);
// Set staring defaults
FPipeName := 'PipeServer';
FActive := False;
FInShutDown := False;
FKillEv := CreateEvent(@FSA, True, False, nil);
FClients := TList.Create;
FListener := nil;
FThreadCount := 0;
FHwnd := AllocateHWnd(WndMethod);
end;
destructor TPipeServer.Destroy;
begin
// Perform the shutdown if active
if FActive then
DoShutdown;
// Release all objects, events, and handles
CloseHandle(FKillEv);
FClients.Free;
FinalizeSecurity(FSA);
// Close the window
DeAllocateHWnd(FHwnd);
// Perform inherited
inherited Destroy;
end;
procedure TPipeServer.WndMethod(var Message: TMessage);
var
MemStream: TMemoryStream;
lpmsg: PChar;
dwmem: Integer;
begin
// Handle the pipe messages
case Message.Msg of
WM_PIPEERROR_L:
if not (FInShutdown) and Assigned(FOPE) then
FOPE(Self, Message.wParam, pcListener, Message.lParam);
WM_PIPEERROR_W:
if not (FInShutdown) and Assigned(FOPE) then
FOPE(Self, Message.wParam, pcWorker, Message.lParam);
WM_PIPECONNECT:
if Assigned(FOPC) then
FOPC(Self, Message.wParam);
WM_PIPEDISCONNECT:
if Assigned(FOPD) then
FOPD(Self, Message.wParam);
WM_PIPESEND:
if Assigned(FOPS) then
FOPS(Self, Message.wParam, Message.lParam);
WM_PIPEMESSAGE:
begin
dwmem := GlobalSize(Message.lParam);
if (dwmem > 0) then
begin
MemStream := TMemoryStream.Create;
lpmsg := GlobalLock(Message.lParam);
try
// Copy the actual stream contents over
MemStream.Write(lpmsg^, dwmem);
MemStream.Position := 0;
// Call the OnMessage event if assigned
if Assigned(FOPM) then
FOPM(Self, Message.wParam, MemStream);
finally
MemStream.Free;
GlobalUnLock(Message.lParam);
end;
end;
GlobalFree(Message.lParam);
end;
else
// Call default window procedure
DefWindowProc(FHwnd, Message.Msg, Message.wParam, Message.lParam);
end;
end;
function TPipeServer.GetClient(Index: Integer): HPIPE;
begin
// Return the requested pipe
result := PPipeInfo(FClients[Index])^.Pipe;
end;
function TPipeServer.GetActiveClients: Integer;
begin
// Return the number of active clients
result := FClients.Count;
end;
function TPipeServer.Write(Pipe: HPIPE; var Buffer; Count: Integer): Boolean;
var
index: Integer;
ppiClient: PPipeInfo;
begin
// Set default result
result := False;
// Locate the pipe info record for the given pipe first
ppiClient := nil;
for index := FClients.Count - 1 downto 0 do
begin
// Get the pipe record and compare handles
ppiClient := FClients[index];
if (ppiClient^.Pipe = Pipe) then
break;
ppiClient := nil;
end;
// If client record is nil then raise exception
if (ppiClient = nil) or (Count > MAX_BUFFER) then
exit;
// Queue the data
ppiClient.WriteQueue.Enqueue(AllocPipeWrite(Buffer, Count));
result := True;
end;
function TPipeServer.Dequeue(Pipe: HPIPE): PPipeWrite;
var
index: Integer;
ppiClient: PPipeInfo;
begin
// Locate the pipe info record for the given pipe and dequeue the next
// available record
result := nil;
for index := FClients.Count - 1 downto 0 do
begin
// Get the pipe record and compare handles
ppiClient := FClients[index];
if (ppiClient^.Pipe = Pipe) then
begin
// Found the desired pipe record, dequeue the record and break
result := ppiClient.WriteQueue.Dequeue;
break;
end;
end;
end;
procedure TPipeServer.RemoveClient(Pipe: HPIPE);
var
index: Integer;
ppiClient: PPipeInfo;
begin
// Locate the pipe info record for the give pipe and remove it
for index := FClients.Count - 1 downto 0 do
begin
// Get the pipe record and compare handles
ppiClient := FClients[index];
if (ppiClient^.Pipe = Pipe) then
begin
// Found the desired pipe record, free it
FClients.Delete(index);
ppiClient.WriteQueue.Free;
FreeMem(ppiClient);
// Call the OnDisconnect if assigned and not in a shutdown
if not (FInShutdown) and Assigned(FOPD) then
PostMessage(FHwnd, WM_PIPEDISCONNECT, Pipe, 0);
// Break the loop
break;
end;
end;
end;
procedure TPipeServer.SetActive(Value: Boolean);
begin
// Check against current state
if (FActive <> Value) then
begin
// Shutdown if active
if FActive then
DoShutdown;
// Startup if not active
if Value then
DoStartup
end;
end;
procedure TPipeServer.SetPipeName(Value: string);
begin
// Cannot change pipe name if pipe server is active
if FActive then
raise EPipeException.CreateRes(@resPipeActive);
// Check the pipe name
CheckPipeName(Value);
// Set the new pipe name
FPipeName := Value;
end;
procedure TPipeServer.AddWorkerThread(Pipe: HPIPE);
var
ppInfo: PPipeInfo;
pstWorker: TPipeServerThread;
begin
// If there are more than 100 worker threads then we need to
// suspend the listener thread until our count decreases
if (FThreadCount > MAX_THREADS) and Assigned(FListener) then
FListener.Suspend;
// Create a new pipe info structure to manage the pipe
ppInfo := AllocMem(SizeOf(TPipeInfo));
ppInfo^.Pipe := Pipe;
ppInfo^.WriteQueue := TWriteQueue.Create;
// Add the structure to the list of pipes
FClients.Add(ppInfo);
// Resource protection
pstWorker := nil;
try
// Create the server worker thread
Inc(FThreadCount);
pstWorker := TPipeServerThread.Create(Self, Pipe, FKillEv,
ppInfo^.WriteQueue.DataEvent);
pstWorker.OnTerminate := RemoveWorkerThread;
except
// Exception during thread create, remove the client record
RemoveClient(Pipe);
// Disconnect and close the pipe handle
DisconnectNamedPipe(Pipe);
CloseHandle(Pipe);
FreeAndNil(pstWorker);
// Decrement the thread count
Dec(FThreadCount);
end;
end;
procedure TPipeServer.RemoveWorkerThread(Sender: TObject);
begin
// Remove the pipe info record associated with this thread
RemoveClient(TPipeServerThread(Sender).Pipe);
// Decrement the thread count
Dec(FThreadCount);
// If there are less than 100 worker threads then we need to
// resume the listener thread
if (FThreadCount < MAX_THREADS) and Assigned(FListener) then
FListener.Resume;
end;
procedure TPipeServer.RemoveListenerThread(Sender: TObject);
begin
// Decrement the thread count
Dec(FThreadCount);
// If we not in a shutdown, and we were the only thread, then
// change the active state
if (not (FInShutDown) and (FThreadCount = 0)) then
FActive := False;
end;
procedure TPipeServer.DoStartup;
begin
// If we are active then exit
if FActive then
exit;
// Make sure the kill event is in a non-signaled state
ResetEvent(FKillEv);
// Resource protection
try
// Create the listener thread
Inc(FThreadCount);
FListener := TPipeListenThread.Create(Self, FKillEv);
FListener.OnTerminate := RemoveListenerThread;
except
// Exception during thread create. Decrement the thread count and
// re-raise the exception
FreeAndNil(FListener);
Dec(FThreadCount);
raise;
end;
// Set active state
FActive := True;
end;
procedure TPipeServer.DoShutdown;
var
msg: TMsg;
failsafe: DWORD;
begin
// If we are not active then exit
if not (FActive) then
exit;
// Resource protection
try
// Set shutdown flag
FInShutDown := True;
// Signal the kill event
SetEvent(FKillEv);
// Wait until all threads have completed (or we hit failsafe)
failsafe := GetTickCount;
while (FThreadCount > 0) do
begin
// Process messages (which is how the threads synchronize with our thread)
if PeekMessage(msg, 0, 0, 0, PM_REMOVE) then
begin
TranslateMessage(msg);
DispatchMessage(msg);
end;
if (GetTickCount > failsafe + 10000) then
break;
end;
finally
// Set active state to false
FInShutDown := False;
FActive := False;
end;
end;
////////////////////////////////////////////////////////////////////////////////
//
// TPipeServerThread
//
////////////////////////////////////////////////////////////////////////////////
constructor TPipeServerThread.Create(PipeServer: TPipeServer; Pipe: HPIPE;
KillEvent, DataEvent: THandle);
begin
// Set starting parameters
FreeOnTerminate := True;
FPipe := Pipe;
FPipeServer := PipeServer;
FNotify := PipeServer.WindowHandle;
FErrorCode := ERROR_SUCCESS;
FPendingRead := False;
FPendingWrite := False;
FPipeWrite := nil;
FRcvSize := MIN_BUFFER;
FRcvBuffer := AllocMem(FRcvSize);
FRcvStream := TMemoryStream.Create;
FOlapRead.Offset := 0;
FOlapRead.OffsetHigh := 0;
FOlapRead.hEvent := CreateEvent(nil, True, False, nil);
FOlapWrite.hEvent := CreateEvent(nil, True, False, nil);
FEvents[0] := KillEvent;
FEvents[1] := FOlapRead.hEvent;
FEvents[2] := FOlapWrite.hEvent;
FEvents[3] := DataEvent;
// Perform inherited
inherited Create(False);
end;
destructor TPipeServerThread.Destroy;
begin
// Free the write buffer we may be holding on to
if FPendingWrite and Assigned(FPipeWrite) then
DisposePipeWrite(FPipeWrite);
// Free the receiver stream and buffer memory
FreeMem(FRcvBuffer);
FRcvStream.Free;
// Perform inherited
inherited Destroy;
end;
function TPipeServerThread.QueuedRead: Boolean;
var
bRead: Boolean;
begin
// Set default result
result := True;
// If we already have a pending read then nothing to do
if not (FPendingRead) then
begin
// Set defaults for reading
FRcvStream.Clear;
FRcvSize := MIN_BUFFER;
ReAllocMem(FRcvBuffer, FRcvSize);
// Keep reading all available data until we get a pending read or a failure
while result and not (FPendingRead) do
begin
// Perform a read
bRead := ReadFile(FPipe, FRcvBuffer^, FRcvSize, FRcvRead, @FOlapRead);
// Get the last error code
FErrorCode := GetLastError;
// Check the read result
if bRead then
begin
// We read a full message
FRcvStream.Write(FRcvBuffer^, FRcvRead);
// Call the OnData
DoMessage;
end
else
begin
// Handle cases where message is larger than read buffer used
if (FErrorCode = ERROR_MORE_DATA) then
begin
// Write the current data
FRcvStream.Write(FRcvBuffer^, FRcvSize);
// Determine how much we need to expand the buffer to
if PeekNamedPipe(FPipe, nil, 0, nil, nil, @FRcvSize) then
ReallocMem(FRcvBuffer, FRcvSize)
else
begin
// Failure
FErrorCode := GetLastError;
result := False;
end;
end
// Pending read
else
if (FErrorCode = ERROR_IO_PENDING) then
// Set pending flag
FPendingRead := True
else
// Failure
result := False;
end;
end;
end;
end;
function TPipeServerThread.CompleteRead: Boolean;
begin
// Reset the read event and pending flag
ResetEvent(FOlapRead.hEvent);
// Check the overlapped results
result := GetOverlappedResult(FPipe, FOlapRead, FRcvRead, True);
// Handle failure
if not (result) then
begin
// Get the last error code
FErrorCode := GetLastError;
// Check for more data
if (FErrorCode = ERROR_MORE_DATA) then
begin
// Write the current data
FRcvStream.Write(FRcvBuffer^, FRcvSize);
// Determine how much we need to expand the buffer to
result := PeekNamedPipe(FPipe, nil, 0, nil, nil, @FRcvSize);
if result then
begin
// Realloc mem to read in rest of message
ReallocMem(FRcvBuffer, FRcvSize);
// Read from the file again
result := ReadFile(FPipe, FRcvBuffer^, FRcvSize, FRcvRead, @FOlapRead);
// Handle error
if not (result) then
begin
// Set error code
FErrorCode := GetLastError;
// Check for pending again, which means our state hasn't changed
if (FErrorCode = ERROR_IO_PENDING) then
begin
// Bail out and wait for this operation to complete
result := True;
exit;
end;
end;
end
else
// Set error code
FErrorCode := GetLastError;
end;
end;
// Handle success
if result then
begin
// We read a full message
FRcvStream.Write(FRcvBuffer^, FRcvRead);
// Call the OnData
DoMessage;
// Reset the pending read
FPendingRead := False;
end;
end;
function TPipeServerThread.QueuedWrite: Boolean;
var
bWrite: Boolean;
begin
// Set default result
result := True;
// If we already have a pending write then nothing to do
if not (FPendingWrite) then
begin
// Check state of data event
if (WaitForSingleObject(FEvents[3], 0) = WAIT_OBJECT_0) then
begin
// Pull the data from the queue
SafeSynchronize(DoDequeue);
// Is the record assigned?
if Assigned(FPipeWrite) then
begin
// Write the data to the client
bWrite := WriteFile(FPipe, FPipeWrite^.Buffer^, FPipeWrite^.Count,
FWrite, @FOlapWrite);
// Get the last error code
FErrorCode := GetLastError;
// Check the write operation
if bWrite then
begin
// Call the OnData in the main thread
PostMessage(FNotify, WM_PIPESEND, FPipe, FWrite);
// Free the pipe write data
DisposePipeWrite(FPipeWrite);
FPipeWrite := nil;
// Reset the write event
ResetEvent(FOlapWrite.hEvent);
end
else
begin
// Only acceptable error is pending
if (FErrorCode = ERROR_IO_PENDING) then
// Set pending flag
FPendingWrite := True
else
// Failure
result := False;
end;
end;
end;
end;
end;
function TPipeServerThread.CompleteWrite: Boolean;
begin
// Reset the write event and pending flag
ResetEvent(FOlapWrite.hEvent);
// Check the overlapped results
result := GetOverlappedResult(FPipe, FOlapWrite, FWrite, True);
// Handle failure
if not (result) then
// Get the last error code
FErrorCode := GetLastError
else
// We sent a full message so call the OnSent in the main thread
PostMessage(FNotify, WM_PIPESEND, FPipe, FWrite);
// We are done either way. Make sure to free the queued pipe data
// and to reset the pending flag
if Assigned(FPipeWrite) then
begin
DisposePipeWrite(FPipeWrite);
FPipeWrite := nil;
end;
FPendingWrite := False;
end;
procedure TPipeServerThread.DoDequeue;
begin
// Get the next queued data event
FPipeWrite := FPipeServer.Dequeue(FPipe);
end;
procedure TPipeServerThread.DoMessage;
var
lpmem: DWORD;
lpmsg: PChar;
begin
// Convert the memory to global memory and send to pipe server
lpmem := GlobalAlloc(GHND, FRcvStream.Size);
lpmsg := GlobalLock(lpmem);
// Copy from the pipe
FRcvStream.Position := 0;
FRcvStream.Read(lpmsg^, FRcvStream.Size);
// Unlock the memory
GlobalUnlock(lpmem);
// Send to the pipe server to manage
PostMessage(FNotify, WM_PIPEMESSAGE, FPipe, lpmem);
// Clear the read stream
FRcvStream.Clear;
end;
procedure TPipeServerThread.Execute;
var
dwEvents: Integer;
bOK: Boolean;
begin
// Notify the pipe server of the connect
PostMessage(FNotify, WM_PIPECONNECT, FPipe, 0);
// Loop while not terminated
while not (Terminated) do
begin
// Make sure we always have an outstanding read and write queued up
bOK := (QueuedRead and QueuedWrite);
if bOK then
begin
// If we are in a pending write then we need will not wait for the
// DataEvent, because we are already waiting for a write to finish
dwEvents := 4;
if FPendingWrite then
Dec(dwEvents);
// Handle the event that was signalled (or failure)
case WaitForMultipleObjects(dwEvents, @FEvents, False, INFINITE) of
// Killed by pipe server
WAIT_OBJECT_0: Terminate;
// Read completed
WAIT_OBJECT_0 + 1: bOK := CompleteRead;
// Write completed
WAIT_OBJECT_0 + 2: bOK := CompleteWrite;
// Data waiting to be sent
WAIT_OBJECT_0 + 3: ; // Data available to write
else
// General failure
FErrorCode := GetLastError;
bOK := False;
end;
end;
// Check status
if not (bOK) then
begin
// Call OnError in the main thread if this is not a disconnect. Disconnects
// have their own event, and are not to be considered an error
if (FErrorCode <> ERROR_BROKEN_PIPE) then
PostMessage(FNotify, WM_PIPEERROR_W, FPipe, FErrorCode);
// Terminate
Terminate;
end;
end;
// Disconnect and close the pipe handle at this point. This will kill the
// overlapped events that may be attempting to access our memory blocks
// NOTE *** Ensure that the handle is STILL valid, otherwise the ntkernel
// will raise an exception
if (FErrorCode <> ERROR_INVALID_HANDLE) then
begin
DisconnectNamedPipe(FPipe);
CloseHandle(FPipe);
end;
// Close all open handles that we own
CloseHandle(FOlapRead.hEvent);
CloseHandle(FOlapWrite.hEvent);
end;
////////////////////////////////////////////////////////////////////////////////
//
// TPipeListenThread
//
////////////////////////////////////////////////////////////////////////////////
constructor TPipeListenThread.Create(PipeServer: TPipeServer; KillEvent:
THandle);
begin
// Set starting parameters
FreeOnTerminate := True;
FPipeName := PipeServer.PipeName;
FPipeServer := PipeServer;
FNotify := PipeServer.WindowHandle;
FEvents[0] := KillEvent;
InitializeSecurity(FSA);
FPipe := INVALID_HANDLE_VALUE;
FConnected := False;
FOlapConnect.Offset := 0;
FOlapConnect.OffsetHigh := 0;
FEvents[1] := CreateEvent(@FSA, True, False, nil);
;
FOlapConnect.hEvent := FEvents[1];
// Perform inherited
inherited Create(False);
end;
destructor TPipeListenThread.Destroy;
begin
// Close the connect event handle
CloseHandle(FOlapConnect.hEvent);
// Disconnect and free the handle
if (FPipe <> INVALID_HANDLE_VALUE) then
begin
if FConnected then
DisconnectNamedPipe(FPipe);
CloseHandle(FPipe);
end;
// Release memory for security structure
FinalizeSecurity(FSA);
// Perform inherited
inherited Destroy;
end;
function TPipeListenThread.CreateServerPipe: Boolean;
const
OpenMode = PIPE_ACCESS_DUPLEX or FILE_FLAG_OVERLAPPED;
PipeMode = PIPE_TYPE_MESSAGE or PIPE_READMODE_MESSAGE or PIPE_WAIT;
Instances = PIPE_UNLIMITED_INSTANCES;
begin
// Create the outbound pipe first
FPipe := CreateNamedPipe(PChar('\\.\pipe\' + FPipeName), OpenMode, PipeMode,
Instances, 0, 0, 1000, @FSA);
// Set result value based on valid handle
if (FPipe = INVALID_HANDLE_VALUE) then
FErrorCode := GetLastError
else
FErrorCode := ERROR_SUCCESS;
// Success if handle is valid
result := (FPipe <> INVALID_HANDLE_VALUE);
end;
procedure TPipeListenThread.DoWorker;
begin
// Call the pipe server on the main thread to add a new worker thread
FPipeServer.AddWorkerThread(FPipe);
end;
procedure TPipeListenThread.Execute;
begin
// Thread body
while not (Terminated) do
begin
// Set default state
FConnected := False;
// Attempt to create first pipe server instance
if CreateServerPipe then
begin
// Connect the named pipe
FConnected := ConnectNamedPipe(FPipe, @FOlapConnect);
// Handle failure
if not (FConnected) then
begin
// Check the last error code
FErrorCode := GetLastError;
// Is pipe connected?
if (FErrorCode = ERROR_PIPE_CONNECTED) then
FConnected := True
// IO pending?
else
if (FErrorCode = ERROR_IO_PENDING) then
begin
// Wait for a connect or kill signal
case WaitForMultipleObjects(2, @FEvents, False, INFINITE) of
WAIT_FAILED: FErrorCode := GetLastError;
WAIT_OBJECT_0: Terminate;
WAIT_OBJECT_0 + 1: FConnected := True;
end;
end;
end;
end;
// If we are not connected at this point then we had a failure
if not (FConnected) then
begin
// Client may have connected / disconnected simultaneously, in which
// case it is not an error. Otherwise, post the error message to the
// pipe server
if (FErrorCode <> ERROR_NO_DATA) then
PostMessage(FNotify, WM_PIPEERROR_L, FPipe, FErrorCode);
// Close the handle
CloseHandle(FPipe);
FPipe := INVALID_HANDLE_VALUE;
end
else
// Notify server of connect
SafeSynchronize(DoWorker);
end;
end;
////////////////////////////////////////////////////////////////////////////////
//
// TPipeThread
//
////////////////////////////////////////////////////////////////////////////////
procedure TPipeThread.SafeSynchronize(Method: TThreadMethod);
begin
// Exception trap
try
// Call
Synchronize(Method);
except
// Trap and eat the exception, just call terminate on the thread
Terminate;
end;
end;
////////////////////////////////////////////////////////////////////////////////
//
// TWriteQueue
//
////////////////////////////////////////////////////////////////////////////////
constructor TWriteQueue.Create;
begin
// Perform inherited
inherited Create;
// Starting values
FCount := 0;
FHead := nil;
FTail := nil;
FDataEv := CreateEvent(nil, True, False, nil);
end;
destructor TWriteQueue.Destroy;
begin
// Clear
Clear;
// Close the data event handle
CloseHandle(FDataEv);
// Perform inherited
inherited Destroy;
end;
procedure TWriteQueue.Clear;
var
node: PWriteNode;
begin
// Reset the writer event
ResetEvent(FDataEv);
// Free all the items in the stack
while Assigned(FHead) do
begin
// Get the head node and push forward
node := FHead;
FHead := FHead^.NextNode;
// Free the pipe write data
DisposePipeWrite(node^.PipeWrite);
// Free the queued node
FreeMem(node);
end;
// Set the tail to nil
FTail := nil;
// Reset the count
FCount := 0;
end;
function TWriteQueue.NewNode(PipeWrite: PPipeWrite): PWriteNode;
begin
// Allocate memory for new node
result := AllocMem(SizeOf(TWriteNode));
// Set the structure fields
result^.PipeWrite := PipeWrite;
result^.NextNode := nil;
// Increment the count
Inc(FCount);
end;
procedure TWriteQueue.Enqueue(PipeWrite: PPipeWrite);
var
node: PWriteNode;
begin
// Create a new node
node := NewNode(PipeWrite);
// Make this the last item in the queue
if (FTail = nil) then
FHead := node
else
FTail^.NextNode := node;
// Update the new tail
FTail := node;
// Set the write event to signalled
SetEvent(FDataEv);
end;
function TWriteQueue.Dequeue: PPipeWrite;
var
node: PWriteNode;
begin
// Remove the first item from the queue
if not (Assigned(FHead)) then
result := nil
else
begin
// Set the return data
result := FHead^.PipeWrite;
// Move to next node, update head (possibly tail), then free node
node := FHead;
if (FHead = FTail) then
FTail := nil;
FHead := FHead^.NextNode;
// Free the memory for the node
FreeMem(node);
Dec(FCount);
end;
// Reset the write event if no more data records to write
if (FCount = 0) then
ResetEvent(FDataEv);
end;
////////////////////////////////////////////////////////////////////////////////
//
// Utility functions
//
////////////////////////////////////////////////////////////////////////////////
function AllocPipeWrite(const Buffer; Count: Integer): PPipeWrite;
begin
// Allocate memory for the result
result := AllocMem(SizeOf(TPipeWrite));
// Set the count of the buffer
result^.Count := Count;
// Allocate enough memory to store the data buffer, then copy the data over
result^.Buffer := AllocMem(Count);
System.Move(Buffer, result^.Buffer^, Count);
end;
procedure DisposePipeWrite(PipeWrite: PPipeWrite);
begin
// Dispose of the memory being used by the pipe write structure
if Assigned(PipeWrite^.Buffer) then
FreeMem(PipeWrite^.Buffer);
// Free the memory record
FreeMem(PipeWrite);
end;
procedure CheckPipeName(Value: string);
begin
// Validate the pipe name
if (Pos('\', Value) > 0) or
(Length(Value) > 63) or
(Length(Value) = 0) then
begin
raise EPipeException.CreateRes(@resBadPipeName);
end;
end;
procedure InitializeSecurity(var SA: TSecurityAttributes);
var
sd: PSecurityDescriptor;
begin
// Allocate memory for the security descriptor
sd := AllocMem(SECURITY_DESCRIPTOR_MIN_LENGTH);
// Initialise the new security descriptor
InitializeSecurityDescriptor(sd, SECURITY_DESCRIPTOR_REVISION);
// Add a NULL descriptor ACL to the security descriptor
SetSecurityDescriptorDacl(sd, True, nil, False);
// Set up the security attributes structure
with SA do
begin
nLength := SizeOf(TSecurityAttributes);
lpSecurityDescriptor := sd;
bInheritHandle := True;
end;
end;
procedure FinalizeSecurity(var SA: TSecurityAttributes);
begin
// Release memory that was assigned to security descriptor
if Assigned(SA.lpSecurityDescriptor) then
begin
FreeMem(SA.lpSecurityDescriptor);
SA.lpSecurityDescriptor := nil;
end;
end;
procedure Register;
begin
// Register the components under the Win32 tab
RegisterComponents('Win32', [TPipeServer, TPipeClient]);
end;
end. |