This file is indexed.

/usr/share/doc/ucommon-doc/html/a00554.html is in ucommon-doc 7.0.0-9.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>UCommon: commoncpp/tokenizer.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">UCommon
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_8bb253d68c4ad658f2af679087a115ee.html">commoncpp</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">tokenizer.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>string tokenizer.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;commoncpp/config.h&gt;</code><br />
<code>#include &lt;<a class="el" href="a00974_source.html">commoncpp/thread.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="a00524_source.html">commoncpp/exception.h</a>&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for tokenizer.h:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00555.svg" width="3796" height="1232"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00556.svg" width="210" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
<p><a href="a00554_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a616f43b1bfc7852c54abf7d6301a2946"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00509.html#a616f43b1bfc7852c54abf7d6301a2946">ost::__attribute__</a> ((visibility(&quot;default&quot;))) IPV4Validator</td></tr>
<tr class="memdesc:a616f43b1bfc7852c54abf7d6301a2946"><td class="mdescLeft">&#160;</td><td class="mdescRight">Classes derived from IPV4Address would require an specific validator to pass to the IPV4Address constructor.  <a href="a00509.html#a616f43b1bfc7852c54abf7d6301a2946">More...</a><br /></td></tr>
<tr class="separator:a616f43b1bfc7852c54abf7d6301a2946"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>string tokenizer. </p>

<p>Definition in file <a class="el" href="a00554_source.html">tokenizer.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="file_a616f43b1bfc7852c54abf7d6301a2946"></a>
<h2 class="memtitle"><span class="permalink"><a href="#file_a616f43b1bfc7852c54abf7d6301a2946">&sect;&nbsp;</a></span>__attribute__()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">class ost::__attribute__ </td>
          <td>(</td>
          <td class="paramtype">(visibility(&quot;default&quot;))&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Classes derived from IPV4Address would require an specific validator to pass to the IPV4Address constructor. </p>
<p>An exclusive locking protocol interface base.</p>
<p>XML streaming parser.</p>
<p>Splits delimited string into tokens.</p>
<p>Timer ports are used to provide synchronized timing events when managed under a "service thread" such as SocketService.</p>
<p>This class is used to access non-reentrant date and time functions in the standard C library.</p>
<p>The SemaphoreLock class is used to protect a section of code through a semaphore so that only x instances of the member function may execute concurrently.</p>
<p>The WriteLock class is used to protect a section of code through a ThreadLock for "write" access to the member function.</p>
<p>The ReadLock class is used to protect a section of code through a ThreadLock for "read" access to the member function.</p>
<p>The Mutex Counter is a counter variable which can safely be incremented or decremented by multiple threads.</p>
<p>The slog class is used to stream messages to the system's logging facility (syslogd).</p>
<p>The Serial class is used as the base for all serial I/O services under APE.</p>
<p>This class is used to create a "named" lock entity that can be used to control access to a resource between multiple processes.</p>
<p>A class for containing portable process related functions that help create portable code.</p>
<p>Stream serialization of persistent classes.</p>
<p>PersistObject.</p>
<p>Type manager for persistence engine.</p>
<p>The MapObject is a base class which can be used to make a derived class operate on a MapTable.</p>
<p>A map table allows for entities to be mapped (hash index) onto it.</p>
<p>Self managed double linked list object chain.</p>
<p>Self managed single linked list object chain.</p>
<p>Pointer to reference counted objects.</p>
<p>A reference countable object.</p>
<p>The shared mempager uses a mutex to protect key access methods.</p>
<p>The Multipart form is a MIME multipart document specific for the construction and delivery of form data to a web server through a post method.</p>
<p>A container class for multi-part MIME document objects which can be streamed to a std::ostream destination.</p>
<p>The purpose of this class is to define a base class for low level random file access that is portable between Win32 and Posix systems.</p>
<p>A low level portable directory class.</p>
<p>alog global log stream definition</p>
<p>Manipulator for info level.</p>
<p>Manipulator for notice level.</p>
<p>Manipulator for critical level.</p>
<p>Manipulator for alert level.</p>
<p>Manipulator for emerg level.</p>
<p>Manipulator for error level.</p>
<p>Manipulator for warn level.</p>
<p>Application logger is a class that implements a logger that can be used by applications to save log file somewhere on the system.</p>
<p>Produces a dump of a buffer in a hexdump way with its code Ascii translation and relative buffer address.</p>
<p>Classes derived from IPV6Address would require an specific validator to pass to the IPV6Address constructor.</p>
<p>The network name and address objects are all derived from a common IPV4Address base class.</p>
<p>The CIDR class is used to support routing tables and validate address policies.</p>
<p>Class for the function object that validates multicast addresses.</p>
<p>This is a base class for classes of function objects used by such derived classes.</p>
<dl class="section author"><dt>Author</dt><dd>Federico Montesino <a href="#" onclick="location.href='mai'+'lto:'+'p50'+'87'+'@qu'+'in'+'ter'+'o.'+'fie'+'.u'+'s.e'+'s'; return false;">p5087<span style="display: none;">.nosp@m.</span>@qui<span style="display: none;">.nosp@m.</span>ntero<span style="display: none;">.nosp@m.</span>.fie<span style="display: none;">.nosp@m.</span>.us.e<span style="display: none;">.nosp@m.</span>s</a> Abstract base class for derived inet addresses validators.</dd></dl>
<p>Implements a specific application operator to validate multicast addresses.</p>
<dl class="section author"><dt>Author</dt><dd>Federico Montesino <a href="#" onclick="location.href='mai'+'lto:'+'p50'+'87'+'@qu'+'in'+'ter'+'o.'+'fie'+'.u'+'s.e'+'s'; return false;">p5087<span style="display: none;">.nosp@m.</span>@qui<span style="display: none;">.nosp@m.</span>ntero<span style="display: none;">.nosp@m.</span>.fie<span style="display: none;">.nosp@m.</span>.us.e<span style="display: none;">.nosp@m.</span>s</a> Validating class specialized for multicast addresses. The CIDR class is used to support routing tables and validate address policies.</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Classless Internet Domain Routing</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Classless Internet Domain Routing</dd></dl>
<p>Specific classes, such as IPV4Host, IPV4Mask, etc, are defined from IPV4Address entirely so that the manner a network address is being used can easily be documented and understood from the code and to avoid common errors and accidental misuse of the wrong address object. For example, a "connection" to something that is declared as a "IPV4Host" can be kept type-safe from a "connection" accidently being made to something that was declared a "IPV4Broadcast".</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Internet Address binary data type.</dd></dl>
<p>Implements a specific application operator to validate multicast addresses.</p>
<dl class="section author"><dt>Author</dt><dd>Federico Montesino <a href="#" onclick="location.href='mai'+'lto:'+'p50'+'87'+'@qu'+'in'+'ter'+'o.'+'fie'+'.u'+'s.e'+'s'; return false;">p5087<span style="display: none;">.nosp@m.</span>@qui<span style="display: none;">.nosp@m.</span>ntero<span style="display: none;">.nosp@m.</span>.fie<span style="display: none;">.nosp@m.</span>.us.e<span style="display: none;">.nosp@m.</span>s</a> Validating class specialized for multicast addresses. The network name and address objects are all derived from a common IPV6Address base class. Specific classes, such as IPV4Host, IPV6Mask, etc, are defined from IPV6Address entirely so that the manner a network address is being used can easily be documented and understood from the code and to avoid common errors and accidental misuse of the wrong address object. For example, a "connection" to something that is declared as a "IPV6Host" can be kept type-safe from a "connection" accidently being made to something that was declared a "IPV6Broadcast".</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Internet Address binary data type.</dd></dl>
<p>For instance: 0000000 - 77 98 21 49 0e 00 05 00 40 1c 01 1c 2f 00 00 00 w.!I......./...</p>
<p>It uses ost::slog to write to syslog and std::clog to write to standard output.</p>
<p>It provides either a stream oriented logger or a old printf style one.</p>
<p>It can be used to log directly on a file or in a spooler like way. Latter uses a ost::ThreadQueue to implement a thread safe access to logger.</p>
<p>It provides a global stream variable called ost::alog.</p>
<p>It provides an AppLog::Ident class that represents a module name for instance that can be used to tag logs. Logging levels are the same defined into ost::Slog: Slog::levelEmergency Slog::levelAlert Slog::levelCritical Slog::levelError Slog::levelWarning Slog::levelNotice Slog::levelInfo Slog::levelDebugfrom.</p>
<p>Example of usage: alog &lt;&lt; mod_name &lt;&lt; debug &lt;&lt; "Hello world!" &lt;&lt; std::endl; Manipulator for debug level </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sl</td><td>application logger stream </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>application logger stream</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sl</td><td>application logger stream </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>application logger stream</dd></dl>
<p>Used to support ccstd Directory container. This provides a basic mechanism for allocating and accessing file entries.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> low level directory access class. A generic class to walk a hierarchical directory structure.</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Directory tree walking.</dd></dl>
<p>This class is a foundation both for optimized thread shared and traditional locked file access that is commonly used to build database services, rather than the standard C++ streaming file classes.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Portable random disk file access. This class defines a database I/O file service that can be shared by multiple processes. Each thread should access a dup of the database object, and mutex locks can be used to preserve transaction integrety if multiple threads are used.</dd></dl>
<p>SharedFile is used when a database may be shared between multiple processes. SharedFile automatically applies low level byte-range "file
locks", and provides an interface to fetch and release byte-range locked portions of a file.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> This class defines a database I/O file service that can be shared by multiple processes. Create and map a disk file into memory. This portable class works under both Posix via mmap and under the win32 API. A mapped file can be referenced directly by it's memory segment. One can map and unmap portions of a file on demand, and update changed memory pages mapped from files immediately through sync().</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Map a named disk file into memory. The DSO dynamic loader class is used to load object files. On elf based systems this is typically done with dlopen. A dummy stub class is generated for non-dl capable systems.</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Dynamic class file loader.</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> container for streamable multi-part MIME documents.</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> deliver form results as multipart document. This is used to attach an item part to a MIME multipart document that is being streamed. The base item part class is used by all derived items.</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> item or part of a multi-part object.</dd></dl>
<p>This class is used when a mempager will be shared by multiple threads.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> mutex protected memory pager. This class is used to associate (object) pointers with named strings. A virtual is used to allocate memory which can be overriden in the derived class.</dd>
<dd>
David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> associate names with pointers.</dd></dl>
<p>This is used in association with smart pointers (RefPointer).</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Object managed by smart pointer reference count.</dd></dl>
<p>This is a non-template form of a reference count smart pointer, and so uses common code. This can be subclassed to return explicit object types.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Pointer to reference count managed objects.</dd></dl>
<p>This is used for accumulating lists by using as a base class for a derived subclass.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Accumulating single linked list.</dd></dl>
<p>This is used for accumulating lists by using as a base class for a derived subclass.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Accumulating double linked list.</dd></dl>
<p>Unlike with Assoc, This form of map table also allows objects to be removed from the table. This table also includes a mutex lock for thread safety. A free list is also optionally maintained for reusable maps.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Table to hold hash indexed objects. The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key. It can be increased, checked and dereferenced like a pointer, by means of suitable operators.</dd>
<dd>
Sergio Repetto <a href="#" onclick="location.href='mai'+'lto:'+'s.r'+'ep'+'ett'+'o@'+'pen'+'ta'+'eng'+'in'+'eer'+'in'+'g.i'+'t'; return false;">s.rep<span style="display: none;">.nosp@m.</span>etto<span style="display: none;">.nosp@m.</span>@pent<span style="display: none;">.nosp@m.</span>aeng<span style="display: none;">.nosp@m.</span>ineer<span style="display: none;">.nosp@m.</span>ing.<span style="display: none;">.nosp@m.</span>it</a> Index object to access MapTable elements</dd></dl>
<p>Derived classes may override new and delete operators to use managed free list from a MapTable.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> Mappable object.</dd></dl>
<p>This class manages the types for generation of the persistent objects. Its data structures are managed automatically by the system. They are implicitly filled by the constructors who declare classes to the system.</p>
<dl class="section author"><dt>Author</dt><dd>Daniel Silverstone</dd></dl>
<p>Base class for classes that will be persistent. This object is the base for all Persistent data which is not natively serialized by the persistence::engine</p>
<p>It registers itself with the persistence::TypeManager using a global constructor function. A matching deregister call is made in a global destructor, to allow DLL's to use the persistence::engine in a main executable.</p>
<p>Persistable objects must never maintain bad pointers. If a pointer doesn't point to something valid, it must be NULL. This is so the persistence engine knows whether to allocate memory for an object or whether the memory has been pre-allocated.</p>
<dl class="section author"><dt>Author</dt><dd>Daniel Silverstone</dd></dl>
<p>This class constructs on a standard C++ STL stream and then operates in the mode specified. The stream passed into the constructor must be a binary mode to function properly.</p>
<dl class="section author"><dt>Author</dt><dd>Daniel Silverstone</dd></dl>
<p>These are typically referenced thru Process::xxx static member functions. Many of these members are used both for win32 and posix systems although some may be platform specific.</p>
<p>Peocess wrapper class. </p><dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a></dd></dl>
<p>The posix implimentation uses a pidfile and the win32 version uses a globally visible mutex.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> System-wide named lock</dd></dl>
<p>A serial is a system serial port that is used either for line or packet based data input. Serial ports may also be "streamable" in a derived form.</p>
<p>Common C++ serial I/O classes are used to manage serial devices and implement serial device protocols. From the point of view of Common C++, serial devices are supported by the underlying Posix specified "termios" call interface.</p>
<p>The serial I/O base class is used to hold a descriptor to a serial device and to provide an exception handling interface for all serial I/O classes. The base class is also used to specify serial I/O properties such as communication speed, flow control, data size, and parity. The "Serial" base class is not itself directly used in application development, however.</p>
<p>Common C++ Serial I/O is itself divided into two conceptual modes; frame oriented and line oriented I/O. Both frame and line oriented I/O makes use of the ability of the underlying tty driver to buffer data and return "ready" status from when select either a specified number of bytes or newline record has been reached by manipulating termios c_cc fields appropriately. This provides some advantage in that a given thread servicing a serial port can block and wait rather than have to continually poll or read each and every byte as soon as it appears at the serial port.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> base class for all serial I/O services.</dd></dl>
<p>A default <code>slog</code> object is used to avoid confusion with the native syslog facility and to imply a logical relationship to the C++ <code>clog()</code>.</p>
<p>The key difference is that the <code>slog</code> object sends it's output to the system logging daemon (typically syslogd) rather than through stderr. <code>slog</code> can be streamed with the <code>&lt;&lt;</code> operator just like <code>clog</code>; a default slog object is pre-initialized, and you stream character data to it.</p>
<p>The <code>slog</code> allows one to specify logging levels and other properties through the <code>()</code> operators. Hence, once can do:</p>
<p><code></p><pre>
slog("mydaemon", SLOG_DAEMON, SLOG_EMERGENCY) &lt;&lt; I just died &lt;&lt; endl; </pre><p></code></p>
<p>or things like:</p>
<p><code></p><pre>
slog("mydaemon", SLOG_DAEMON);
slog(SLOG_INFO) &lt;&lt; "daemon initalized" &lt;&lt; endl; </pre><p></code></p>
<p>The intent is to be as common-place and as convenient to use as the stderr based clog facility found in C++, and this is especially useful for C++ daemons.</p>
<p>The <code>std::flush</code> manipulator doesn't work. Either the <code>std::endl</code> or <code>std::ends</code> manipulators must be used to cause the output to be sent to the daemon.</p>
<p>When this class is used on a system that doesn't have the syslog headers (i.e. a non-posix win32 box), the output goes to the a file with the same name as the syslog identifier string with '.log' appended to it. If the identifier string ends in '.exe', the '.exe' is removed before the '.log' is appened. (e.g. the identifier foo.exe will generate a log file named foo.log)</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> <br />
Minor docs &amp; hacks by Jon Little <a href="#" onclick="location.href='mai'+'lto:'+'lit'+'tl'+'ej@'+'ar'+'lut'+'.u'+'tex'+'as'+'.ed'+'u'; return false;">littl<span style="display: none;">.nosp@m.</span>ej@a<span style="display: none;">.nosp@m.</span>rlut.<span style="display: none;">.nosp@m.</span>utex<span style="display: none;">.nosp@m.</span>as.ed<span style="display: none;">.nosp@m.</span>u</a></dd></dl>
<p>system logging facility class.</p>
<p>A Mutex is used to protect access to the counter variable (an integer). An initial value can be specified for the counter, and it can be manipulated with the ++ and &ndash; operators.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> Thread protected integer counter. The MutexLock class is used to protect a section of code so that at any given time only a single thread can perform the protected operation.</dd></dl>
<p>It use Mutex to protect operation. Using this class is usefull and exception safe. The mutex that has been locked is automatically released when the function call stack falls out of scope, so one doesnt have to remember to unlock the mutex at each function return.</p>
<p>A common use is</p>
<p>void func_to_protect() { MutexLock lock(mutex); ... operation ... }</p>
<p>NOTE: do not declare variable as "MutexLock (mutex)", the mutex will be released at statement end.</p>
<dl class="section author"><dt>Author</dt><dd>Frediano Ziglio <a href="#" onclick="location.href='mai'+'lto:'+'fre'+'dd'+'y77'+'@a'+'nge'+'lf'+'ire'+'.c'+'om'; return false;">fredd<span style="display: none;">.nosp@m.</span>y77@<span style="display: none;">.nosp@m.</span>angel<span style="display: none;">.nosp@m.</span>fire<span style="display: none;">.nosp@m.</span>.com</a> Mutex automatic locker for protected access.</dd></dl>
<p>The ThreadLock is automatically released when the object falls out of scope.</p>
<p>A common use is</p>
<p>void func_to_protect() { ReadLock lock(threadlock); ... operation ... }</p>
<p>NOTE: do not declare variable as "ReadLock (threadlock)", the mutex will be released at statement end.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'u.'+'org'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>.org</a> Read mode automatic locker for protected access.</dd></dl>
<p>The ThreadLock is automatically released when the object falls out of scope.</p>
<p>A common use is</p>
<p>void func_to_protect() { WriteLock lock(threadlock); ... operation ... }</p>
<p>NOTE: do not declare variable as "WriteLock (threadlock)", the mutex will be released at statement end.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'u.'+'org'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>.org</a> Read mode automatic locker for protected access.</dd></dl>
<p>A common use is</p>
<p>void func_to_protect() { SemaphoreLock lock(semaphore); ... operation ... }</p>
<p>NOTE: do not declare variable as "SemaohoreLock (semaphore)", the mutex will be released at statement end.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'u.'+'org'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>.org</a> Semaphore automatic locker for protected access.</dd></dl>
<p>The class has two purposes:</p><ul>
<li>1 To be used internaly in CommonCpp's date and time classes to make them thread safe.</li>
<li>2 To be used by clients as thread safe replacements to the standard C functions, much like Thread::sleep() represents a thread safe version of the standard sleep() function.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>The class provides one function with the same name as its equivalent standard function and one with another, unique name. For new clients, the version with the unique name is recommended to make it easy to grep for accidental usage of the standard functions. The version with the standard name is provided for existing clients to sed replace their original version.</dd>
<dd>
Also note that some functions that returned pointers have been redone to take that pointer as an argument instead, making the caller responsible for memory allocation/deallocation. This is almost how POSIX specifies *_r functions (reentrant versions of the standard time functions), except the POSIX functions also return the given pointer while we do not. We don't use the *_r functions as they aren't all generally available on all platforms yet.</dd></dl>
<dl class="section author"><dt>Author</dt><dd>Idar Tollefsen <a href="#" onclick="location.href='mai'+'lto:'+'ida'+'r@'+'cog'+'ni'+'ta.'+'no'; return false;">idar@<span style="display: none;">.nosp@m.</span>cogn<span style="display: none;">.nosp@m.</span>ita.n<span style="display: none;">.nosp@m.</span>o</a> Thread safe date and time functions.</dd></dl>
<p>This is made into a stand-alone base class since other derived libraries (such as the serial handlers) may also use the pooled "service thread" model and hence also require this code for managing timing.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> synchronized millisecond timing for service threads.</dd></dl>
<p>The StringTokenizer takes a pointer to a string and a pointer to a string containing a number of possible delimiters. The StringTokenizer provides an input forward iterator which allows to iterate through all tokens. An iterator behaves like a logical pointer to the tokens, i.e. to shift to the next token, you've to increment the iterator, you get the token by dereferencing the iterator.</p>
<p>Memory consumption: This class operates on the original string and only allocates memory for the individual tokens actually requested, so this class allocates at maximum the space required for the longest token in the given string. Since for each iteration, memory is reclaimed for the last token, you MAY NOT store pointers to them; if you need them afterwards, copy them. You may not modify the original string while you operate on it with the StringTokenizer; the behaviour is undefined in that case.</p>
<p>The iterator has one special method 'nextDelimiter()' which returns a character containing the next delimiter following this tokenization process or '\0', if there are no following delimiters. In case of skipAllDelim, it returns the FIRST delimiter.</p>
<p>With the method 'setDelimiters(const char*)' you may change the set of delimiters. It affects all running iterators.</p>
<p>Example: <code></p><pre>
 StringTokenizer st("mary had a little lamb;its fleece was..", " ;");
 StringTokenizer::iterator i;
 for (i = st.begin() ; i != st.end() ; ++i) {
       cout &lt;&lt; "Token: '" &lt;&lt; *i &lt;&lt; "'\t";
       cout &lt;&lt; " next Delim: '" &lt;&lt; i.nextDelimiter() &lt;&lt; "'" &lt;&lt; endl;
 }
 </pre><p></code></p>
<dl class="section author"><dt>Author</dt><dd>Henner Zeller <a href="#" onclick="location.href='mai'+'lto:'+'H.Z'+'el'+'ler'+'@a'+'cm.'+'or'+'g'; return false;">H.Zel<span style="display: none;">.nosp@m.</span>ler@<span style="display: none;">.nosp@m.</span>acm.o<span style="display: none;">.nosp@m.</span>rg</a> </dd></dl>
<dl class="section user"><dt>License:</dt><dd>LGPL</dd></dl>
<p>This class implements a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods. This class must be derived into one that can implement the physical I/O required to parse actual data. A mixer class using XMLParser and tcpstream would be one example of this. This can also be used to parse xml content in memory buffers easily. This parser is only concerned with well-formedness, and does not perform validation.</p>
<dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@gn'+'ut'+'ele'+'ph'+'ony'+'.o'+'rg'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@gnu<span style="display: none;">.nosp@m.</span>telep<span style="display: none;">.nosp@m.</span>hony<span style="display: none;">.nosp@m.</span>.org</a> </dd></dl>
<p>Constructor. Does not deal with any state.</p>
<p>keeps compilers happy.</p>
<p>Pure virtual application operator. Apply the validation algorithm specific to derived classes.</p>
<p>Get network address associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded address.</dd></dl>
<p>Get network mask associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network mask.</dd></dl>
<p>Compute the broadcast address associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network address.</dd></dl>
<p>Set the cidr from a full or partial hostname, or from an address/mask, or a host/bits specification.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>string to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct a new cidr from a string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>string to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct an empty cidr.</p>
<p>Construct a copy of a cidr.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>to copy from.</td></tr>
  </table>
  </dd>
</dl>
<p>See if a socket address is a member of this cidr's network.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">saddr</td><td>pointer to test. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr.</dd></dl>
<p>See if a low level address object is a member of this cidr's net.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inaddr</td><td>object to test. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr.</dd></dl>
<p>Get network address associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded address.</dd></dl>
<p>Get network mask associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network mask.</dd></dl>
<p>Compute the broadcast address associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network address.</dd></dl>
<p>Set the cidr from a full or partial hostname, or from a host/bits specification.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>string to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct a new cidr from a string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>string to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct an empty cidr.</p>
<p>Construct a copy of a cidr.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>to copy from.</td></tr>
  </table>
  </dd>
</dl>
<p>See if a socket address is a member of this cidr's network.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">saddr</td><td>pointer to test. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr.</dd></dl>
<p>See if a low level address object is a member of this cidr's net.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inaddr</td><td>object to test. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr.</dd></dl>
<p>Sets the IP address from a string representation of the numeric address, ie "127.0.0.1"</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>The string representation of the IP address </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful</dd></dl>
<p>Used to specify a host name or numeric internet address.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>The string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY</td></tr>
  </table>
  </dd>
</dl>
<p>Create an Internet Address object with an empty (0.0.0.0) address.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Convert the system internet address data type (struct in_addr) into a Common C++ IPV4Address object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>struct of system used binary internet address. </td></tr>
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Convert a null terminated ASCII host address string (example: "127.0.0.1") or host address name (example: "www.voxilla.org") directly into a Common C++ IPV4Address object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">address</td><td>null terminated C string. </td></tr>
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Copy constructor</p>
<p>Destructor</p>
<p>Provide a string representation of the value (Internet Address) held in the IPV4Address object.</p>
<dl class="section return"><dt>Returns</dt><dd>string representation of IPV4Address.</dd></dl>
<p>May be used to verify if a given IPV4Address returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" IPV4Address values.</p>
<dl class="section return"><dt>Returns</dt><dd>true if address != 0.0.0.0.</dd></dl>
<p>Provide a low level system usable struct in_addr object from the contents of IPV4Address. This is needed for services such as bind() and connect().</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address.</dd></dl>
<p>Provide a low level system usable struct in_addr object from the contents of IPV4Address. This is needed for services such as bind() and connect().</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>for IPV4Addresses with multiple addresses, returns the address at this index. User should call getAddressCount() to determine the number of address the object contains. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address. If parameter i is out of range, the first address is returned.</dd></dl>
<p>Returns the number of internet addresses that an IPV4Address object contains. This usually only happens with IPV4Host objects where multiple IP addresses are returned for a DNS lookup</p>
<p>Allows assignment from the return of functions like inet_addr() or htonl()</p>
<p>Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host).</p>
<p>If there is more than one IP address in either IPV4Address object, this will return true if all of the IP addresses in the smaller are in the larger in any order.</p>
<p>Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses).</p>
<p>This is implimented in terms of operator==</p>
<p>Constructor. Does not deal with any state.</p>
<p>Keeps compilers happy.</p>
<p>Pure virtual application operator. Apply the validation algorithm specific to derived classes.</p>
<p>Sets the IP address from a string representation of the numeric address, ie "127.0.0.1"</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>The string representation of the IP address </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful</dd></dl>
<p>Used to specify a host name or numeric internet address.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>The string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY</td></tr>
  </table>
  </dd>
</dl>
<p>Create an Internet Address object with an empty (0.0.0.0) address.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Convert the system internet address data type (struct in_addr) into a Common C++ IPV6Address object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>struct of system used binary internet address. </td></tr>
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Convert a null terminated ASCII host address string (example: "127.0.0.1") or host address name (example: "www.voxilla.org") directly into a Common C++ IPV6Address object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">address</td><td>null terminated C string. </td></tr>
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Copy constructor</p>
<p>Destructor</p>
<p>Provide a string representation of the value (Internet Address) held in the IPV6Address object.</p>
<dl class="section return"><dt>Returns</dt><dd>string representation of IPV6Address.</dd></dl>
<p>May be used to verify if a given IPV6Address returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" IPV6Address values.</p>
<dl class="section return"><dt>Returns</dt><dd>true if address != 0.0.0.0.</dd></dl>
<p>Provide a low level system usable struct in_addr object from the contents of IPV6Address. This is needed for services such as bind() and connect().</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address.</dd></dl>
<p>Provide a low level system usable struct in_addr object from the contents of IPV6Address. This is needed for services such as bind() and connect().</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>for IPV6Addresses with multiple addresses, returns the address at this index. User should call getAddressCount() to determine the number of address the object contains. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address. If parameter i is out of range, the first address is returned.</dd></dl>
<p>Returns the number of internet addresses that an IPV6Address object contains. This usually only happens with IPV6Host objects where multiple IP addresses are returned for a DNS lookup</p>
<p>Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host).</p>
<p>If there is more than one IP address in either IPV6Address object, this will return true if all of the IP addresses in the smaller are in the larger in any order.</p>
<p>Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses).</p>
<p>This is implimented in terms of operator==</p>
<p>output string</p>
<p>HEXdump constructor.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>buffer to be "hexdumped" </td></tr>
    <tr><td class="paramname">buff_len</td><td>buffer length </td></tr>
    <tr><td class="paramname">max_len</td><td>max number of bytes to be "hexdumped". Usefull to truncate output. mas_len=0 does prints all.</td></tr>
  </table>
  </dd>
</dl>
<p>HEXdump destructor.</p>
<p>const char* cast provided for conveneince.</p>
<p>string cast provided for conveneince.</p>
<p>operator &lt;&lt; </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">hd</td><td>hexdump. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>application logger stream</dd></dl>
<p>Virtual method to filter results. Virtual override methods should call baseclass method to assure . and .. names are stripped out.</p>
<dl class="section return"><dt>Returns</dt><dd>true if current filename is accepted. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">file</td><td>path to examine </td></tr>
    <tr><td class="paramname">ino</td><td>info of type, date, etc.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct a directory tree walk starting at the specified prefix. A maximum subdirectory depth is also specified.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">prefix</td><td>to start walk. </td></tr>
    <tr><td class="paramname">maxdepth</td><td>subdirectory depth to examine.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct an un-opened directory tree of a known maximum depth</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">maxdepth</td><td>subdirectory subdirectory depth.</td></tr>
  </table>
  </dd>
</dl>
<p>Open a directory tree path.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">prefix</td><td>directory path to open.</td></tr>
  </table>
  </dd>
</dl>
<p>Close the directory path.</p>
<p>Extract the next full pathname from the directory walk. When returning directories, a '/' is appended. The returned string is a buffer of MAX_PATH size.</p>
<dl class="section return"><dt>Returns</dt><dd>path of next subdirectory entry or NULL.</dd></dl>
<p>This is used to step through the filter virtual for an entire subtree, and is used for cases where a derived DirTree class performs it's primary operations through filter rather than externally by calling getPath().</p>
<dl class="section return"><dt>Returns</dt><dd>number of files and directories examined. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">prefix</td><td>directory path to examine.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct and load a DSO object file.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>pathname of object file to load.</td></tr>
  </table>
  </dd>
</dl>
<p>Retrieve error indicator associated with DSO failure. This is often used in catch handlers.</p>
<p>Detach a DSO object from running memory.</p>
<p>Lookup a symbol in the loaded file.</p>
<p>Find a specific DSO object by filename.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of DSO object file (partial).</td></tr>
  </table>
  </dd>
</dl>
<p>See if DSO object is valid.</p>
<dl class="section return"><dt>Returns</dt><dd>true if valid.</dd></dl>
<p>Install debug handler...</p>
<p>Contruct a multi-part document, and describe it's type.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">document</td><td>(content) type.</td></tr>
  </table>
  </dd>
</dl>
<p>Stream the headers of the multi-part document. The headers of individual entities are streamed as part of the body.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output</td><td>to stream document header into.</td></tr>
  </table>
  </dd>
</dl>
<p>Stream the "body" of the multi-part document. This involves streaming the headers and body of each document part.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output</td><td>to stream document body into.</td></tr>
  </table>
  </dd>
</dl>
<p>Get a string array of the headers to use. This is used to assist URLStream::post.</p>
<dl class="section return"><dt>Returns</dt><dd>array of headers.</dd></dl>
<p>Stream the header(s) for the current document part.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output</td><td>to stream header into.</td></tr>
  </table>
  </dd>
</dl>
<p>Stream the content of this document part.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output</td><td>to stream document body into.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct and attach a document part to a multipart document.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">top</td><td>multipart document to attach to. </td></tr>
    <tr><td class="paramname">ct</td><td>Content-Type to use.</td></tr>
  </table>
  </dd>
</dl>
<p>The constructor simply initializes the count.</p>
<p>The destructor is called when the reference count returns to zero. This is done through a virtual destructor.</p>
<p>The actual object being managed can be returned by this method as a void and then recast to the actual type. This removes the need to dynamic cast from RefObject and the dependence on rtti this implies.</p>
<dl class="section return"><dt>Returns</dt><dd>underlying object being referenced.</dd></dl>
<p>Detach current object, for example, when changing pointer.</p>
<p>Patch point for mutex in derived class. This may often be a single static mutex shared by a managed type.</p>
<p>Patch point for a mutex in derived class. This may often be a single static mutex shared by a managed type.</p>
<p>Create an unattached pointer.</p>
<p>Create a pointer attached to a reference counted object.</p>
<p>Object being referenced.</p>
<p>A copy constructor.</p>
<p>Pointer being copied.</p>
<p>Get first linked object in list. This may be dynamically recast, and may refer to a master static bookmark pointer in a derived class. Otherwise it simply returns the current object. In a "free" list, this may not only return the first object, but also set the first to next.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to first object in list.</dd></dl>
<p>Gets the last object in the list. This normally follows the links to the end. This is a virtual because derived class may include a static member bookmark for the current end.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to last object in list.</dd></dl>
<p>Get next object, for convenience. Derived class may use this with a dynamic cast.</p>
<dl class="section return"><dt>Returns</dt><dd>next object in list.</dd></dl>
<p>Insert object into chain. This is a virtual because derived class may choose instead to perform an insert at head or tail, may manage bookmarks, and may add mutex lock.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">object</td><td>being inserted.</td></tr>
  </table>
  </dd>
</dl>
<p>Requested in overloaded insert() method to indicate how to insert data into list</p>
<p>&lt; insert at first position in list pointed by current object</p>
<p>&lt; insert at last position in list pointed by current object</p>
<p>&lt; insert in list before current object</p>
<p>&lt; insert in list after current object</p>
<p>Get first linked object in list. This may be dynamically recast, and may refer to a master static bookmark pointer in a derived class. Otherwise it follows list to front.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to first object in list.</dd></dl>
<p>Gets the last object in the list. This normally follows the links to the end. This is a virtual because derived class may include a static member bookmark for the current end.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to last object in list.</dd></dl>
<p>Virtual to get the insert point to use when adding new members. This may be current, or always head or always tail. As a virtual, this allows derived class to establish "policy".</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to insertion point in list.</dd></dl>
<p>Get next object, for convenience. Derived class may use this with a dynamic cast.</p>
<dl class="section return"><dt>Returns</dt><dd>next object in list.</dd></dl>
<p>Get prev object in the list.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to previous object.</dd></dl>
<p>Insert object into chain at given pos, as indicated by InsertMode; If no pos is given, it defaults to modeAtLast, inserting element at list's end.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">object</td><td>being inserted. </td></tr>
    <tr><td class="paramname">position</td><td>where object is inserted.</td></tr>
  </table>
  </dd>
</dl>
<p>Remove object from chain.</p>
<p>Creates an empty map index (pointing to nothing).</p>
<p>Creates a map index pointing to a specific map object</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">the</td><td>indexed object</td></tr>
  </table>
  </dd>
</dl>
<p>Creates a copy of a given map index</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">the</td><td>source index object</td></tr>
  </table>
  </dd>
</dl>
<p>Dereference operator: the pointed object it is returned as void * for easy re-cast.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to indexed object.</dd></dl>
<p>Assignment operator to avoid implicit cast.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Prefix increment operator, to be used in loops and such.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Postfix increment operator, to be used in loops and such.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Comparison operator, between two MapIndex's.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Comparison operator, between the MapIndex and a MapObject, useful to avoid casts for sake of clearness.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Remove the object from it's current table.</p>
<p>Save id, mark as not using any table.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">id</td><td>string for this object.</td></tr>
  </table>
  </dd>
</dl>
<p>This manages a registration to the typemanager - attempting to remove problems with the optimizers</p>
<p>This adds a new construction function to the type manager</p>
<p>And this one removes a type from the managers lists</p>
<p>This function creates a new object of the required type and returns a pointer to it. NULL is returned if we couldn't find the type</p>
<p>This constructor is used in serialization processes. It is called in CreateNewInstance in order to create an instance of the class to have Read() called on it.</p>
<p>Default destructor</p>
<p>This returns the ID of the persistent object (Its type)</p>
<p>This method is used to write to the Persistence::Engine It is not equivalent to the &lt;&lt; operator as it writes only the data and not the object type etc.</p>
<p>This method is used to read from a Persistence::Engine It is not equivalent to the &gt;&gt; operator as it does no typesafety or anything.</p>
<p>These are the modes the Persistence::Engine can work in</p>
<p>Constructs a Persistence::Engine with the specified stream in the given mode. The stream must be initialized properly prior to this call or problems will ensue.</p>
<p>writes a PersistObject from a reference.</p>
<p>writes a PersistObject from a pointer.</p>
<p>reads a PersistObject into a reference overwriting the object.</p>
<p>reads a PersistObject into a pointer allocating memory for the object if necessary.</p>
<p>reads the actual object data into a pre-instantiated object pointer by calling the read function of the derived class.</p>
<p>reads in a class name, and caches it into the ClassMap.</p>
<p>The underlying stream</p>
<p>The mode of the engine. read or write</p>
<p>Typedefs for the Persistence::PersistObject support</p>
<p>Detach current process into a daemon, posix only. Perhaps a similar method can be used for creating win32 "services"?</p>
<p>Attach the current process to another device or i/o session. It is deamonified and dissasociated with the prior parent process and controlling terminal.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">devname</td><td>path to attach to.</td></tr>
  </table>
  </dd>
</dl>
<p>Set a posix compliant signal handler.</p>
<dl class="section return"><dt>Returns</dt><dd>previous handler. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">signo</td><td>signal no. </td></tr>
    <tr><td class="paramname">handler</td><td>trap handler.</td></tr>
  </table>
  </dd>
</dl>
<p>Set system call interuptable signal handler.</p>
<p>#return previous handler. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">signo</td><td>signal no. </td></tr>
    <tr><td class="paramname">handler</td><td>trap handler.</td></tr>
  </table>
  </dd>
</dl>
<p>Lock a process in memory. Ideally you should be deep enough where additional memallocs for functions will not kill you, or use false for future.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">future</td><td>pages as well...</td></tr>
  </table>
  </dd>
</dl>
<p>Unlock process pages.</p>
<p>Spawn a process and wait for it's exit code. In win32 this is done with the spawn system call. In posix, this is done with a fork, an execvp, and a waitpid.</p>
<dl class="section warning"><dt>Warning</dt><dd>The implementation differences between posix and win32 systems may cause side effects. For instance, if you use atexit() and this spawn method, on posix systems the function set up with atexit() will be called when the parent process of the fork exits, which will not happen on Win32 systems.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>error code from process. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">exec</td><td>name of executable. </td></tr>
    <tr><td class="paramname">argv</td><td>list of command arguments. </td></tr>
    <tr><td class="paramname">wait</td><td>for process to exit before return.</td></tr>
  </table>
  </dd>
</dl>
<p>Get the exit status of another process, waiting for it to exit.</p>
<dl class="section return"><dt>Returns</dt><dd>exit code from process. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pid</td><td>process id.</td></tr>
  </table>
  </dd>
</dl>
<p>Cancel a running child process.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pid</td><td>process id. </td></tr>
    <tr><td class="paramname">sig</td><td>cancel signal to apply.</td></tr>
  </table>
  </dd>
</dl>
<p>Get system environment.</p>
<dl class="section return"><dt>Returns</dt><dd>system environ symbol. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of symbol.</td></tr>
  </table>
  </dd>
</dl>
<p>Set system environment in a standard manner.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of environment symbol to set. </td></tr>
    <tr><td class="paramname">value</td><td>of environment symbol. </td></tr>
    <tr><td class="paramname">overwrite</td><td>true if replace existing symbol.</td></tr>
  </table>
  </dd>
</dl>
<p>Get etc prefix path.</p>
<dl class="section return"><dt>Returns</dt><dd>etc prefix.</dd></dl>
<p>Get home directory.</p>
<dl class="section return"><dt>Returns</dt><dd>user home directory.</dd></dl>
<p>Get user name.</p>
<dl class="section return"><dt>Returns</dt><dd>user login id.</dd></dl>
<p>Set user id by name.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful.</dd></dl>
<p>Set the effective group id by name.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful.</dd></dl>
<p>Return the effective operating system page size.</p>
<dl class="section return"><dt>Returns</dt><dd>system page size.</dd></dl>
<p>Used to set process priority and optionally enable realtime.</p>
<p>Used to set process scheduling policy.</p>
<p>Portable shortcut for setting realtime...</p>
<p>Return true if scheduler settable.</p>
<p>Return true if realtime scheduling.</p>
<p>Create a lock under a known name.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of system-wide lock to create.</td></tr>
  </table>
  </dd>
</dl>
<p>Create a new lock object that can be used to make locks.</p>
<p>Destroy the current lock and release it.</p>
<p>Lock a system-wide name for this process. If the lock is successful, return true. If an existing lock was already acquired, release it first.</p>
<dl class="section return"><dt>Returns</dt><dd>true if lock successful. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>system-wide lock to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Release an acquired lock.</p>
<p>Flag if the current process has aqcuired a lock.</p>
<dl class="section return"><dt>Returns</dt><dd>true if we have the lock.</dd></dl>
<p>Used to properly initialize serial object.</p>
<p>Opens the serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fname</td><td>Pathname of device to open</td></tr>
  </table>
  </dd>
</dl>
<p>Closes the serial device.</p>
<p>Reads from serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Data</td><td>Point to character buffer to receive data. Buffers MUST be at least Length + 1 bytes in size. </td></tr>
    <tr><td class="paramname">Length</td><td>Number of bytes to read.</td></tr>
  </table>
  </dd>
</dl>
<p>Writes to serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Data</td><td>Point to character buffer containing data to write. Buffers MUST </td></tr>
    <tr><td class="paramname">Length</td><td>Number of bytes to write.</td></tr>
  </table>
  </dd>
</dl>
<p>This service is used to throw all serial errors which usually occur during the serial constructor.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">error</td><td>defined serial error id. </td></tr>
    <tr><td class="paramname">errstr</td><td>string or message to optionally pass.</td></tr>
  </table>
  </dd>
</dl>
<p>This service is used to thow application defined serial errors where the application specific error code is a string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">err</td><td>string or message to pass.</td></tr>
  </table>
  </dd>
</dl>
<p>This method is used to turn the error handler on or off for "throwing" execptions by manipulating the thrown flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>true to enable handler.</td></tr>
  </table>
  </dd>
</dl>
<p>Set packet read mode and "size" of packet read buffer. This sets VMIN to x. VTIM is normally set to "0" so that "isPending()" can wait for an entire packet rather than just the first byte.</p>
<dl class="section return"><dt>Returns</dt><dd>actual buffer size set. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>of packet read request. </td></tr>
    <tr><td class="paramname">btimer</td><td>optional inter-byte data packet timeout.</td></tr>
  </table>
  </dd>
</dl>
<p>Set "line buffering" read mode and specifies the newline character to be used in seperating line records. isPending can then be used to wait for an entire line of input.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">newline</td><td>newline character. </td></tr>
    <tr><td class="paramname">nl1</td><td>EOL2 control character. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of conical input buffer.</dd></dl>
<p>Restore serial device to the original settings at time of open.</p>
<p>Used to flush the input waiting queue.</p>
<p>Used to flush any pending output data.</p>
<p>Used to wait until all output has been sent.</p>
<p>Used as the default destructor for ending serial I/O services. It will restore the port to it's original state.</p>
<p>Used to initialize a newly opened serial file handle. You should set serial properties and DTR manually before first use.</p>
<p>This allows later ttystream class to open and close a serial device.</p>
<p>A serial object may be constructed from a named file on the file system. This named device must be "isatty()".</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of file.</td></tr>
  </table>
  </dd>
</dl>
<p>The serial base class may be "thrown" as a result on an error, and the "catcher" may then choose to destory the object. By assuring the socket base class is a virtual destructor, we can assure the full object is properly terminated.</p>
<p>Serial ports may also be duplecated by the assignment operator.</p>
<p>Set serial port speed for both input and output.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">speed</td><td>to select. 0 signifies modem "hang up".</td></tr>
  </table>
  </dd>
</dl>
<p>Set character size.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bits</td><td>character size to use (usually 7 or 8).</td></tr>
  </table>
  </dd>
</dl>
<p>Set parity mode.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">parity</td><td>mode.</td></tr>
  </table>
  </dd>
</dl>
<p>Set number of stop bits.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bits</td><td>stop bits.</td></tr>
  </table>
  </dd>
</dl>
<p>Set flow control.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">flow</td><td>control mode.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the DTR mode off momentarily.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">millisec</td><td>number of milliseconds.</td></tr>
  </table>
  </dd>
</dl>
<p>Send the "break" signal.</p>
<p>Often used by a "catch" to fetch the last error of a thrown serial.</p>
<dl class="section return"><dt>Returns</dt><dd>error numbr of last Error.</dd></dl>
<p>Often used by a "catch" to fetch the user set error string of a thrown serial.</p>
<dl class="section return"><dt>Returns</dt><dd>string for error message.</dd></dl>
<p>Get the "buffer" size for buffered operations. This can be used when setting packet or line read modes to determine how many bytes to wait for in a given read call.</p>
<dl class="section return"><dt>Returns</dt><dd>number of bytes used for buffering.</dd></dl>
<p>Get the status of pending operations. This can be used to examine if input or output is waiting, or if an error has occured on the serial device.</p>
<dl class="section return"><dt>Returns</dt><dd>true if ready, false if timeout. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pend</td><td>ready check to perform. </td></tr>
    <tr><td class="paramname">timeout</td><td>in milliseconds.</td></tr>
  </table>
  </dd>
</dl>
<p>Acquire the mutex</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">_mutex</td><td>reference to mutex to aquire.</td></tr>
  </table>
  </dd>
</dl>
<p>Release the mutex automatically</p>
<p>Wait for read access</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">_tl</td><td>reference to lock to aquire.</td></tr>
  </table>
  </dd>
</dl>
<p>Post the semaphore automatically</p>
<p>Wait for write access</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">_tl</td><td>reference to threadlock to aquire.</td></tr>
  </table>
  </dd>
</dl>
<p>Post the semaphore automatically</p>
<p>Wait for the semaphore</p>
<p>Post the semaphore automatically</p>
<p>Create a timer, mark it as inactive, and set the initial "start" time to the creation time of the timer object. This allows "incTimer" to initially refer to time delays relative to the original start time of the object.</p>
<p>Set a new start time for the object based on when this call is made and optionally activate the timer for a specified number of milliseconds. This can be used to set the starting time of a realtime session.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>delay in milliseconds from "now"</td></tr>
  </table>
  </dd>
</dl>
<p>Set a timeout based on the current time reference value either from object creation or the last setTimer(). This reference can be used to time synchronize realtime data over specified intervals and force expiration when a new frame should be released in a synchronized manner.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>delay in milliseconds from reference.</td></tr>
  </table>
  </dd>
</dl>
<p>Adjust a timeout based on the current time reference value either from object creation or the last setTimer(). This reference can be used to time synchronize realtime data over specified intervals and force expiration when a new frame should be released in a synchronized manner.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>delay in milliseconds from reference.</td></tr>
  </table>
  </dd>
</dl>
<p>Sleep until the current timer expires. This is useful in time syncing realtime periodic tasks.</p>
<p>This is used to "disable" the service thread from expiring the timer object. It does not effect the reference time from either creation or a setTimer().</p>
<p>This is used by service threads to determine how much time remains before the timer expires based on a timeout specified in setTimer() or incTimer(). It can also be called after setting a timeout with incTimer() to see if the current timeout has already expired and hence that the application is already delayed and should skip frame(s).</p>
<p>return time remaining in milliseconds, or TIMEOUT_INF if inactive.</p>
<p>This is used to determine how much time has elapsed since a timer port setTimer benchmark time was initially set. This allows one to use setTimer() to set the timer to the current time and then measure elapsed time from that point forward.</p>
<p>return time elapsed in milliseconds, or TIMEOUT_INF if inactive.</p>
<p>a delimiter string containing all usual whitespace delimiters. These are space, tab, newline, carriage return, formfeed and vertical tab. (see isspace() manpage).</p>
<p>Exception thrown, if someone tried to read beyond the end of the tokens. Will not happen if you use it the 'clean' way with comparison against end(), but if you skip some tokens, because you 'know' they are there. Simplifies error handling a lot, since you can just read your tokens the way you expect it, and if there is some error in the input this Exception will be thrown.</p>
<p>The input forward iterator for tokens. </p><dl class="section author"><dt>Author</dt><dd>Henner Zeller</dd></dl>
<p>copy constructor.</p>
<p>assignment operator.</p>
<p>shifts this iterator to the next token in the string.</p>
<p>returns the immutable string this iterator points to or '0' if no token is available (i.e. i == end()). Do not store pointers to this token, since it is invalidated for each iteration. If you need the token, copy it (e.g. with strdup());</p>
<p>returns the next delimiter after the current token or '\0', if there are no following delimiters. It returns the very next delimiter (even if skipAllDelim=true).</p>
<p>compares to other iterator. Usually used to compare against the end() iterator.</p>
<p>compares to other iterator. Usually used to compare against the end() iterator.</p>
<p>creates a new StringTokenizer for a string and a given set of delimiters.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">str</td><td>String to be split up. This string will not be modified by this StringTokenizer, but you may as well not modfiy this string while tokenizing is in process, which may lead to undefined behaviour.</td></tr>
    <tr><td class="paramname">delim</td><td>String containing the characters which should be regarded as delimiters.</td></tr>
    <tr><td class="paramname">skipAllDelim</td><td>OPTIONAL. true, if subsequent delimiters should be skipped at once or false, if empty tokens should be returned for two delimiters with no other text inbetween. The first behaviour may be desirable for whitespace skipping, the second for input with delimited entry e.g. /etc/passwd like files or CSV input. NOTE, that 'true' here resembles the ANSI-C strtok(char *s,char *d) behaviour. DEFAULT = false</td></tr>
    <tr><td class="paramname">trim</td><td>OPTIONAL. true, if the tokens returned should be trimmed, so that they don't have any whitespaces at the beginning or end. Whitespaces are any of the characters defined in StringTokenizer::SPACE. If delim itself is StringTokenizer::SPACE, this will result in a behaviour with skipAllDelim = true. DEFAULT = false</td></tr>
  </table>
  </dd>
</dl>
<p>create a new StringTokenizer which splits the input string at whitespaces. The tokens are stripped from whitespaces. This means, if you change the set of delimiters in either the 'begin(const char *delim)' method or in 'setDelimiters()', you then get whitespace trimmed tokens, delimited by the new set. Behaves like StringTokenizer(s, StringTokenizer::SPACE,false,true);</p>
<p>returns the begin iterator</p>
<p>changes the set of delimiters used in subsequent iterations.</p>
<p>returns a begin iterator with an alternate set of delimiters.</p>
<p>the iterator marking the end.</p>
<p>Create xml parser. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>of XML data buffer.</td></tr>
  </table>
  </dd>
</dl>
<p>Destroy xml parser.</p>
<p>Virtual to receive embedded comments in XML document being parsed. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>received. </td></tr>
    <tr><td class="paramname">size</td><td>of text received.</td></tr>
  </table>
  </dd>
</dl>
<p>Virtual to receive character text extracted from the document. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>received. </td></tr>
    <tr><td class="paramname">size</td><td>of text received.</td></tr>
  </table>
  </dd>
</dl>
<p>Notify start of document event.</p>
<p>Notify end of document event.</p>
<p>Notify start of an element in the document. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of element found. </td></tr>
    <tr><td class="paramname">attr</td><td>list of attributes extracted.</td></tr>
  </table>
  </dd>
</dl>
<p>Notify end of an element in the document. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of element ending.</td></tr>
  </table>
  </dd>
</dl>
<p>Parse a chunk of data and return parser completion flag. This is used to externally drive data into the XML parser. The return status can be used to determine when a document has been fully parsed. This can be called multiple times to push stream data into the parser. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">address</td><td>of data to parse. </td></tr>
    <tr><td class="paramname">size</td><td>of data to parse.</td></tr>
  </table>
  </dd>
</dl>
<p>Parse a stream buffer and return parser document completion flag. This is used to scan a stream buffer for a complete XML document. The stream is scanned until the document is complete or EOF. Multiple XML document instances can be scanned from a continues XML streaming source. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">stream</td><td>buffer to parse. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if parse complete, false if invalid or EOF.</dd></dl>
<p>Parse a file buffer and return parser document completion flag. This is used to scan a file buffer for a complete XML document. The file is scanned until the document is complete or EOF. Multiple XML document instances can be scanned from a continues XML streaming source. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">file</td><td>buffer to parse. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if parse complete, false if invalid or EOF.</dd></dl>
<p>End of document check. </p><dl class="section return"><dt>Returns</dt><dd>true if end of document.</dd></dl>
<p>Get network address associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded address.</dd></dl>
<p>Get network mask associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network mask.</dd></dl>
<p>Compute the broadcast address associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network address.</dd></dl>
<p>Set the cidr from a full or partial hostname, or from an address/mask, or a host/bits specification.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>string to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct a new cidr from a string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>string to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct an empty cidr.</p>
<p>Construct a copy of a cidr.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>to copy from.</td></tr>
  </table>
  </dd>
</dl>
<p>See if a socket address is a member of this cidr's network.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">saddr</td><td>pointer to test. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr.</dd></dl>
<p>See if a low level address object is a member of this cidr's net.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inaddr</td><td>object to test. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr.</dd></dl>
<p>Get network address associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded address.</dd></dl>
<p>Get network mask associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network mask.</dd></dl>
<p>Compute the broadcast address associated with this cidr.</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded network address.</dd></dl>
<p>Set the cidr from a full or partial hostname, or from a host/bits specification.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>string to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct a new cidr from a string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>string to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct an empty cidr.</p>
<p>Construct a copy of a cidr.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cidr</td><td>to copy from.</td></tr>
  </table>
  </dd>
</dl>
<p>See if a socket address is a member of this cidr's network.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">saddr</td><td>pointer to test. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr.</dd></dl>
<p>See if a low level address object is a member of this cidr's net.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inaddr</td><td>object to test. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if member of cidr.</dd></dl>
<p>Sets the IP address from a string representation of the numeric address, ie "127.0.0.1"</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>The string representation of the IP address </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful</dd></dl>
<p>Used to specify a host name or numeric internet address.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>The string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY</td></tr>
  </table>
  </dd>
</dl>
<p>Create an Internet Address object with an empty (0.0.0.0) address.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Convert the system internet address data type (struct in_addr) into a Common C++ IPV4Address object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>struct of system used binary internet address. </td></tr>
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Convert a null terminated ASCII host address string (example: "127.0.0.1") or host address name (example: "www.voxilla.org") directly into a Common C++ IPV4Address object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">address</td><td>null terminated C string. </td></tr>
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Copy constructor</p>
<p>Destructor</p>
<p>Provide a string representation of the value (Internet Address) held in the IPV4Address object.</p>
<dl class="section return"><dt>Returns</dt><dd>string representation of IPV4Address.</dd></dl>
<p>May be used to verify if a given IPV4Address returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" IPV4Address values.</p>
<dl class="section return"><dt>Returns</dt><dd>true if address != 0.0.0.0.</dd></dl>
<p>Provide a low level system usable struct in_addr object from the contents of IPV4Address. This is needed for services such as bind() and connect().</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address.</dd></dl>
<p>Provide a low level system usable struct in_addr object from the contents of IPV4Address. This is needed for services such as bind() and connect().</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>for IPV4Addresses with multiple addresses, returns the address at this index. User should call getAddressCount() to determine the number of address the object contains. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address. If parameter i is out of range, the first address is returned.</dd></dl>
<p>Returns the number of internet addresses that an IPV4Address object contains. This usually only happens with IPV4Host objects where multiple IP addresses are returned for a DNS lookup</p>
<p>Allows assignment from the return of functions like inet_addr() or htonl()</p>
<p>Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host).</p>
<p>If there is more than one IP address in either IPV4Address object, this will return true if all of the IP addresses in the smaller are in the larger in any order.</p>
<p>Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses).</p>
<p>This is implimented in terms of operator==</p>
<p>Constructor. Does not deal with any state.</p>
<p>Keeps compilers happy.</p>
<p>Pure virtual application operator. Apply the validation algorithm specific to derived classes.</p>
<p>Sets the IP address from a string representation of the numeric address, ie "127.0.0.1"</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>The string representation of the IP address </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful</dd></dl>
<p>Used to specify a host name or numeric internet address.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">host</td><td>The string representation of the IP address or a hostname, , if NULL, it will default to INADDR_ANY</td></tr>
  </table>
  </dd>
</dl>
<p>Create an Internet Address object with an empty (0.0.0.0) address.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Convert the system internet address data type (struct in_addr) into a Common C++ IPV6Address object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">addr</td><td>struct of system used binary internet address. </td></tr>
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Convert a null terminated ASCII host address string (example: "127.0.0.1") or host address name (example: "www.voxilla.org") directly into a Common C++ IPV6Address object.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">address</td><td>null terminated C string. </td></tr>
    <tr><td class="paramname">validator</td><td>optional validator function object, intended for derived classes.</td></tr>
  </table>
  </dd>
</dl>
<p>Copy constructor</p>
<p>Destructor</p>
<p>Provide a string representation of the value (Internet Address) held in the IPV6Address object.</p>
<dl class="section return"><dt>Returns</dt><dd>string representation of IPV6Address.</dd></dl>
<p>May be used to verify if a given IPV6Address returned by another function contains a "valid" address, or "0.0.0.0" which is often used to mark "invalid" IPV6Address values.</p>
<dl class="section return"><dt>Returns</dt><dd>true if address != 0.0.0.0.</dd></dl>
<p>Provide a low level system usable struct in_addr object from the contents of IPV6Address. This is needed for services such as bind() and connect().</p>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address.</dd></dl>
<p>Provide a low level system usable struct in_addr object from the contents of IPV6Address. This is needed for services such as bind() and connect().</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">i</td><td>for IPV6Addresses with multiple addresses, returns the address at this index. User should call getAddressCount() to determine the number of address the object contains. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>system binary coded internet address. If parameter i is out of range, the first address is returned.</dd></dl>
<p>Returns the number of internet addresses that an IPV6Address object contains. This usually only happens with IPV6Host objects where multiple IP addresses are returned for a DNS lookup</p>
<p>Compare two internet addresses to see if they are equal (if they specify the physical address of the same internet host).</p>
<p>If there is more than one IP address in either IPV6Address object, this will return true if all of the IP addresses in the smaller are in the larger in any order.</p>
<p>Compare two internet addresses to see if they are not equal (if they each refer to unique and different physical ip addresses).</p>
<p>This is implimented in terms of operator==</p>
<p>output string</p>
<p>HEXdump constructor.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>buffer to be "hexdumped" </td></tr>
    <tr><td class="paramname">buff_len</td><td>buffer length </td></tr>
    <tr><td class="paramname">max_len</td><td>max number of bytes to be "hexdumped". Usefull to truncate output. mas_len=0 does prints all.</td></tr>
  </table>
  </dd>
</dl>
<p>HEXdump destructor.</p>
<p>const char* cast provided for conveneince.</p>
<p>string cast provided for conveneince.</p>
<p>operator &lt;&lt; </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">hd</td><td>hexdump. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>application logger stream</dd></dl>
<p>Virtual method to filter results. Virtual override methods should call baseclass method to assure . and .. names are stripped out.</p>
<dl class="section return"><dt>Returns</dt><dd>true if current filename is accepted. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">file</td><td>path to examine </td></tr>
    <tr><td class="paramname">ino</td><td>info of type, date, etc.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct a directory tree walk starting at the specified prefix. A maximum subdirectory depth is also specified.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">prefix</td><td>to start walk. </td></tr>
    <tr><td class="paramname">maxdepth</td><td>subdirectory depth to examine.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct an un-opened directory tree of a known maximum depth</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">maxdepth</td><td>subdirectory subdirectory depth.</td></tr>
  </table>
  </dd>
</dl>
<p>Open a directory tree path.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">prefix</td><td>directory path to open.</td></tr>
  </table>
  </dd>
</dl>
<p>Close the directory path.</p>
<p>Extract the next full pathname from the directory walk. When returning directories, a '/' is appended. The returned string is a buffer of MAX_PATH size.</p>
<dl class="section return"><dt>Returns</dt><dd>path of next subdirectory entry or NULL.</dd></dl>
<p>This is used to step through the filter virtual for an entire subtree, and is used for cases where a derived DirTree class performs it's primary operations through filter rather than externally by calling getPath().</p>
<dl class="section return"><dt>Returns</dt><dd>number of files and directories examined. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">prefix</td><td>directory path to examine.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct and load a DSO object file.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>pathname of object file to load.</td></tr>
  </table>
  </dd>
</dl>
<p>Retrieve error indicator associated with DSO failure. This is often used in catch handlers.</p>
<p>Detach a DSO object from running memory.</p>
<p>Lookup a symbol in the loaded file.</p>
<p>Find a specific DSO object by filename.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of DSO object file (partial).</td></tr>
  </table>
  </dd>
</dl>
<p>See if DSO object is valid.</p>
<dl class="section return"><dt>Returns</dt><dd>true if valid.</dd></dl>
<p>Install debug handler...</p>
<p>Contruct a multi-part document, and describe it's type.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">document</td><td>(content) type.</td></tr>
  </table>
  </dd>
</dl>
<p>Stream the headers of the multi-part document. The headers of individual entities are streamed as part of the body.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output</td><td>to stream document header into.</td></tr>
  </table>
  </dd>
</dl>
<p>Stream the "body" of the multi-part document. This involves streaming the headers and body of each document part.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output</td><td>to stream document body into.</td></tr>
  </table>
  </dd>
</dl>
<p>Get a string array of the headers to use. This is used to assist URLStream::post.</p>
<dl class="section return"><dt>Returns</dt><dd>array of headers.</dd></dl>
<p>Stream the header(s) for the current document part.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output</td><td>to stream header into.</td></tr>
  </table>
  </dd>
</dl>
<p>Stream the content of this document part.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output</td><td>to stream document body into.</td></tr>
  </table>
  </dd>
</dl>
<p>Construct and attach a document part to a multipart document.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">top</td><td>multipart document to attach to. </td></tr>
    <tr><td class="paramname">ct</td><td>Content-Type to use.</td></tr>
  </table>
  </dd>
</dl>
<p>The constructor simply initializes the count.</p>
<p>The destructor is called when the reference count returns to zero. This is done through a virtual destructor.</p>
<p>The actual object being managed can be returned by this method as a void and then recast to the actual type. This removes the need to dynamic cast from RefObject and the dependence on rtti this implies.</p>
<dl class="section return"><dt>Returns</dt><dd>underlying object being referenced.</dd></dl>
<p>Detach current object, for example, when changing pointer.</p>
<p>Patch point for mutex in derived class. This may often be a single static mutex shared by a managed type.</p>
<p>Patch point for a mutex in derived class. This may often be a single static mutex shared by a managed type.</p>
<p>Create an unattached pointer.</p>
<p>Create a pointer attached to a reference counted object.</p>
<p>Object being referenced.</p>
<p>A copy constructor.</p>
<p>Pointer being copied.</p>
<p>Get first linked object in list. This may be dynamically recast, and may refer to a master static bookmark pointer in a derived class. Otherwise it simply returns the current object. In a "free" list, this may not only return the first object, but also set the first to next.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to first object in list.</dd></dl>
<p>Gets the last object in the list. This normally follows the links to the end. This is a virtual because derived class may include a static member bookmark for the current end.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to last object in list.</dd></dl>
<p>Get next object, for convenience. Derived class may use this with a dynamic cast.</p>
<dl class="section return"><dt>Returns</dt><dd>next object in list.</dd></dl>
<p>Insert object into chain. This is a virtual because derived class may choose instead to perform an insert at head or tail, may manage bookmarks, and may add mutex lock.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">object</td><td>being inserted.</td></tr>
  </table>
  </dd>
</dl>
<p>Requested in overloaded insert() method to indicate how to insert data into list</p>
<p>&lt; insert at first position in list pointed by current object</p>
<p>&lt; insert at last position in list pointed by current object</p>
<p>&lt; insert in list before current object</p>
<p>&lt; insert in list after current object</p>
<p>Get first linked object in list. This may be dynamically recast, and may refer to a master static bookmark pointer in a derived class. Otherwise it follows list to front.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to first object in list.</dd></dl>
<p>Gets the last object in the list. This normally follows the links to the end. This is a virtual because derived class may include a static member bookmark for the current end.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to last object in list.</dd></dl>
<p>Virtual to get the insert point to use when adding new members. This may be current, or always head or always tail. As a virtual, this allows derived class to establish "policy".</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to insertion point in list.</dd></dl>
<p>Get next object, for convenience. Derived class may use this with a dynamic cast.</p>
<dl class="section return"><dt>Returns</dt><dd>next object in list.</dd></dl>
<p>Get prev object in the list.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to previous object.</dd></dl>
<p>Insert object into chain at given pos, as indicated by InsertMode; If no pos is given, it defaults to modeAtLast, inserting element at list's end.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">object</td><td>being inserted. </td></tr>
    <tr><td class="paramname">position</td><td>where object is inserted.</td></tr>
  </table>
  </dd>
</dl>
<p>Remove object from chain.</p>
<p>Creates an empty map index (pointing to nothing).</p>
<p>Creates a map index pointing to a specific map object</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">the</td><td>indexed object</td></tr>
  </table>
  </dd>
</dl>
<p>Creates a copy of a given map index</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">the</td><td>source index object</td></tr>
  </table>
  </dd>
</dl>
<p>Dereference operator: the pointed object it is returned as void * for easy re-cast.</p>
<dl class="section return"><dt>Returns</dt><dd>pointer to indexed object.</dd></dl>
<p>Assignment operator to avoid implicit cast.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Prefix increment operator, to be used in loops and such.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Postfix increment operator, to be used in loops and such.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Comparison operator, between two MapIndex's.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Comparison operator, between the MapIndex and a MapObject, useful to avoid casts for sake of clearness.</p>
<dl class="section return"><dt>Returns</dt><dd>the object itself, as changed.</dd></dl>
<p>Remove the object from it's current table.</p>
<p>Save id, mark as not using any table.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">id</td><td>string for this object.</td></tr>
  </table>
  </dd>
</dl>
<p>This manages a registration to the typemanager - attempting to remove problems with the optimizers</p>
<p>This adds a new construction function to the type manager</p>
<p>And this one removes a type from the managers lists</p>
<p>This function creates a new object of the required type and returns a pointer to it. NULL is returned if we couldn't find the type</p>
<p>This constructor is used in serialization processes. It is called in CreateNewInstance in order to create an instance of the class to have Read() called on it.</p>
<p>Default destructor</p>
<p>This returns the ID of the persistent object (Its type)</p>
<p>This method is used to write to the Persistence::Engine It is not equivalent to the &lt;&lt; operator as it writes only the data and not the object type etc.</p>
<p>This method is used to read from a Persistence::Engine It is not equivalent to the &gt;&gt; operator as it does no typesafety or anything.</p>
<p>These are the modes the Persistence::Engine can work in</p>
<p>Constructs a Persistence::Engine with the specified stream in the given mode. The stream must be initialized properly prior to this call or problems will ensue.</p>
<p>writes a PersistObject from a reference.</p>
<p>writes a PersistObject from a pointer.</p>
<p>reads a PersistObject into a reference overwriting the object.</p>
<p>reads a PersistObject into a pointer allocating memory for the object if necessary.</p>
<p>reads the actual object data into a pre-instantiated object pointer by calling the read function of the derived class.</p>
<p>reads in a class name, and caches it into the ClassMap.</p>
<p>The underlying stream</p>
<p>The mode of the engine. read or write</p>
<p>Typedefs for the Persistence::PersistObject support</p>
<p>Detach current process into a daemon, posix only. Perhaps a similar method can be used for creating win32 "services"?</p>
<p>Attach the current process to another device or i/o session. It is deamonified and dissasociated with the prior parent process and controlling terminal.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">devname</td><td>path to attach to.</td></tr>
  </table>
  </dd>
</dl>
<p>Set a posix compliant signal handler.</p>
<dl class="section return"><dt>Returns</dt><dd>previous handler. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">signo</td><td>signal no. </td></tr>
    <tr><td class="paramname">handler</td><td>trap handler.</td></tr>
  </table>
  </dd>
</dl>
<p>Set system call interuptable signal handler.</p>
<p>#return previous handler. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">signo</td><td>signal no. </td></tr>
    <tr><td class="paramname">handler</td><td>trap handler.</td></tr>
  </table>
  </dd>
</dl>
<p>Lock a process in memory. Ideally you should be deep enough where additional memallocs for functions will not kill you, or use false for future.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">future</td><td>pages as well...</td></tr>
  </table>
  </dd>
</dl>
<p>Unlock process pages.</p>
<p>Spawn a process and wait for it's exit code. In win32 this is done with the spawn system call. In posix, this is done with a fork, an execvp, and a waitpid.</p>
<dl class="section warning"><dt>Warning</dt><dd>The implementation differences between posix and win32 systems may cause side effects. For instance, if you use atexit() and this spawn method, on posix systems the function set up with atexit() will be called when the parent process of the fork exits, which will not happen on Win32 systems.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>error code from process. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">exec</td><td>name of executable. </td></tr>
    <tr><td class="paramname">argv</td><td>list of command arguments. </td></tr>
    <tr><td class="paramname">wait</td><td>for process to exit before return.</td></tr>
  </table>
  </dd>
</dl>
<p>Get the exit status of another process, waiting for it to exit.</p>
<dl class="section return"><dt>Returns</dt><dd>exit code from process. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pid</td><td>process id.</td></tr>
  </table>
  </dd>
</dl>
<p>Cancel a running child process.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pid</td><td>process id. </td></tr>
    <tr><td class="paramname">sig</td><td>cancel signal to apply.</td></tr>
  </table>
  </dd>
</dl>
<p>Get system environment.</p>
<dl class="section return"><dt>Returns</dt><dd>system environ symbol. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of symbol.</td></tr>
  </table>
  </dd>
</dl>
<p>Set system environment in a standard manner.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of environment symbol to set. </td></tr>
    <tr><td class="paramname">value</td><td>of environment symbol. </td></tr>
    <tr><td class="paramname">overwrite</td><td>true if replace existing symbol.</td></tr>
  </table>
  </dd>
</dl>
<p>Get etc prefix path.</p>
<dl class="section return"><dt>Returns</dt><dd>etc prefix.</dd></dl>
<p>Get home directory.</p>
<dl class="section return"><dt>Returns</dt><dd>user home directory.</dd></dl>
<p>Get user name.</p>
<dl class="section return"><dt>Returns</dt><dd>user login id.</dd></dl>
<p>Set user id by name.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful.</dd></dl>
<p>Set the effective group id by name.</p>
<dl class="section return"><dt>Returns</dt><dd>true if successful.</dd></dl>
<p>Return the effective operating system page size.</p>
<dl class="section return"><dt>Returns</dt><dd>system page size.</dd></dl>
<p>Used to set process priority and optionally enable realtime.</p>
<p>Used to set process scheduling policy.</p>
<p>Portable shortcut for setting realtime...</p>
<p>Return true if scheduler settable.</p>
<p>Return true if realtime scheduling.</p>
<p>Create a lock under a known name.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of system-wide lock to create.</td></tr>
  </table>
  </dd>
</dl>
<p>Create a new lock object that can be used to make locks.</p>
<p>Destroy the current lock and release it.</p>
<p>Lock a system-wide name for this process. If the lock is successful, return true. If an existing lock was already acquired, release it first.</p>
<dl class="section return"><dt>Returns</dt><dd>true if lock successful. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>system-wide lock to use.</td></tr>
  </table>
  </dd>
</dl>
<p>Release an acquired lock.</p>
<p>Flag if the current process has aqcuired a lock.</p>
<dl class="section return"><dt>Returns</dt><dd>true if we have the lock.</dd></dl>
<p>Used to properly initialize serial object.</p>
<p>Opens the serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">fname</td><td>Pathname of device to open</td></tr>
  </table>
  </dd>
</dl>
<p>Closes the serial device.</p>
<p>Reads from serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Data</td><td>Point to character buffer to receive data. Buffers MUST be at least Length + 1 bytes in size. </td></tr>
    <tr><td class="paramname">Length</td><td>Number of bytes to read.</td></tr>
  </table>
  </dd>
</dl>
<p>Writes to serial device.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Data</td><td>Point to character buffer containing data to write. Buffers MUST </td></tr>
    <tr><td class="paramname">Length</td><td>Number of bytes to write.</td></tr>
  </table>
  </dd>
</dl>
<p>This service is used to throw all serial errors which usually occur during the serial constructor.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">error</td><td>defined serial error id. </td></tr>
    <tr><td class="paramname">errstr</td><td>string or message to optionally pass.</td></tr>
  </table>
  </dd>
</dl>
<p>This service is used to thow application defined serial errors where the application specific error code is a string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">err</td><td>string or message to pass.</td></tr>
  </table>
  </dd>
</dl>
<p>This method is used to turn the error handler on or off for "throwing" execptions by manipulating the thrown flag.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>true to enable handler.</td></tr>
  </table>
  </dd>
</dl>
<p>Set packet read mode and "size" of packet read buffer. This sets VMIN to x. VTIM is normally set to "0" so that "isPending()" can wait for an entire packet rather than just the first byte.</p>
<dl class="section return"><dt>Returns</dt><dd>actual buffer size set. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>of packet read request. </td></tr>
    <tr><td class="paramname">btimer</td><td>optional inter-byte data packet timeout.</td></tr>
  </table>
  </dd>
</dl>
<p>Set "line buffering" read mode and specifies the newline character to be used in seperating line records. isPending can then be used to wait for an entire line of input.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">newline</td><td>newline character. </td></tr>
    <tr><td class="paramname">nl1</td><td>EOL2 control character. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size of conical input buffer.</dd></dl>
<p>Restore serial device to the original settings at time of open.</p>
<p>Used to flush the input waiting queue.</p>
<p>Used to flush any pending output data.</p>
<p>Used to wait until all output has been sent.</p>
<p>Used as the default destructor for ending serial I/O services. It will restore the port to it's original state.</p>
<p>Used to initialize a newly opened serial file handle. You should set serial properties and DTR manually before first use.</p>
<p>This allows later ttystream class to open and close a serial device.</p>
<p>A serial object may be constructed from a named file on the file system. This named device must be "isatty()".</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of file.</td></tr>
  </table>
  </dd>
</dl>
<p>The serial base class may be "thrown" as a result on an error, and the "catcher" may then choose to destory the object. By assuring the socket base class is a virtual destructor, we can assure the full object is properly terminated.</p>
<p>Serial ports may also be duplecated by the assignment operator.</p>
<p>Set serial port speed for both input and output.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">speed</td><td>to select. 0 signifies modem "hang up".</td></tr>
  </table>
  </dd>
</dl>
<p>Set character size.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bits</td><td>character size to use (usually 7 or 8).</td></tr>
  </table>
  </dd>
</dl>
<p>Set parity mode.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">parity</td><td>mode.</td></tr>
  </table>
  </dd>
</dl>
<p>Set number of stop bits.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bits</td><td>stop bits.</td></tr>
  </table>
  </dd>
</dl>
<p>Set flow control.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">flow</td><td>control mode.</td></tr>
  </table>
  </dd>
</dl>
<p>Set the DTR mode off momentarily.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">millisec</td><td>number of milliseconds.</td></tr>
  </table>
  </dd>
</dl>
<p>Send the "break" signal.</p>
<p>Often used by a "catch" to fetch the last error of a thrown serial.</p>
<dl class="section return"><dt>Returns</dt><dd>error numbr of last Error.</dd></dl>
<p>Often used by a "catch" to fetch the user set error string of a thrown serial.</p>
<dl class="section return"><dt>Returns</dt><dd>string for error message.</dd></dl>
<p>Get the "buffer" size for buffered operations. This can be used when setting packet or line read modes to determine how many bytes to wait for in a given read call.</p>
<dl class="section return"><dt>Returns</dt><dd>number of bytes used for buffering.</dd></dl>
<p>Get the status of pending operations. This can be used to examine if input or output is waiting, or if an error has occured on the serial device.</p>
<dl class="section return"><dt>Returns</dt><dd>true if ready, false if timeout. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pend</td><td>ready check to perform. </td></tr>
    <tr><td class="paramname">timeout</td><td>in milliseconds.</td></tr>
  </table>
  </dd>
</dl>
<p>Acquire the mutex</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">_mutex</td><td>reference to mutex to aquire.</td></tr>
  </table>
  </dd>
</dl>
<p>Release the mutex automatically</p>
<p>Wait for read access</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">_tl</td><td>reference to lock to aquire.</td></tr>
  </table>
  </dd>
</dl>
<p>Post the semaphore automatically</p>
<p>Wait for write access</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">_tl</td><td>reference to threadlock to aquire.</td></tr>
  </table>
  </dd>
</dl>
<p>Post the semaphore automatically</p>
<p>Wait for the semaphore</p>
<p>Post the semaphore automatically</p>
<p>Create a timer, mark it as inactive, and set the initial "start" time to the creation time of the timer object. This allows "incTimer" to initially refer to time delays relative to the original start time of the object.</p>
<p>Set a new start time for the object based on when this call is made and optionally activate the timer for a specified number of milliseconds. This can be used to set the starting time of a realtime session.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>delay in milliseconds from "now"</td></tr>
  </table>
  </dd>
</dl>
<p>Set a timeout based on the current time reference value either from object creation or the last setTimer(). This reference can be used to time synchronize realtime data over specified intervals and force expiration when a new frame should be released in a synchronized manner.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>delay in milliseconds from reference.</td></tr>
  </table>
  </dd>
</dl>
<p>Adjust a timeout based on the current time reference value either from object creation or the last setTimer(). This reference can be used to time synchronize realtime data over specified intervals and force expiration when a new frame should be released in a synchronized manner.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>delay in milliseconds from reference.</td></tr>
  </table>
  </dd>
</dl>
<p>Sleep until the current timer expires. This is useful in time syncing realtime periodic tasks.</p>
<p>This is used to "disable" the service thread from expiring the timer object. It does not effect the reference time from either creation or a setTimer().</p>
<p>This is used by service threads to determine how much time remains before the timer expires based on a timeout specified in setTimer() or incTimer(). It can also be called after setting a timeout with incTimer() to see if the current timeout has already expired and hence that the application is already delayed and should skip frame(s).</p>
<p>return time remaining in milliseconds, or TIMEOUT_INF if inactive.</p>
<p>This is used to determine how much time has elapsed since a timer port setTimer benchmark time was initially set. This allows one to use setTimer() to set the timer to the current time and then measure elapsed time from that point forward.</p>
<p>return time elapsed in milliseconds, or TIMEOUT_INF if inactive.</p>
<p>a delimiter string containing all usual whitespace delimiters. These are space, tab, newline, carriage return, formfeed and vertical tab. (see isspace() manpage).</p>
<p>Exception thrown, if someone tried to read beyond the end of the tokens. Will not happen if you use it the 'clean' way with comparison against end(), but if you skip some tokens, because you 'know' they are there. Simplifies error handling a lot, since you can just read your tokens the way you expect it, and if there is some error in the input this Exception will be thrown.</p>
<p>The input forward iterator for tokens. </p><dl class="section author"><dt>Author</dt><dd>Henner Zeller</dd></dl>
<p>copy constructor.</p>
<p>assignment operator.</p>
<p>shifts this iterator to the next token in the string.</p>
<p>returns the immutable string this iterator points to or '0' if no token is available (i.e. i == end()). Do not store pointers to this token, since it is invalidated for each iteration. If you need the token, copy it (e.g. with strdup());</p>
<p>returns the next delimiter after the current token or '\0', if there are no following delimiters. It returns the very next delimiter (even if skipAllDelim=true).</p>
<p>compares to other iterator. Usually used to compare against the end() iterator.</p>
<p>compares to other iterator. Usually used to compare against the end() iterator.</p>
<p>creates a new StringTokenizer for a string and a given set of delimiters.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">str</td><td>String to be split up. This string will not be modified by this StringTokenizer, but you may as well not modfiy this string while tokenizing is in process, which may lead to undefined behaviour.</td></tr>
    <tr><td class="paramname">delim</td><td>String containing the characters which should be regarded as delimiters.</td></tr>
    <tr><td class="paramname">skipAllDelim</td><td>OPTIONAL. true, if subsequent delimiters should be skipped at once or false, if empty tokens should be returned for two delimiters with no other text inbetween. The first behaviour may be desirable for whitespace skipping, the second for input with delimited entry e.g. /etc/passwd like files or CSV input. NOTE, that 'true' here resembles the ANSI-C strtok(char *s,char *d) behaviour. DEFAULT = false</td></tr>
    <tr><td class="paramname">trim</td><td>OPTIONAL. true, if the tokens returned should be trimmed, so that they don't have any whitespaces at the beginning or end. Whitespaces are any of the characters defined in StringTokenizer::SPACE. If delim itself is StringTokenizer::SPACE, this will result in a behaviour with skipAllDelim = true. DEFAULT = false</td></tr>
  </table>
  </dd>
</dl>
<p>create a new StringTokenizer which splits the input string at whitespaces. The tokens are stripped from whitespaces. This means, if you change the set of delimiters in either the 'begin(const char *delim)' method or in 'setDelimiters()', you then get whitespace trimmed tokens, delimited by the new set. Behaves like StringTokenizer(s, StringTokenizer::SPACE,false,true);</p>
<p>returns the begin iterator</p>
<p>changes the set of delimiters used in subsequent iterations.</p>
<p>returns a begin iterator with an alternate set of delimiters.</p>
<p>the iterator marking the end.</p>
<p>Create xml parser. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>of XML data buffer.</td></tr>
  </table>
  </dd>
</dl>
<p>Destroy xml parser.</p>
<p>Virtual to receive embedded comments in XML document being parsed. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>received. </td></tr>
    <tr><td class="paramname">size</td><td>of text received.</td></tr>
  </table>
  </dd>
</dl>
<p>Virtual to receive character text extracted from the document. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">text</td><td>received. </td></tr>
    <tr><td class="paramname">size</td><td>of text received.</td></tr>
  </table>
  </dd>
</dl>
<p>Notify start of document event.</p>
<p>Notify end of document event.</p>
<p>Notify start of an element in the document. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of element found. </td></tr>
    <tr><td class="paramname">attr</td><td>list of attributes extracted.</td></tr>
  </table>
  </dd>
</dl>
<p>Notify end of an element in the document. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>of element ending.</td></tr>
  </table>
  </dd>
</dl>
<p>Parse a chunk of data and return parser completion flag. This is used to externally drive data into the XML parser. The return status can be used to determine when a document has been fully parsed. This can be called multiple times to push stream data into the parser. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">address</td><td>of data to parse. </td></tr>
    <tr><td class="paramname">size</td><td>of data to parse.</td></tr>
  </table>
  </dd>
</dl>
<p>Parse a stream buffer and return parser document completion flag. This is used to scan a stream buffer for a complete XML document. The stream is scanned until the document is complete or EOF. Multiple XML document instances can be scanned from a continues XML streaming source. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">stream</td><td>buffer to parse. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if parse complete, false if invalid or EOF.</dd></dl>
<p>Parse a file buffer and return parser document completion flag. This is used to scan a file buffer for a complete XML document. The file is scanned until the document is complete or EOF. Multiple XML document instances can be scanned from a continues XML streaming source. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">file</td><td>buffer to parse. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if parse complete, false if invalid or EOF.</dd></dl>
<p>End of document check. </p><dl class="section return"><dt>Returns</dt><dd>true if end of document.</dd></dl>

<p>Definition at line <a class="el" href="a00509_source.html#l00092">92</a> of file <a class="el" href="a00509_source.html">address.h</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>