Hu Chunming / sip_server

autodoc.xml 517 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 
<?xml version="1.0" standalone="yes"?>
<library-reference id="boost_interprocess_header_reference"><title>Boost.Interprocess Header Reference</title><header name="boost/interprocess/allocators/adaptive_pool.hpp">
<para>Describes adaptive_pool pooled shared memory STL compatible allocator </para><namespace name="boost">
<namespace name="interprocess">
<class name="adaptive_pool"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="SegmentManager"/>
      <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
      <template-nontype-parameter name="MaxFreeBlocks"><type>std::size_t</type></template-nontype-parameter>
      <template-nontype-parameter name="OverheadPercent"><type>unsigned char</type></template-nontype-parameter>
    </template><description><para>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc...</para><para>This node allocator shares a segregated storage between all instances of <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname> with equal sizeof(T) placed in the same segment group. NodesPerBlock is the number of nodes allocated at once when the allocator needs runs out of nodes. MaxFreeBlocks is the maximum number of totally free blocks that the adaptive node pool will hold. The rest of the totally free blocks will be deallocated with the segment manager.</para><para>OverheadPercent is the (approximated) maximum size overhead (1-20%) of the allocator: (memory usable for nodes / total memory allocated from the segment manager) </para></description><struct name="rebind"><template>
      <template-type-parameter name="T2"/>
    </template><description><para>Obtains <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname> from <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname> </para></description><typedef name="other"><type><classname>adaptive_pool</classname>&lt; T2, SegmentManager, NodesPerBlock, MaxFreeBlocks, OverheadPercent &gt;</type></typedef>
</struct><typedef name="segment_manager"><type>implementation_defined::segment_manager</type></typedef>
<typedef name="void_pointer"><type>segment_manager::void_pointer</type></typedef>
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="size_type"><type>segment_manager::size_type</type></typedef>
<typedef name="difference_type"><type>segment_manager::difference_type</type></typedef>
<method-group name="private member functions">
</method-group>
<copy-assignment><type><classname>adaptive_pool</classname> &amp;</type><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="SegmentManager2"/>
          <template-nontype-parameter name="N2"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F2"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP2"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name=""><paramtype>const <classname>adaptive_pool</classname>&lt; T2, SegmentManager2, N2, F2, OP2 &gt; &amp;</paramtype></parameter><description><para>Not assignable from related <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname> </para></description></copy-assignment>
<method-group name="public member functions">
<method name="get_node_pool" cv="const"><type>void *</type><description><para>Returns a pointer to the node pool. Never throws </para></description></method>
<method name="get_segment_manager" cv="const"><type>segment_manager *</type><description><para>Returns the segment manager. Never throws </para></description></method>
<method name="max_size" cv="const"><type>size_type</type><description><para>Returns the number of elements that could be allocated. Never throws </para></description></method>
<method name="allocate"><type>pointer</type><parameter name="count"><paramtype>size_type</paramtype></parameter><parameter name="hint"><paramtype>cvoid_pointer</paramtype><default>0</default></parameter><description><para>Allocate memory for an array of count elements. Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="deallocate"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="count"><paramtype>size_type</paramtype></parameter><description><para>Deallocate allocated memory. Never throws </para></description></method>
<method name="deallocate_free_blocks"><type>void</type><description><para>Deallocates all free blocks of the pool </para></description></method>
<method name="address" cv="const"><type>pointer</type><parameter name="value"><paramtype>reference</paramtype></parameter><description><para>Returns address of mutable object. Never throws </para></description></method>
<method name="address" cv="const"><type>const_pointer</type><parameter name="value"><paramtype>const_reference</paramtype></parameter><description><para>Returns address of non mutable object. Never throws </para></description></method>
<method name="size" cv="const"><type>size_type</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many. </para></description></method>
<method name="allocation_command"><type>pointer</type><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_size"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse"><paramtype>pointer &amp;</paramtype></parameter></method>
<method name="allocate_many"><type>void</type><parameter name="elem_size"><paramtype>size_type</paramtype></parameter><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_many"><type>void</type><parameter name="elem_sizes"><paramtype>const size_type *</paramtype></parameter><parameter name="n_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </para></description></method>
<method name="deallocate_many"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_one"><type>pointer</type><description><para>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="allocate_individual"><type>void</type><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="deallocate_one"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </para></description></method>
<method name="deallocate_individual"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype>segment_manager *</paramtype></parameter><description><para>Not assignable from other <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname> Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<constructor><parameter name="other"><paramtype>const <classname>adaptive_pool</classname> &amp;</paramtype></parameter><description><para>Copy constructor from other <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname>. Increments the reference count of the associated node pool. Never throws </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="other"><paramtype>const <classname>adaptive_pool</classname>&lt; T2, SegmentManager, NodesPerBlock, MaxFreeBlocks, OverheadPercent &gt; &amp;</paramtype></parameter><description><para>Copy constructor from related <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<destructor><description><para>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </para></description></destructor>
<method-group name="friend functions">
<method name="swap"><type>friend void</type><parameter name="alloc1"><paramtype>self_t &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>self_t &amp;</paramtype></parameter><description><para>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </para></description></method>
</method-group>
</class>


















<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><description><para>Equality test for same type of <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname> </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><description><para>Inequality test for same type of <classname alt="boost::interprocess::adaptive_pool">adaptive_pool</classname> </para></description></function>




























</namespace>
</namespace>
</header>
<header name="boost/interprocess/allocators/allocator.hpp">
<para>Describes an allocator that allocates portions of fixed size memory buffer (shared memory, mapped file...) </para><namespace name="boost">
<namespace name="interprocess">
<class name="allocator"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="SegmentManager"/>
    </template><description><para>An STL compatible allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... </para></description><struct name="rebind"><template>
      <template-type-parameter name="T2"/>
    </template><description><para>Obtains an allocator that allocates objects of type T2 </para></description><typedef name="other"><type><classname>allocator</classname>&lt; T2, SegmentManager &gt;</type></typedef>
</struct><typedef name="segment_manager"><type>SegmentManager</type></typedef>
<typedef name="void_pointer"><type>SegmentManager::void_pointer</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<typedef name="pointer"><type>boost::intrusive::pointer_traits&lt; cvoid_ptr &gt;::template rebind_pointer&lt; T &gt;::type</type></typedef>
<typedef name="const_pointer"><type>boost::intrusive::pointer_traits&lt; pointer &gt;::template rebind_pointer&lt; const T &gt;::type</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="size_type"><type>segment_manager::size_type</type></typedef>
<typedef name="difference_type"><type>segment_manager::difference_type</type></typedef>
<typedef name="version"><type>boost::interprocess::version_type&lt; <classname>allocator</classname>, 2 &gt;</type></typedef>
<method-group name="public member functions">
<method name="get_segment_manager" cv="const"><type>segment_manager *</type><description><para>Returns the segment manager. Never throws </para></description></method>
<method name="allocate"><type>pointer</type><parameter name="count"><paramtype>size_type</paramtype></parameter><parameter name="hint"><paramtype>cvoid_ptr</paramtype><default>0</default></parameter><description><para>Allocates memory for an array of count elements. Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="deallocate"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name=""><paramtype>size_type</paramtype></parameter><description><para>Deallocates memory previously allocated. Never throws </para></description></method>
<method name="max_size" cv="const"><type>size_type</type><description><para>Returns the number of elements that could be allocated. Never throws </para></description></method>
<method name="size" cv="const"><type>size_type</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many. </para></description></method>
<method name="allocation_command"><type>pointer</type><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_size"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse"><paramtype>pointer &amp;</paramtype></parameter></method>
<method name="allocate_many"><type>void</type><parameter name="elem_size"><paramtype>size_type</paramtype></parameter><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_many"><type>void</type><parameter name="elem_sizes"><paramtype>const size_type *</paramtype></parameter><parameter name="n_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </para></description></method>
<method name="deallocate_many"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_one"><type>pointer</type><description><para>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="allocate_individual"><type>void</type><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="deallocate_one"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </para></description></method>
<method name="deallocate_individual"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="address" cv="const"><type>pointer</type><parameter name="value"><paramtype>reference</paramtype></parameter><description><para>Returns address of mutable object. Never throws </para></description></method>
<method name="address" cv="const"><type>const_pointer</type><parameter name="value"><paramtype>const_reference</paramtype></parameter><description><para>Returns address of non mutable object. Never throws </para></description></method>
<method name="construct"><type>void</type><template>
          <template-type-parameter name="P"/>
        </template><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="p"><paramtype>P &amp;&amp;</paramtype></parameter><description><para>Constructs an object Throws if T's constructor throws For backwards compatibility with libraries using C++03 allocators </para></description></method>
<method name="destroy"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Destroys object. Throws if object's destructor throws </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype>segment_manager *</paramtype></parameter><description><para>Constructor from the segment manager. Never throws </para></description></constructor>
<constructor><parameter name="other"><paramtype>const <classname>allocator</classname> &amp;</paramtype></parameter><description><para>Constructor from other allocator. Never throws </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="other"><paramtype>const <classname>allocator</classname>&lt; T2, SegmentManager &gt; &amp;</paramtype></parameter><description><para>Constructor from related allocator. Never throws </para></description></constructor>
<method-group name="friend functions">
<method name="swap"><type>friend void</type><parameter name="alloc1"><paramtype>self_t &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>self_t &amp;</paramtype></parameter><description><para>Swap segment manager. Does not throw. If each allocator is placed in different memory segments, the result is undefined. </para></description></method>
</method-group>
</class>
















<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="SegmentManager"/>
        </template><parameter name="alloc1"><paramtype>const <classname>allocator</classname>&lt; T, SegmentManager &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>allocator</classname>&lt; T, SegmentManager &gt; &amp;</paramtype></parameter><description><para>Equality test for same type of allocator </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="SegmentManager"/>
        </template><parameter name="alloc1"><paramtype>const <classname>allocator</classname>&lt; T, SegmentManager &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>allocator</classname>&lt; T, SegmentManager &gt; &amp;</paramtype></parameter><description><para>Inequality test for same type of allocator </para></description></function>






























</namespace>
</namespace>
</header>
<header name="boost/interprocess/allocators/cached_adaptive_pool.hpp">
<para>Describes cached_adaptive_pool pooled shared memory STL compatible allocator </para><namespace name="boost">
<namespace name="interprocess">
<class name="cached_adaptive_pool"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="SegmentManager"/>
      <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
      <template-nontype-parameter name="MaxFreeBlocks"><type>std::size_t</type></template-nontype-parameter>
      <template-nontype-parameter name="OverheadPercent"><type>unsigned char</type></template-nontype-parameter>
    </template><description><para>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc...</para><para>This node allocator shares a segregated storage between all instances of <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname> with equal sizeof(T) placed in the same memory segment. But also caches some nodes privately to avoid some synchronization overhead.</para><para>NodesPerBlock is the minimum number of nodes of nodes allocated at once when the allocator needs runs out of nodes. MaxFreeBlocks is the maximum number of totally free blocks that the adaptive node pool will hold. The rest of the totally free blocks will be deallocated with the segment manager.</para><para>OverheadPercent is the (approximated) maximum size overhead (1-20%) of the allocator: (memory usable for nodes / total memory allocated from the segment manager) </para></description><struct name="rebind"><template>
      <template-type-parameter name="T2"/>
    </template><description><para>Obtains <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname> from <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname> </para></description><typedef name="other"><type><classname>cached_adaptive_pool</classname>&lt; T2, SegmentManager, NodesPerBlock, MaxFreeBlocks, OverheadPercent &gt;</type></typedef>
</struct><typedef name="segment_manager"><type>implementation_defined::segment_manager</type></typedef>
<typedef name="void_pointer"><type>segment_manager::void_pointer</type></typedef>
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="size_type"><type>segment_manager::size_type</type></typedef>
<typedef name="difference_type"><type>segment_manager::difference_type</type></typedef>
<method-group name="private member functions">
</method-group>
<copy-assignment><type><classname>cached_adaptive_pool</classname> &amp;</type><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="SegmentManager2"/>
          <template-nontype-parameter name="N2"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F2"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP2"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name=""><paramtype>const <classname>cached_adaptive_pool</classname>&lt; T2, SegmentManager2, N2, F2, OP2 &gt; &amp;</paramtype></parameter><description><para>Not assignable from related <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname> </para></description></copy-assignment>
<copy-assignment><type><classname>cached_adaptive_pool</classname> &amp;</type><parameter name=""><paramtype>const <classname>cached_adaptive_pool</classname> &amp;</paramtype></parameter><description><para>Not assignable from other <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname> </para></description></copy-assignment>
<method-group name="public member functions">
<method name="get_node_pool" cv="const"><type>node_pool_t *</type><description><para>Returns a pointer to the node pool. Never throws </para></description></method>
<method name="get_segment_manager" cv="const"><type>segment_manager *</type><description><para>Returns the segment manager. Never throws </para></description></method>
<method name="max_size" cv="const"><type>size_type</type><description><para>Returns the number of elements that could be allocated. Never throws </para></description></method>
<method name="allocate"><type>pointer</type><parameter name="count"><paramtype>size_type</paramtype></parameter><parameter name="hint"><paramtype>cvoid_pointer</paramtype><default>0</default></parameter><description><para>Allocate memory for an array of count elements. Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="deallocate"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="count"><paramtype>size_type</paramtype></parameter><description><para>Deallocate allocated memory. Never throws </para></description></method>
<method name="deallocate_free_blocks"><type>void</type><description><para>Deallocates all free blocks of the pool </para></description></method>
<method name="address" cv="const"><type>pointer</type><parameter name="value"><paramtype>reference</paramtype></parameter><description><para>Returns address of mutable object. Never throws </para></description></method>
<method name="address" cv="const"><type>const_pointer</type><parameter name="value"><paramtype>const_reference</paramtype></parameter><description><para>Returns address of non mutable object. Never throws </para></description></method>
<method name="construct"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para>Copy construct an object. Throws if T's copy constructor throws </para></description></method>
<method name="destroy"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Destroys object. Throws if object's destructor throws </para></description></method>
<method name="size" cv="const"><type>size_type</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many. </para></description></method>
<method name="allocation_command"><type>pointer</type><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_size"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse"><paramtype>pointer &amp;</paramtype></parameter></method>
<method name="allocate_many"><type>void</type><parameter name="elem_size"><paramtype>size_type</paramtype></parameter><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_many"><type>void</type><parameter name="elem_sizes"><paramtype>const size_type *</paramtype></parameter><parameter name="n_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </para></description></method>
<method name="deallocate_many"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_one"><type>pointer</type><description><para>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="allocate_individual"><type>multiallocation_chain</type><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="deallocate_one"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </para></description></method>
<method name="deallocate_individual"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="set_max_cached_nodes"><type>void</type><parameter name="newmax"><paramtype>size_type</paramtype></parameter><description><para>Sets the new max cached nodes value. This can provoke deallocations if "newmax" is less than current cached nodes. Never throws </para></description></method>
<method name="get_max_cached_nodes" cv="const"><type>size_type</type><description><para>Returns the max cached nodes parameter. Never throws </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype>segment_manager *</paramtype></parameter><description><para>Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<constructor><parameter name="other"><paramtype>const <classname>cached_adaptive_pool</classname> &amp;</paramtype></parameter><description><para>Copy constructor from other <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname>. Increments the reference count of the associated node pool. Never throws </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="other"><paramtype>const <classname>cached_adaptive_pool</classname>&lt; T2, SegmentManager, NodesPerBlock, MaxFreeBlocks, OverheadPercent &gt; &amp;</paramtype></parameter><description><para>Copy constructor from related <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<destructor><description><para>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </para></description></destructor>
<method-group name="friend functions">
<method name="swap"><type>friend void</type><parameter name="alloc1"><paramtype>self_t &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>self_t &amp;</paramtype></parameter><description><para>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </para></description></method>
</method-group>
</class>














<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>cached_adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>cached_adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><description><para>Equality test for same type of <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname> </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>cached_adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>cached_adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><description><para>Inequality test for same type of <classname alt="boost::interprocess::cached_adaptive_pool">cached_adaptive_pool</classname> </para></description></function>
































</namespace>
</namespace>
</header>
<header name="boost/interprocess/allocators/cached_node_allocator.hpp">
<para>Describes cached_cached_node_allocator pooled shared memory STL compatible allocator </para><namespace name="boost">
<namespace name="interprocess">
<class name="cached_node_allocator"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="SegmentManager"/>
      <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
    </template><struct name="rebind"><template>
      <template-type-parameter name="T2"/>
    </template><description><para>Obtains <classname alt="boost::interprocess::cached_node_allocator">cached_node_allocator</classname> from <classname alt="boost::interprocess::cached_node_allocator">cached_node_allocator</classname> </para></description><typedef name="other"><type><classname>cached_node_allocator</classname>&lt; T2, SegmentManager &gt;</type></typedef>
</struct><typedef name="segment_manager"><type>implementation_defined::segment_manager</type></typedef>
<typedef name="void_pointer"><type>segment_manager::void_pointer</type></typedef>
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="size_type"><type>SegmentManager::size_type</type></typedef>
<typedef name="difference_type"><type>SegmentManager::difference_type</type></typedef>
<method-group name="private member functions">
</method-group>
<copy-assignment><type><classname>cached_node_allocator</classname> &amp;</type><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="SegmentManager2"/>
          <template-nontype-parameter name="N2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name=""><paramtype>const <classname>cached_node_allocator</classname>&lt; T2, SegmentManager2, N2 &gt; &amp;</paramtype></parameter><description><para>Not assignable from related <classname alt="boost::interprocess::cached_node_allocator">cached_node_allocator</classname> </para></description></copy-assignment>
<copy-assignment><type><classname>cached_node_allocator</classname> &amp;</type><parameter name=""><paramtype>const <classname>cached_node_allocator</classname> &amp;</paramtype></parameter><description><para>Not assignable from other <classname alt="boost::interprocess::cached_node_allocator">cached_node_allocator</classname> </para></description></copy-assignment>
<method-group name="public member functions">
<method name="get_node_pool" cv="const"><type>node_pool_t *</type><description><para>Returns a pointer to the node pool. Never throws </para></description></method>
<method name="get_segment_manager" cv="const"><type>segment_manager *</type><description><para>Returns the segment manager. Never throws </para></description></method>
<method name="max_size" cv="const"><type>size_type</type><description><para>Returns the number of elements that could be allocated. Never throws </para></description></method>
<method name="allocate"><type>pointer</type><parameter name="count"><paramtype>size_type</paramtype></parameter><parameter name="hint"><paramtype>cvoid_pointer</paramtype><default>0</default></parameter><description><para>Allocate memory for an array of count elements. Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="deallocate"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="count"><paramtype>size_type</paramtype></parameter><description><para>Deallocate allocated memory. Never throws </para></description></method>
<method name="deallocate_free_blocks"><type>void</type><description><para>Deallocates all free blocks of the pool </para></description></method>
<method name="address" cv="const"><type>pointer</type><parameter name="value"><paramtype>reference</paramtype></parameter><description><para>Returns address of mutable object. Never throws </para></description></method>
<method name="address" cv="const"><type>const_pointer</type><parameter name="value"><paramtype>const_reference</paramtype></parameter><description><para>Returns address of non mutable object. Never throws </para></description></method>
<method name="construct"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para>Default construct an object. Throws if T's default constructor throws </para></description></method>
<method name="destroy"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Destroys object. Throws if object's destructor throws </para></description></method>
<method name="size" cv="const"><type>size_type</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many. </para></description></method>
<method name="allocation_command"><type>pointer</type><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_size"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse"><paramtype>pointer &amp;</paramtype></parameter></method>
<method name="allocate_many"><type>void</type><parameter name="elem_size"><paramtype>size_type</paramtype></parameter><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_many"><type>void</type><parameter name="elem_sizes"><paramtype>const size_type *</paramtype></parameter><parameter name="n_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </para></description></method>
<method name="deallocate_many"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_one"><type>pointer</type><description><para>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="allocate_individual"><type>multiallocation_chain</type><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="deallocate_one"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </para></description></method>
<method name="deallocate_individual"><type>void</type><parameter name="it"><paramtype>multiallocation_chain</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="set_max_cached_nodes"><type>void</type><parameter name="newmax"><paramtype>size_type</paramtype></parameter><description><para>Sets the new max cached nodes value. This can provoke deallocations if "newmax" is less than current cached nodes. Never throws </para></description></method>
<method name="get_max_cached_nodes" cv="const"><type>size_type</type><description><para>Returns the max cached nodes parameter. Never throws </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype>segment_manager *</paramtype></parameter><description><para>Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<constructor><parameter name="other"><paramtype>const <classname>cached_node_allocator</classname> &amp;</paramtype></parameter><description><para>Copy constructor from other <classname alt="boost::interprocess::cached_node_allocator">cached_node_allocator</classname>. Increments the reference count of the associated node pool. Never throws </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="other"><paramtype>const <classname>cached_node_allocator</classname>&lt; T2, SegmentManager, NodesPerBlock &gt; &amp;</paramtype></parameter><description><para>Copy constructor from related <classname alt="boost::interprocess::cached_node_allocator">cached_node_allocator</classname>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<destructor><description><para>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </para></description></destructor>
<method-group name="friend functions">
<method name="swap"><type>friend void</type><parameter name="alloc1"><paramtype>self_t &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>self_t &amp;</paramtype></parameter><description><para>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </para></description></method>
</method-group>
</class>












<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NPC"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>cached_node_allocator</classname>&lt; T, S, NPC &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>cached_node_allocator</classname>&lt; T, S, NPC &gt; &amp;</paramtype></parameter><description><para>Equality test for same type of <classname alt="boost::interprocess::cached_node_allocator">cached_node_allocator</classname> </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NPC"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>cached_node_allocator</classname>&lt; T, S, NPC &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>cached_node_allocator</classname>&lt; T, S, NPC &gt; &amp;</paramtype></parameter><description><para>Inequality test for same type of <classname alt="boost::interprocess::cached_node_allocator">cached_node_allocator</classname> </para></description></function>


































</namespace>
</namespace>
</header>
<header name="boost/interprocess/allocators/node_allocator.hpp">
<para>Describes node_allocator pooled shared memory STL compatible allocator </para><namespace name="boost">
<namespace name="interprocess">
<class name="node_allocator"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="SegmentManager"/>
      <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
    </template><description><para>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... This node allocator shares a segregated storage between all instances of <classname alt="boost::interprocess::node_allocator">node_allocator</classname> with equal sizeof(T) placed in the same segment group. NodesPerBlock is the number of nodes allocated at once when the allocator runs out of nodes </para></description><struct name="rebind"><template>
      <template-type-parameter name="T2"/>
    </template><description><para>Obtains <classname alt="boost::interprocess::node_allocator">node_allocator</classname> from <classname alt="boost::interprocess::node_allocator">node_allocator</classname> </para></description><typedef name="other"><type><classname>node_allocator</classname>&lt; T2, SegmentManager, NodesPerBlock &gt;</type></typedef>
</struct><typedef name="segment_manager"><type>implementation_defined::segment_manager</type></typedef>
<typedef name="void_pointer"><type>segment_manager::void_pointer</type></typedef>
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="size_type"><type>segment_manager::size_type</type></typedef>
<typedef name="difference_type"><type>segment_manager::difference_type</type></typedef>
<method-group name="private member functions">
</method-group>
<copy-assignment><type><classname>node_allocator</classname> &amp;</type><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="SegmentManager2"/>
          <template-nontype-parameter name="N2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name=""><paramtype>const <classname>node_allocator</classname>&lt; T2, SegmentManager2, N2 &gt; &amp;</paramtype></parameter><description><para>Not assignable from related <classname alt="boost::interprocess::node_allocator">node_allocator</classname> </para></description></copy-assignment>
<method-group name="public member functions">
<method name="get_node_pool" cv="const"><type>void *</type><description><para>Returns a pointer to the node pool. Never throws </para></description></method>
<method name="get_segment_manager" cv="const"><type>segment_manager *</type><description><para>Returns the segment manager. Never throws </para></description></method>
<method name="max_size" cv="const"><type>size_type</type><description><para>Returns the number of elements that could be allocated. Never throws </para></description></method>
<method name="allocate"><type>pointer</type><parameter name="count"><paramtype>size_type</paramtype></parameter><parameter name="hint"><paramtype>cvoid_pointer</paramtype><default>0</default></parameter><description><para>Allocate memory for an array of count elements. Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="deallocate"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="count"><paramtype>size_type</paramtype></parameter><description><para>Deallocate allocated memory. Never throws </para></description></method>
<method name="deallocate_free_blocks"><type>void</type><description><para>Deallocates all free blocks of the pool </para></description></method>
<method name="address" cv="const"><type>pointer</type><parameter name="value"><paramtype>reference</paramtype></parameter><description><para>Returns address of mutable object. Never throws </para></description></method>
<method name="address" cv="const"><type>const_pointer</type><parameter name="value"><paramtype>const_reference</paramtype></parameter><description><para>Returns address of non mutable object. Never throws </para></description></method>
<method name="construct"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para>Copy construct an object. Throws if T's copy constructor throws </para></description></method>
<method name="destroy"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Destroys object. Throws if object's destructor throws </para></description></method>
<method name="size" cv="const"><type>size_type</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many. </para></description></method>
<method name="allocation_command"><type>pointer</type><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_size"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse"><paramtype>pointer &amp;</paramtype></parameter></method>
<method name="allocate_many"><type>void</type><parameter name="elem_size"><paramtype>size_type</paramtype></parameter><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_many"><type>void</type><parameter name="elem_sizes"><paramtype>const size_type *</paramtype></parameter><parameter name="n_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </para></description></method>
<method name="deallocate_many"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_one"><type>pointer</type><description><para>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="allocate_individual"><type>void</type><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="deallocate_one"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </para></description></method>
<method name="deallocate_individual"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype>segment_manager *</paramtype></parameter><description><para>Not assignable from other <classname alt="boost::interprocess::node_allocator">node_allocator</classname> Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<constructor><parameter name="other"><paramtype>const <classname>node_allocator</classname> &amp;</paramtype></parameter><description><para>Copy constructor from other <classname alt="boost::interprocess::node_allocator">node_allocator</classname>. Increments the reference count of the associated node pool. Never throws </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="other"><paramtype>const <classname>node_allocator</classname>&lt; T2, SegmentManager, NodesPerBlock &gt; &amp;</paramtype></parameter><description><para>Copy constructor from related <classname alt="boost::interprocess::node_allocator">node_allocator</classname>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<destructor><description><para>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </para></description></destructor>
<method-group name="friend functions">
<method name="swap"><type>friend void</type><parameter name="alloc1"><paramtype>self_t &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>self_t &amp;</paramtype></parameter><description><para>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </para></description></method>
</method-group>
</class>










<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NPC"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>node_allocator</classname>&lt; T, S, NPC &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>node_allocator</classname>&lt; T, S, NPC &gt; &amp;</paramtype></parameter><description><para>Equality test for same type of <classname alt="boost::interprocess::node_allocator">node_allocator</classname> </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NPC"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>node_allocator</classname>&lt; T, S, NPC &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>node_allocator</classname>&lt; T, S, NPC &gt; &amp;</paramtype></parameter><description><para>Inequality test for same type of <classname alt="boost::interprocess::node_allocator">node_allocator</classname> </para></description></function>




































</namespace>
</namespace>
</header>
<header name="boost/interprocess/allocators/private_adaptive_pool.hpp">
<para>Describes private_adaptive_pool_base pooled shared memory STL compatible allocator </para><namespace name="boost">
<namespace name="interprocess">
<class name="private_adaptive_pool"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="SegmentManager"/>
      <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
      <template-nontype-parameter name="MaxFreeBlocks"><type>std::size_t</type></template-nontype-parameter>
      <template-nontype-parameter name="OverheadPercent"><type>unsigned char</type></template-nontype-parameter>
    </template><description><para>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... This allocator has its own node pool.</para><para>NodesPerBlock is the minimum number of nodes of nodes allocated at once when the allocator needs runs out of nodes. MaxFreeBlocks is the maximum number of totally free blocks that the adaptive node pool will hold. The rest of the totally free blocks will be deallocated with the segment manager.</para><para>OverheadPercent is the (approximated) maximum size overhead (1-20%) of the allocator: (memory usable for nodes / total memory allocated from the segment manager) </para></description><struct name="rebind"><template>
      <template-type-parameter name="T2"/>
    </template><description><para>Obtains <classname alt="boost::interprocess::private_adaptive_pool">private_adaptive_pool</classname> from <classname alt="boost::interprocess::private_adaptive_pool">private_adaptive_pool</classname> </para></description><typedef name="other"><type><classname>private_adaptive_pool</classname>&lt; T2, SegmentManager, NodesPerBlock, MaxFreeBlocks, OverheadPercent &gt;</type></typedef>
</struct><typedef name="segment_manager"><type>implementation_defined::segment_manager</type></typedef>
<typedef name="void_pointer"><type>segment_manager::void_pointer</type></typedef>
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="size_type"><type>segment_manager::size_type</type></typedef>
<typedef name="difference_type"><type>segment_manager::difference_type</type></typedef>
<method-group name="private member functions">
</method-group>
<copy-assignment><type><classname>private_adaptive_pool</classname> &amp;</type><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="SegmentManager2"/>
          <template-nontype-parameter name="N2"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F2"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP2"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name=""><paramtype>const <classname>private_adaptive_pool</classname>&lt; T2, SegmentManager2, N2, F2 &gt; &amp;</paramtype></parameter><description><para>Not assignable from related <classname alt="boost::interprocess::private_adaptive_pool">private_adaptive_pool</classname> </para></description></copy-assignment>
<copy-assignment><type><classname>private_adaptive_pool</classname> &amp;</type><parameter name=""><paramtype>const <classname>private_adaptive_pool</classname> &amp;</paramtype></parameter><description><para>Not assignable from other <classname alt="boost::interprocess::private_adaptive_pool">private_adaptive_pool</classname> </para></description></copy-assignment>
<method-group name="public member functions">
<method name="get_node_pool" cv="const"><type>node_pool_t *</type><description><para>Returns a pointer to the node pool. Never throws </para></description></method>
<method name="get_segment_manager" cv="const"><type>segment_manager *</type><description><para>Returns the segment manager. Never throws </para></description></method>
<method name="max_size" cv="const"><type>size_type</type><description><para>Returns the number of elements that could be allocated. Never throws </para></description></method>
<method name="allocate"><type>pointer</type><parameter name="count"><paramtype>size_type</paramtype></parameter><parameter name="hint"><paramtype>cvoid_pointer</paramtype><default>0</default></parameter><description><para>Allocate memory for an array of count elements. Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="deallocate"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="count"><paramtype>size_type</paramtype></parameter><description><para>Deallocate allocated memory. Never throws </para></description></method>
<method name="deallocate_free_blocks"><type>void</type><description><para>Deallocates all free blocks of the pool </para></description></method>
<method name="address" cv="const"><type>pointer</type><parameter name="value"><paramtype>reference</paramtype></parameter><description><para>Returns address of mutable object. Never throws </para></description></method>
<method name="address" cv="const"><type>const_pointer</type><parameter name="value"><paramtype>const_reference</paramtype></parameter><description><para>Returns address of non mutable object. Never throws </para></description></method>
<method name="construct"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para>Copy construct an object. Throws if T's copy constructor throws </para></description></method>
<method name="destroy"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Destroys object. Throws if object's destructor throws </para></description></method>
<method name="size" cv="const"><type>size_type</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many. </para></description></method>
<method name="allocation_command"><type>pointer</type><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_size"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse"><paramtype>pointer &amp;</paramtype></parameter></method>
<method name="allocate_many"><type>void</type><parameter name="elem_size"><paramtype>size_type</paramtype></parameter><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_many"><type>void</type><parameter name="elem_sizes"><paramtype>const size_type *</paramtype></parameter><parameter name="n_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </para></description></method>
<method name="deallocate_many"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_one"><type>pointer</type><description><para>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="allocate_individual"><type>void</type><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="deallocate_one"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </para></description></method>
<method name="deallocate_individual"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype>segment_manager *</paramtype></parameter><description><para>Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<constructor><parameter name="other"><paramtype>const <classname>private_adaptive_pool</classname> &amp;</paramtype></parameter><description><para>Copy constructor from other <classname alt="boost::interprocess::private_adaptive_pool">private_adaptive_pool</classname>. Increments the reference count of the associated node pool. Never throws </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="other"><paramtype>const <classname>private_adaptive_pool</classname>&lt; T2, SegmentManager, NodesPerBlock, MaxFreeBlocks, OverheadPercent &gt; &amp;</paramtype></parameter><description><para>Copy constructor from related <classname alt="boost::interprocess::private_adaptive_pool">private_adaptive_pool</classname>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<destructor><description><para>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </para></description></destructor>
<method-group name="friend functions">
<method name="swap"><type>friend void</type><parameter name="alloc1"><paramtype>self_t &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>self_t &amp;</paramtype></parameter><description><para>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </para></description></method>
</method-group>
</class>








<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>private_adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>private_adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><description><para>Equality test for same type of <classname alt="boost::interprocess::private_adaptive_pool">private_adaptive_pool</classname> </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>private_adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>private_adaptive_pool</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><description><para>Inequality test for same type of <classname alt="boost::interprocess::private_adaptive_pool">private_adaptive_pool</classname> </para></description></function>






































</namespace>
</namespace>
</header>
<header name="boost/interprocess/allocators/private_node_allocator.hpp">
<para>Describes private_node_allocator_base pooled shared memory STL compatible allocator </para><namespace name="boost">
<namespace name="interprocess">
<class name="private_node_allocator"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="SegmentManager"/>
      <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
    </template><description><para>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... This allocator has its own node pool. NodesPerBlock is the number of nodes allocated at once when the allocator needs runs out of nodes </para></description><struct name="rebind"><template>
      <template-type-parameter name="T2"/>
    </template><description><para>Obtains <classname alt="boost::interprocess::private_node_allocator">private_node_allocator</classname> from <classname alt="boost::interprocess::private_node_allocator">private_node_allocator</classname> </para></description><typedef name="other"><type><classname>private_node_allocator</classname>&lt; T2, SegmentManager, NodesPerBlock &gt;</type></typedef>
</struct><typedef name="segment_manager"><type>implementation_defined::segment_manager</type></typedef>
<typedef name="void_pointer"><type>segment_manager::void_pointer</type></typedef>
<typedef name="pointer"><type>implementation_defined::pointer</type></typedef>
<typedef name="const_pointer"><type>implementation_defined::const_pointer</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="size_type"><type>segment_manager::size_type</type></typedef>
<typedef name="difference_type"><type>segment_manage::difference_type</type></typedef>
<method-group name="private member functions">
</method-group>
<copy-assignment><type><classname>private_node_allocator</classname> &amp;</type><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="SegmentManager2"/>
          <template-nontype-parameter name="N2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name=""><paramtype>const <classname>private_node_allocator</classname>&lt; T2, SegmentManager2, N2 &gt; &amp;</paramtype></parameter><description><para>Not assignable from related <classname alt="boost::interprocess::private_node_allocator">private_node_allocator</classname> </para></description></copy-assignment>
<copy-assignment><type><classname>private_node_allocator</classname> &amp;</type><parameter name=""><paramtype>const <classname>private_node_allocator</classname> &amp;</paramtype></parameter><description><para>Not assignable from other <classname alt="boost::interprocess::private_node_allocator">private_node_allocator</classname> </para></description></copy-assignment>
<method-group name="public member functions">
<method name="get_node_pool" cv="const"><type>node_pool_t *</type><description><para>Returns a pointer to the node pool. Never throws </para></description></method>
<method name="get_segment_manager" cv="const"><type>segment_manager *</type><description><para>Returns the segment manager. Never throws </para></description></method>
<method name="max_size" cv="const"><type>size_type</type><description><para>Returns the number of elements that could be allocated. Never throws </para></description></method>
<method name="allocate"><type>pointer</type><parameter name="count"><paramtype>size_type</paramtype></parameter><parameter name="hint"><paramtype>cvoid_pointer</paramtype><default>0</default></parameter><description><para>Allocate memory for an array of count elements. Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="deallocate"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="count"><paramtype>size_type</paramtype></parameter><description><para>Deallocate allocated memory. Never throws </para></description></method>
<method name="deallocate_free_blocks"><type>void</type><description><para>Deallocates all free blocks of the pool </para></description></method>
<method name="address" cv="const"><type>pointer</type><parameter name="value"><paramtype>reference</paramtype></parameter><description><para>Returns address of mutable object. Never throws </para></description></method>
<method name="address" cv="const"><type>const_pointer</type><parameter name="value"><paramtype>const_reference</paramtype></parameter><description><para>Returns address of non mutable object. Never throws </para></description></method>
<method name="construct"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="v"><paramtype>const_reference</paramtype></parameter><description><para>Copy construct an object. Throws if T's copy constructor throws </para></description></method>
<method name="destroy"><type>void</type><parameter name="ptr"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Destroys object. Throws if object's destructor throws </para></description></method>
<method name="size" cv="const"><type>size_type</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many. </para></description></method>
<method name="allocation_command"><type>pointer</type><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_size"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse"><paramtype>pointer &amp;</paramtype></parameter></method>
<method name="allocate_many"><type>void</type><parameter name="elem_size"><paramtype>size_type</paramtype></parameter><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_many"><type>void</type><parameter name="elem_sizes"><paramtype>const size_type *</paramtype></parameter><parameter name="n_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </para></description></method>
<method name="deallocate_many"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </para></description></method>
<method name="allocate_one"><type>pointer</type><description><para>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory </para></description></method>
<method name="allocate_individual"><type>void</type><parameter name="num_elements"><paramtype>size_type</paramtype></parameter><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
<method name="deallocate_one"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </para></description></method>
<method name="deallocate_individual"><type>void</type><parameter name="chain"><paramtype>multiallocation_chain &amp;</paramtype></parameter><description><para>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype>segment_manager *</paramtype></parameter><description><para>Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<constructor><parameter name="other"><paramtype>const <classname>private_node_allocator</classname> &amp;</paramtype></parameter><description><para>Copy constructor from other <classname alt="boost::interprocess::private_node_allocator">private_node_allocator</classname>. Increments the reference count of the associated node pool. Never throws </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="other"><paramtype>const <classname>private_node_allocator</classname>&lt; T2, SegmentManager, NodesPerBlock &gt; &amp;</paramtype></parameter><description><para>Copy constructor from related <classname alt="boost::interprocess::private_node_allocator">private_node_allocator</classname>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> </para></description></constructor>
<destructor><description><para>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </para></description></destructor>
<method-group name="friend functions">
<method name="swap"><type>friend void</type><parameter name="alloc1"><paramtype>self_t &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>self_t &amp;</paramtype></parameter><description><para>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </para></description></method>
</method-group>
</class>






<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>private_node_allocator</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>private_node_allocator</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><description><para>Equality test for same type of <classname alt="boost::interprocess::private_node_allocator">private_node_allocator</classname> </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="S"/>
          <template-nontype-parameter name="NodesPerBlock"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="F"><type>std::size_t</type></template-nontype-parameter>
          <template-nontype-parameter name="OP"><type>unsigned char</type></template-nontype-parameter>
        </template><parameter name="alloc1"><paramtype>const <classname>private_node_allocator</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><parameter name="alloc2"><paramtype>const <classname>private_node_allocator</classname>&lt; T, S, NodesPerBlock, F, OP &gt; &amp;</paramtype></parameter><description><para>Inequality test for same type of <classname alt="boost::interprocess::private_node_allocator">private_node_allocator</classname> </para></description></function>








































</namespace>
</namespace>
</header>
<header name="boost/interprocess/anonymous_shared_memory.hpp">
<para>Describes a function that creates anonymous shared memory that can be shared between forked processes </para><namespace name="boost">
<namespace name="interprocess">






<function name="anonymous_shared_memory"><type><classname>mapped_region</classname></type><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="address"><paramtype>void *</paramtype><default>0</default></parameter><description><para>A function that creates an anonymous shared memory segment of size "size". If "address" is passed the function will try to map the segment in that address. Otherwise the operating system will choose the mapping address. The function returns a <classname alt="boost::interprocess::mapped_region">mapped_region</classname> holding that segment or throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if the function fails. </para></description></function>










































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/allocation_type.hpp">
<namespace name="boost">
<namespace name="interprocess">
<data-member name="allocate_new" specifiers="static"><type>const allocation_type</type></data-member>
<data-member name="expand_fwd" specifiers="static"><type>const allocation_type</type></data-member>
<data-member name="expand_bwd" specifiers="static"><type>const allocation_type</type></data-member>
<data-member name="shrink_in_place" specifiers="static"><type>const allocation_type</type></data-member>
<data-member name="try_shrink_in_place" specifiers="static"><type>const allocation_type</type></data-member>
<data-member name="nothrow_allocation" specifiers="static"><type>const allocation_type</type></data-member>
<data-member name="zero_memory" specifiers="static"><type>const allocation_type</type></data-member>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/containers_fwd.hpp">
</header>
<header name="boost/interprocess/containers/deque.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/flat_map.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/flat_set.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/list.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/map.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/pair.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/set.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/slist.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/stable_vector.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/string.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/vector.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/containers/version_type.hpp">
<namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/creation_tags.hpp">
<namespace name="boost">
<namespace name="interprocess">
<struct name="create_only_t"><description><para>Tag to indicate that the resource must be only created </para></description></struct><struct name="open_copy_on_write_t"><description><para>Tag to indicate that the resource must be only opened for reading </para></description></struct><struct name="open_only_t"><description><para>Tag to indicate that the resource must be only opened </para></description></struct><struct name="open_or_create_t"><description><para>Tag to indicate that the resource must be created. If already created, it must be opened. </para></description></struct><struct name="open_read_only_t"><description><para>Tag to indicate that the resource must be only opened for reading </para></description></struct><struct name="open_read_private_t"><description><para>Tag to indicate that the resource must be only opened privately for reading </para></description></struct><data-member name="create_only" specifiers="static"><type>const <classname>create_only_t</classname></type><description><para>Value to indicate that the resource must be only created </para></description></data-member>
<data-member name="open_only" specifiers="static"><type>const <classname>open_only_t</classname></type><description><para>Value to indicate that the resource must be only opened </para></description></data-member>
<data-member name="open_read_only" specifiers="static"><type>const <classname>open_read_only_t</classname></type><description><para>Value to indicate that the resource must be only opened for reading </para></description></data-member>
<data-member name="open_or_create" specifiers="static"><type>const <classname>open_or_create_t</classname></type><description><para>Value to indicate that the resource must be created. If already created, it must be opened. </para></description></data-member>
<data-member name="open_copy_on_write" specifiers="static"><type>const <classname>open_copy_on_write_t</classname></type><description><para>Value to indicate that the resource must be only opened for reading </para></description></data-member>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/errors.hpp">
<para>Describes the error numbering of interprocess classes </para><namespace name="boost">
<namespace name="interprocess">
<enum name="error_code_t"><enumvalue name="no_error"><default>= 0</default></enumvalue><enumvalue name="system_error"/><enumvalue name="other_error"/><enumvalue name="security_error"/><enumvalue name="read_only_error"/><enumvalue name="io_error"/><enumvalue name="path_error"/><enumvalue name="not_found_error"/><enumvalue name="busy_error"/><enumvalue name="already_exists_error"/><enumvalue name="not_empty_error"/><enumvalue name="is_directory_error"/><enumvalue name="out_of_space_error"/><enumvalue name="out_of_memory_error"/><enumvalue name="out_of_resource_error"/><enumvalue name="lock_error"/><enumvalue name="sem_error"/><enumvalue name="mode_error"/><enumvalue name="size_error"/><enumvalue name="corrupted_error"/><enumvalue name="not_such_file_or_directory"/><enumvalue name="invalid_argument"/><enumvalue name="timeout_when_locking_error"/><enumvalue name="timeout_when_waiting_error"/><enumvalue name="owner_dead_error"/><enumvalue name="not_recoverable"/></enum>
<typedef name="native_error_t"><type>int</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/exceptions.hpp">
<para>Describes exceptions thrown by interprocess classes </para><namespace name="boost">
<namespace name="interprocess">
<class name="bad_alloc"><inherit access="public">boost::interprocess::interprocess_exception</inherit><description><para>This exception is thrown when a memory request can't be fulfilled. </para></description><method-group name="public member functions">
<method name="what" cv="const noexcept"><type>const char *</type></method>
</method-group>
<constructor/>
</class><class name="interprocess_exception"><inherit access="public">exception</inherit><description><para>This class is the base class of all exceptions thrown by boost::interprocess </para></description><method-group name="public member functions">
<method name="what" cv="const noexcept"><type>const char *</type></method>
<method name="get_native_error" cv="const noexcept"><type>native_error_t</type></method>
<method name="get_error_code" cv="const noexcept"><type>error_code_t</type></method>
</method-group>
<constructor cv="noexcept"><parameter name="err"><paramtype>const char *</paramtype></parameter></constructor>
<constructor><parameter name="err_info"><paramtype>const error_info &amp;</paramtype></parameter><parameter name="str"><paramtype>const char *</paramtype><default>0</default></parameter></constructor>
<destructor/>
</class><class name="lock_exception"><inherit access="public">boost::interprocess::interprocess_exception</inherit><description><para>This is the exception thrown by shared <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> family when a deadlock situation is detected or when using a <classname alt="boost::interprocess::interprocess_condition">interprocess_condition</classname> the <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> is not locked </para></description><method-group name="public member functions">
<method name="what" cv="const noexcept"><type>const char *</type></method>
</method-group>
<constructor cv="noexcept"><parameter name="err"><paramtype>error_code_t</paramtype><default>lock_error</default></parameter></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/file_mapping.hpp">
<para>Describes file_mapping and mapped region classes </para><namespace name="boost">
<namespace name="interprocess">
<class name="file_mapping"><description><para>A class that wraps a file-mapping that can be used to create mapped regions from the mapped files </para></description><method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>file_mapping</classname> &amp;</paramtype></parameter><description><para>Swaps to file_mappings. Does not throw. </para></description></method>
<method name="get_mode" cv="const noexcept"><type>mode_t</type><description><para>Returns access mode used in the constructor </para></description></method>
<method name="get_mapping_handle" cv="const noexcept"><type>mapping_handle_t</type><description><para>Obtains the mapping handle to be used with <classname alt="boost::interprocess::mapped_region">mapped_region</classname> </para></description></method>
<method name="get_name" cv="const noexcept"><type>const char *</type><description><para>Returns the name of the file used in the constructor. </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Constructs an empty file mapping. Does not throw </para></description></constructor>
<constructor><parameter name="filename"><paramtype>const char *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><description><para>Opens a file mapping of file "filename", starting in offset "file_offset", and the mapping's size will be "size". The mapping can be opened for read-only "read_only" or read-write "read_write" modes. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></constructor>
<constructor><parameter name="filename"><paramtype>const wchar_t *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><description><para>Opens a file mapping of file "filename", starting in offset "file_offset", and the mapping's size will be "size". The mapping can be opened for read-only "read_only" or read-write "read_write" modes. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>file_mapping</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s file mapping object to *this. After the call, "moved" does not represent any file mapping object. Does not throw </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>file_mapping</classname> &amp;</type><parameter name="moved"><paramtype><classname>file_mapping</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s file mapping to *this. After the call, "moved" does not represent any file mapping. Does not throw </para></description></copy-assignment>
<destructor><description><para>Destroys the file mapping. All mapped regions created from this are still valid. Does not throw </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="filename"><paramtype>const char *</paramtype></parameter><description><para>Removes the file named "filename" even if it's been memory mapped. Returns true on success. The function might fail in some operating systems if the file is being used other processes and no deletion permission was shared. </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="filename"><paramtype>const wchar_t *</paramtype></parameter><description><para>Removes the file named "filename" even if it's been memory mapped. Returns true on success. The function might fail in some operating systems if the file is being used other processes and no deletion permission was shared.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/indexes/flat_map_index.hpp">
<para>Describes index adaptor of boost::map container, to use it as name/shared memory index </para><namespace name="boost">
<namespace name="interprocess">
<class name="flat_map_index"><template>
      <template-type-parameter name="MapConfig"/>
    </template><inherit access="public">flat_map_index_aux::index_t&lt; MapConfig &gt;</inherit><description><para>Index type based in flat_map. Just derives from flat_map and defines the interface needed by managed memory segments. </para></description><method-group name="public member functions">
<method name="reserve"><type>void</type><parameter name="n"><paramtype>typename segment_manager_base::size_type</paramtype></parameter><purpose>This reserves memory to optimize the insertion of n elements in the index. </purpose></method>
<method name="shrink_to_fit"><type>void</type><purpose>This frees all unnecessary memory. </purpose></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype><classname>segment_manager_base</classname> *</paramtype></parameter><purpose>Constructor. Takes a pointer to the segment manager. Can throw. </purpose></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/indexes/iset_index.hpp">
<para>Describes index adaptor of boost::intrusive::set container, to use it as name/shared memory index </para><namespace name="boost">
<namespace name="interprocess">
<class name="iset_index"><template>
      <template-type-parameter name="MapConfig"/>
    </template><inherit access="public">iset_index_aux::index_t&lt; MapConfig &gt;</inherit><description><para>Index type based in boost::intrusive::set. Just derives from boost::intrusive::set and defines the interface needed by managed memory segments </para></description><typedef name="iterator"><type>index_type::iterator</type></typedef>
<typedef name="const_iterator"><type>index_type::const_iterator</type></typedef>
<typedef name="insert_commit_data"><type>index_type::insert_commit_data</type></typedef>
<typedef name="value_type"><type>index_type::value_type</type></typedef>
<method-group name="public member functions">
<method name="reserve"><type>void</type><parameter name=""><paramtype>typename MapConfig::segment_manager_base::size_type</paramtype></parameter><description><para>This reserves memory to optimize the insertion of n elements in the index </para></description></method>
<method name="shrink_to_fit"><type>void</type><purpose>This frees all unnecessary memory. </purpose></method>
<method name="find"><type>iterator</type><parameter name="key"><paramtype>const intrusive_compare_key_type &amp;</paramtype></parameter></method>
<method name="find" cv="const"><type>const_iterator</type><parameter name="key"><paramtype>const intrusive_compare_key_type &amp;</paramtype></parameter></method>
<method name="insert_check"><type>std::pair&lt; iterator, bool &gt;</type><parameter name="key"><paramtype>const intrusive_compare_key_type &amp;</paramtype></parameter><parameter name="commit_data"><paramtype>insert_commit_data &amp;</paramtype></parameter></method>
</method-group>
<constructor><parameter name=""><paramtype>typename MapConfig::segment_manager_base *</paramtype></parameter><description><para>Constructor. Takes a pointer to the segment manager. Can throw </para></description></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/indexes/iunordered_set_index.hpp">
<para>Describes index adaptor of boost::intrusive::unordered_set container, to use it as name/shared memory index </para><namespace name="boost">
<namespace name="interprocess">
<class name="iunordered_set_index"><template>
      <template-type-parameter name="MapConfig"/>
    </template><inherit access="private">iunordered_set_index_aux::allocator_holder&lt; MapConfig &gt;</inherit><inherit access="public">iunordered_set_index_aux::index_t&lt; MapConfig &gt;</inherit><description><para>Index type based in boost::intrusive::set. Just derives from boost::intrusive::set and defines the interface needed by managed memory segments </para></description><typedef name="iterator"><type>index_type::iterator</type></typedef>
<typedef name="const_iterator"><type>index_type::const_iterator</type></typedef>
<typedef name="insert_commit_data"><type>index_type::insert_commit_data</type></typedef>
<typedef name="value_type"><type>index_type::value_type</type></typedef>
<typedef name="bucket_ptr"><type>index_type::bucket_ptr</type></typedef>
<typedef name="bucket_type"><type>index_type::bucket_type</type></typedef>
<typedef name="bucket_traits"><type>index_type::bucket_traits</type></typedef>
<typedef name="size_type"><type>index_type::size_type</type></typedef>
<typedef name="difference_type"><type>index_type::difference_type</type></typedef>
<method-group name="public member functions">
<method name="reserve"><type>void</type><parameter name="new_n"><paramtype>size_type</paramtype></parameter><description><para>This reserves memory to optimize the insertion of n elements in the index </para></description></method>
<method name="shrink_to_fit"><type>void</type><description><para>This tries to free unused memory previously allocated. </para></description></method>
<method name="find"><type>iterator</type><parameter name="key"><paramtype>const intrusive_compare_key_type &amp;</paramtype></parameter></method>
<method name="find" cv="const"><type>const_iterator</type><parameter name="key"><paramtype>const intrusive_compare_key_type &amp;</paramtype></parameter></method>
<method name="insert_check"><type>std::pair&lt; iterator, bool &gt;</type><parameter name="key"><paramtype>const intrusive_compare_key_type &amp;</paramtype></parameter><parameter name="commit_data"><paramtype>insert_commit_data &amp;</paramtype></parameter></method>
<method name="insert_commit"><type>iterator</type><parameter name="val"><paramtype>value_type &amp;</paramtype></parameter><parameter name="commit_data"><paramtype>insert_commit_data &amp;</paramtype></parameter></method>
</method-group>
<constructor><parameter name="mngr"><paramtype><classname>segment_manager_base</classname> *</paramtype></parameter><description><para>Constructor. Takes a pointer to the segment manager. Can throw </para></description></constructor>
<destructor/>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/indexes/map_index.hpp">
<para>Describes index adaptor of boost::map container, to use it as name/shared memory index </para><namespace name="boost">
<namespace name="interprocess">
<class name="map_index"><template>
      <template-type-parameter name="MapConfig"/>
    </template><inherit access="public">boost::container::map&lt; MapConfig &gt;</inherit><description><para>Index type based in boost::interprocess::map. Just derives from boost::interprocess::map and defines the interface needed by managed memory segments </para></description><method-group name="public member functions">
<method name="reserve"><type>void</type><parameter name=""><paramtype>typename segment_manager_base::size_type</paramtype></parameter><description><para>This reserves memory to optimize the insertion of n elements in the index </para></description></method>
<method name="shrink_to_fit"><type>void</type><description><para>This tries to free previously allocate unused memory. </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype><classname>segment_manager_base</classname> *</paramtype></parameter><description><para>Constructor. Takes a pointer to the segment manager. Can throw </para></description></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/indexes/null_index.hpp">
<para>Describes a null index adaptor, so that if we don't want to construct named objects, we can use this null index type to save resources. </para><namespace name="boost">
<namespace name="interprocess">
<class name="null_index"><template>
      <template-type-parameter name="MapConfig"/>
    </template><description><para>Null index type used to save compilation time when named indexes are not needed. </para></description><typedef name="iterator"><type>int *</type></typedef>
<typedef name="const_iterator"><type>const int *</type></typedef>
<method-group name="public member functions">
<method name="begin" cv="const"><type>const_iterator</type><description><para>begin() is equal to end() </para></description></method>
<method name="begin"><type>iterator</type><description><para>begin() is equal to end() </para></description></method>
<method name="end" cv="const"><type>const_iterator</type><description><para>begin() is equal to end() </para></description></method>
<method name="end"><type>iterator</type><description><para>begin() is equal to end() </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>segment_manager_base</classname> *</paramtype></parameter><purpose>Empty constructor. </purpose></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/indexes/unordered_map_index.hpp">
<para>Describes index adaptor of boost::unordered_map container, to use it as name/shared memory index </para><namespace name="boost">
<namespace name="interprocess">
<class name="unordered_map_index"><template>
      <template-type-parameter name="MapConfig"/>
    </template><inherit access="public">unordered_map_index_aux::index_t&lt; MapConfig &gt;</inherit><description><para>Index type based in unordered_map. Just derives from unordered_map and defines the interface needed by managed memory segments </para></description><method-group name="public member functions">
<method name="reserve"><type>void</type><parameter name="n"><paramtype>typename segment_manager_base::size_type</paramtype></parameter><description><para>This reserves memory to optimize the insertion of n elements in the index </para></description></method>
<method name="shrink_to_fit"><type>void</type><description><para>This tries to free previously allocate unused memory. </para></description></method>
</method-group>
<constructor><parameter name="segment_mngr"><paramtype><classname>segment_manager_base</classname> *</paramtype></parameter><description><para>Constructor. Takes a pointer to the segment manager. Can throw </para></description></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/interprocess_fwd.hpp">
<para>This header file forward declares the basic interprocess types:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::offset_ptr">boost::interprocess::offset_ptr</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::permissions">boost::interprocess::permissions</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::mapped_region">boost::interprocess::mapped_region</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::file_mapping">boost::interprocess::file_mapping</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::shared_memory_object">boost::interprocess::shared_memory_object</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::windows_shared_memory">boost::interprocess::windows_shared_memory</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::xsi_shared_memory">boost::interprocess::xsi_shared_memory</classname>;</para>
</listitem></itemizedlist>
</para><para>The following synchronization mechanisms and locks:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::null_mutex">boost::interprocess::null_mutex</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::interprocess_mutex">boost::interprocess::interprocess_mutex</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::interprocess_recursive_mutex">boost::interprocess::interprocess_recursive_mutex</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::interprocess_semaphore">boost::interprocess::interprocess_semaphore</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::named_mutex">boost::interprocess::named_mutex</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::named_recursive_mutex">boost::interprocess::named_recursive_mutex</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::named_semaphore">boost::interprocess::named_semaphore</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::interprocess_sharable_mutex">boost::interprocess::interprocess_sharable_mutex</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::interprocess_condition">boost::interprocess::interprocess_condition</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::scoped_lock">boost::interprocess::scoped_lock</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::sharable_lock">boost::interprocess::sharable_lock</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::upgradable_lock">boost::interprocess::upgradable_lock</classname>;</para>
</listitem></itemizedlist>
</para><para>The following mutex families:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::mutex_family">boost::interprocess::mutex_family</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::null_mutex_family">boost::interprocess::null_mutex_family</classname>;</para>
</listitem></itemizedlist>
</para><para>The following allocators:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::allocator">boost::interprocess::allocator</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::node_allocator">boost::interprocess::node_allocator</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::private_node_allocator">boost::interprocess::private_node_allocator</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::cached_node_allocator">boost::interprocess::cached_node_allocator</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::adaptive_pool">boost::interprocess::adaptive_pool</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::private_adaptive_pool">boost::interprocess::private_adaptive_pool</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::cached_adaptive_pool">boost::interprocess::cached_adaptive_pool</classname>;</para>
</listitem></itemizedlist>
</para><para>The following allocation algorithms:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::simple_seq_fit">boost::interprocess::simple_seq_fit</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::rbtree_best_fit">boost::interprocess::rbtree_best_fit</classname>;</para>
</listitem></itemizedlist>
</para><para>The following index types:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::flat_map_index">boost::interprocess::flat_map_index</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::iset_index">boost::interprocess::iset_index</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::iunordered_set_index">boost::interprocess::iunordered_set_index</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::map_index">boost::interprocess::map_index</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::null_index">boost::interprocess::null_index</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::unordered_map_index">boost::interprocess::unordered_map_index</classname>;</para>
</listitem></itemizedlist>
</para><para>The following managed memory types:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::segment_manager">boost::interprocess::segment_manager</classname>;</para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_managed_external_buffer">boost::interprocess::basic_managed_external_buffer</classname></para>
</listitem><listitem><para>boost::interprocess::managed_external_buffer</para>
</listitem><listitem><para>boost::interprocess::wmanaged_external_buffer</para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_managed_shared_memory">boost::interprocess::basic_managed_shared_memory</classname></para>
</listitem><listitem><para>boost::interprocess::managed_shared_memory</para>
</listitem><listitem><para>boost::interprocess::wmanaged_shared_memory</para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_managed_windows_shared_memory">boost::interprocess::basic_managed_windows_shared_memory</classname></para>
</listitem><listitem><para>boost::interprocess::managed_windows_shared_memory</para>
</listitem><listitem><para>boost::interprocess::wmanaged_windows_shared_memory</para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_managed_xsi_shared_memory">boost::interprocess::basic_managed_xsi_shared_memory</classname></para>
</listitem><listitem><para>boost::interprocess::managed_xsi_shared_memory</para>
</listitem><listitem><para>boost::interprocess::wmanaged_xsi_shared_memory</para>
</listitem><listitem><para>boost::interprocess::fixed_managed_shared_memory</para>
</listitem><listitem><para>boost::interprocess::wfixed_managed_shared_memory</para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_managed_heap_memory">boost::interprocess::basic_managed_heap_memory</classname></para>
</listitem><listitem><para>boost::interprocess::managed_heap_memory</para>
</listitem><listitem><para>boost::interprocess::wmanaged_heap_memory</para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_managed_mapped_file">boost::interprocess::basic_managed_mapped_file</classname></para>
</listitem><listitem><para>boost::interprocess::managed_mapped_file</para>
</listitem><listitem><para>boost::interprocess::wmanaged_mapped_file</para>
</listitem></itemizedlist>
</para><para>The following exception types:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::interprocess_exception">boost::interprocess::interprocess_exception</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::lock_exception">boost::interprocess::lock_exception</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname></para>
</listitem></itemizedlist>
</para><para>The following stream types:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::basic_bufferbuf">boost::interprocess::basic_bufferbuf</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_ibufferstream">boost::interprocess::basic_ibufferstream</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_obufferstream">boost::interprocess::basic_obufferstream</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_bufferstream">boost::interprocess::basic_bufferstream</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_vectorbuf">boost::interprocess::basic_vectorbuf</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_ivectorstream">boost::interprocess::basic_ivectorstream</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_ovectorstream">boost::interprocess::basic_ovectorstream</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::basic_vectorstream">boost::interprocess::basic_vectorstream</classname></para>
</listitem></itemizedlist>
</para><para>The following smart pointer types:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::scoped_ptr">boost::interprocess::scoped_ptr</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::intrusive_ptr">boost::interprocess::intrusive_ptr</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::shared_ptr">boost::interprocess::shared_ptr</classname></para>
</listitem><listitem><para><classname alt="boost::interprocess::weak_ptr">boost::interprocess::weak_ptr</classname></para>
</listitem></itemizedlist>
</para><para>The following interprocess communication types:<itemizedlist>
<listitem><para><classname alt="boost::interprocess::message_queue_t">boost::interprocess::message_queue_t</classname>;</para>
</listitem><listitem><para>boost::interprocess::message_queue; </para>
</listitem></itemizedlist>
</para></header>
<header name="boost/interprocess/ipc/message_queue.hpp">
<para>Describes an inter-process message queue. This class allows sending messages between processes and allows blocking, non-blocking and timed sending and receiving. </para><namespace name="boost">
<namespace name="interprocess">
<class name="message_queue_t"><template>
      <template-type-parameter name="VoidPointer"/>
    </template><description><para>A class that allows sending messages between processes. </para></description><typedef name="void_pointer"><type>VoidPointer</type></typedef>
<typedef name="char_ptr"><type>boost::intrusive::pointer_traits&lt; void_pointer &gt;::template rebind_pointer&lt; char &gt;::type</type></typedef>
<typedef name="difference_type"><type>boost::intrusive::pointer_traits&lt; char_ptr &gt;::difference_type</type></typedef>
<typedef name="size_type"><type>boost::container::dtl::make_unsigned&lt; difference_type &gt;::type</type></typedef>
<method-group name="public member functions">
<method name="send"><type>void</type><parameter name="buffer"><paramtype>const void *</paramtype></parameter><parameter name="buffer_size"><paramtype>size_type</paramtype></parameter><parameter name="priority"><paramtype>unsigned int</paramtype></parameter><description><para>Sends a message stored in buffer "buffer" with size "buffer_size" in the message queue with priority "priority". If the message queue is full the sender is blocked. Throws interprocess_error on error. </para></description></method>
<method name="try_send"><type>bool</type><parameter name="buffer"><paramtype>const void *</paramtype></parameter><parameter name="buffer_size"><paramtype>size_type</paramtype></parameter><parameter name="priority"><paramtype>unsigned int</paramtype></parameter><description><para>Sends a message stored in buffer "buffer" with size "buffer_size" through the message queue with priority "priority". If the message queue is full the sender is not blocked and returns false, otherwise returns true. Throws interprocess_error on error. </para></description></method>
<method name="timed_send"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="buffer"><paramtype>const void *</paramtype></parameter><parameter name="buffer_size"><paramtype>size_type</paramtype></parameter><parameter name="priority"><paramtype>unsigned int</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Sends a message stored in buffer "buffer" with size "buffer_size" in the message queue with priority "priority". If the message queue is full the sender retries until time "abs_time" is reached. Returns true if the message has been successfully sent. Returns false if timeout is reached. Throws interprocess_error on error. </para></description></method>
<method name="receive"><type>void</type><parameter name="buffer"><paramtype>void *</paramtype></parameter><parameter name="buffer_size"><paramtype>size_type</paramtype></parameter><parameter name="recvd_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="priority"><paramtype>unsigned int &amp;</paramtype></parameter><description><para>Receives a message from the message queue. The message is stored in buffer "buffer", which has size "buffer_size". The received message has size "recvd_size" and priority "priority". If the message queue is empty the receiver is blocked. Throws interprocess_error on error. </para></description></method>
<method name="try_receive"><type>bool</type><parameter name="buffer"><paramtype>void *</paramtype></parameter><parameter name="buffer_size"><paramtype>size_type</paramtype></parameter><parameter name="recvd_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="priority"><paramtype>unsigned int &amp;</paramtype></parameter><description><para>Receives a message from the message queue. The message is stored in buffer "buffer", which has size "buffer_size". The received message has size "recvd_size" and priority "priority". If the message queue is empty the receiver is not blocked and returns false, otherwise returns true. Throws interprocess_error on error. </para></description></method>
<method name="timed_receive"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="buffer"><paramtype>void *</paramtype></parameter><parameter name="buffer_size"><paramtype>size_type</paramtype></parameter><parameter name="recvd_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="priority"><paramtype>unsigned int &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Receives a message from the message queue. The message is stored in buffer "buffer", which has size "buffer_size". The received message has size "recvd_size" and priority "priority". If the message queue is empty the receiver retries until time "abs_time" is reached. Returns true if the message has been successfully sent. Returns false if timeout is reached. Throws interprocess_error on error. </para></description></method>
<method name="get_max_msg" cv="const"><type>size_type</type><description><para>Returns the maximum number of messages allowed by the queue. The message queue must be opened or created previously. Otherwise, returns 0. Never throws </para></description></method>
<method name="get_max_msg_size" cv="const"><type>size_type</type><description><para>Returns the maximum size of message allowed by the queue. The message queue must be opened or created previously. Otherwise, returns 0. Never throws </para></description></method>
<method name="get_num_msg" cv="const"><type>size_type</type><description><para>Returns the number of messages currently stored. Never throws </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="max_num_msg"><paramtype>size_type</paramtype></parameter><parameter name="max_msg_size"><paramtype>size_type</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a process shared message queue with name "name". For this message queue, the maximum number of messages will be "max_num_msg" and the maximum message size will be "max_msg_size". Throws on error and if the queue was previously created. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="max_num_msg"><paramtype>size_type</paramtype></parameter><parameter name="max_msg_size"><paramtype>size_type</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a process shared message queue with name "name". If the queue is created, the maximum number of messages will be "max_num_msg" and the maximum message size will be "max_msg_size". If queue was previously created the queue will be opened and "max_num_msg" and "max_msg_size" parameters are ignored. Throws on error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a previously created process shared message queue with name "name". If the queue was not previously created or there are no free resources, throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="max_num_msg"><paramtype>size_type</paramtype></parameter><parameter name="max_msg_size"><paramtype>size_type</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a process shared message queue with name "name". For this message queue, the maximum number of messages will be "max_num_msg" and the maximum message size will be "max_msg_size". Throws on error and if the queue was previously created.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="max_num_msg"><paramtype>size_type</paramtype></parameter><parameter name="max_msg_size"><paramtype>size_type</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a process shared message queue with name "name". If the queue is created, the maximum number of messages will be "max_num_msg" and the maximum message size will be "max_msg_size". If queue was previously created the queue will be opened and "max_num_msg" and "max_msg_size" parameters are ignored. Throws on error.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a previously created process shared message queue with name "name". If the queue was not previously created or there are no free resources, throws an error.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. All opened message queues are still valid after destruction. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the message queue from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Removes the message queue from the system. Returns false on error. Never throws </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Removes the message queue from the system. Returns false on error. Never throws</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class><enum name="mqblock_types"><enumvalue name="blocking"/><enumvalue name="timed"/><enumvalue name="non_blocking"/></enum>
<typedef name="message_queue"><description><para>Typedef for a default message queue to be used between processes </para></description><type><classname>message_queue_t</classname>&lt; <classname>offset_ptr</classname>&lt; void &gt; &gt;</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/managed_external_buffer.hpp">
<para>Describes a named user memory allocation user class. </para><namespace name="boost">
<namespace name="interprocess">
<class name="basic_managed_external_buffer"><template>
      <template-type-parameter name="CharType"/>
      <template-type-parameter name="AllocationAlgorithm"/>
      <template-nontype-parameter name="IndexType"><type>template&lt; class IndexConfig &gt; class</type></template-nontype-parameter>
    </template><description><para>A basic user memory named object creation class. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; </para></description><typedef name="size_type"><type>base_t::size_type</type></typedef>
<method-group name="public member functions">
<method name="grow"><type>void</type><parameter name="extra_bytes"><paramtype>size_type</paramtype></parameter></method>
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>basic_managed_external_buffer</classname> &amp;</paramtype></parameter><description><para>Swaps the ownership of the managed heap memories managed by *this and other. Never throws. </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Default constructor. Does nothing. Useful in combination with move semantics </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="addr"><paramtype>void *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><description><para>Creates and places the segment manager. This can throw The external memory supplied by the user shall be aligned to the maximum value between <computeroutput>alignof(std::max_align_t)</computeroutput> and the strictest alignment of any over-aligned type to be built inside that memory. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="addr"><paramtype>void *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><description><para>Creates and places the segment manager. This can throw The external memory supplied by the user shall be aligned to the maximum value between <computeroutput>alignof(std::max_align_t)</computeroutput> and the strictest alignment of any over-aligned type to be built inside that memory. </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>basic_managed_external_buffer</classname> &amp;&amp;</paramtype></parameter><purpose>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </purpose></constructor>
<copy-assignment cv="noexcept"><type><classname>basic_managed_external_buffer</classname> &amp;</type><parameter name="moved"><paramtype><classname>basic_managed_external_buffer</classname> &amp;&amp;</paramtype></parameter><purpose>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </purpose></copy-assignment>
</class><typedef name="managed_external_buffer"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_external_buffer">basic_managed_external_buffer</classname> of narrow characters </para></description><type><classname>basic_managed_external_buffer</classname>&lt; char,<classname>rbtree_best_fit</classname>&lt; <classname>null_mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>
<typedef name="wmanaged_external_buffer"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_external_buffer">basic_managed_external_buffer</classname> of wide characters </para></description><type><classname>basic_managed_external_buffer</classname>&lt; wchar_t,<classname>rbtree_best_fit</classname>&lt; <classname>null_mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/managed_heap_memory.hpp">
<para>Describes a named heap memory allocation user class. </para><namespace name="boost">
<namespace name="interprocess">
<class name="basic_managed_heap_memory"><template>
      <template-type-parameter name="CharType"/>
      <template-type-parameter name="AllocationAlgorithm"/>
      <template-nontype-parameter name="IndexType"><type>template&lt; class IndexConfig &gt; class</type></template-nontype-parameter>
    </template><description><para>A basic heap memory named object creation class. Initializes the heap memory segment. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; </para></description><typedef name="size_type"><type>base_t::size_type</type></typedef>
<method-group name="public member functions">
<method name="grow"><type>bool</type><parameter name="extra_bytes"><paramtype>size_type</paramtype></parameter><description><para>Tries to resize internal heap memory so that we have room for more objects. WARNING: If memory is reallocated, all the objects will be binary-copied to the new buffer. To be able to use this function, all pointers constructed in this buffer must be offset pointers. Otherwise, the result is undefined. Returns true if the growth has been successful, so you will have some extra bytes to allocate new objects. If returns false, the heap allocation has failed. </para></description></method>
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>basic_managed_heap_memory</classname> &amp;</paramtype></parameter><description><para>Swaps the ownership of the managed heap memories managed by *this and other. Never throws. </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Default constructor. Does nothing. Useful in combination with move semantics </para></description></constructor>
<destructor><description><para>Destructor. Liberates the heap memory holding the managed data. Never throws. </para></description></destructor>
<constructor><parameter name="size"><paramtype>size_type</paramtype></parameter><description><para>Creates heap memory and initializes the segment manager. This can throw. </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>basic_managed_heap_memory</classname> &amp;&amp;</paramtype></parameter><purpose>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </purpose></constructor>
<copy-assignment cv="noexcept"><type><classname>basic_managed_heap_memory</classname> &amp;</type><parameter name="moved"><paramtype><classname>basic_managed_heap_memory</classname> &amp;&amp;</paramtype></parameter><purpose>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </purpose></copy-assignment>
</class><typedef name="managed_heap_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_heap_memory">basic_managed_heap_memory</classname> of narrow characters </para></description><type><classname>basic_managed_heap_memory</classname>&lt; char,<classname>rbtree_best_fit</classname>&lt; <classname>null_mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>
<typedef name="wmanaged_heap_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_heap_memory">basic_managed_heap_memory</classname> of wide characters </para></description><type><classname>basic_managed_heap_memory</classname>&lt; wchar_t,<classname>rbtree_best_fit</classname>&lt; <classname>null_mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/managed_mapped_file.hpp">
<namespace name="boost">
<namespace name="interprocess">
<class name="basic_managed_mapped_file"><template>
      <template-type-parameter name="CharType"/>
      <template-type-parameter name="AllocationAlgorithm"/>
      <template-nontype-parameter name="IndexType"><type>template&lt; class IndexConfig &gt; class</type></template-nontype-parameter>
    </template><description><para>A basic mapped file named object creation class. Initializes the mapped file. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; </para></description><typedef name="size_type"><description><para>Unsigned integral type enough to represent the size of a <classname alt="boost::interprocess::basic_managed_mapped_file">basic_managed_mapped_file</classname>. </para></description><type>implementation_defined</type></typedef>
<method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>basic_managed_mapped_file</classname> &amp;</paramtype></parameter><description><para>Swaps the ownership of the managed mapped memories managed by *this and other. Never throws. </para></description></method>
<method name="flush"><type>bool</type><description><para>Flushes cached data to file. Never throws </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Creates mapped file and creates and places the segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates mapped file and creates and places the segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates mapped file and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created mapped file and its segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_copy_on_write_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created mapped file and its segment manager in copy_on_write mode. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_read_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created mapped file and its segment manager in read-only mode. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates mapped file and creates and places the segment manager. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates mapped file and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created mapped file and its segment manager. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_copy_on_write_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created mapped file and its segment manager in copy_on_write mode. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_read_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created mapped file and its segment manager in read-only mode. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>basic_managed_mapped_file</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s managed memory to *this. Does not throw </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>basic_managed_mapped_file</classname> &amp;</type><parameter name="moved"><paramtype><classname>basic_managed_mapped_file</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s managed memory to *this. Does not throw </para></description></copy-assignment>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="grow" specifiers="static"><type>bool</type><parameter name="filename"><paramtype>const char *</paramtype></parameter><parameter name="extra_bytes"><paramtype>size_type</paramtype></parameter><description><para>Tries to resize mapped file so that we have room for more objects.</para><para>This function is not synchronized so no other thread or process should be reading or writing the file </para></description></method>
<method name="shrink_to_fit" specifiers="static"><type>bool</type><parameter name="filename"><paramtype>const char *</paramtype></parameter><description><para>Tries to resize mapped file to minimized the size of the file.</para><para>This function is not synchronized so no other thread or process should be reading or writing the file </para></description></method>
<method name="grow" specifiers="static"><type>bool</type><parameter name="filename"><paramtype>const wchar_t *</paramtype></parameter><parameter name="extra_bytes"><paramtype>size_type</paramtype></parameter><description><para>Tries to resize mapped file so that we have room for more objects.</para><para>This function is not synchronized so no other thread or process should be reading or writing the file</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
<method name="shrink_to_fit" specifiers="static"><type>bool</type><parameter name="filename"><paramtype>const wchar_t *</paramtype></parameter><description><para>Tries to resize mapped file to minimized the size of the file.</para><para>This function is not synchronized so no other thread or process should be reading or writing the file</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class><typedef name="managed_mapped_file"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_mapped_file">basic_managed_mapped_file</classname> of narrow characters </para></description><type><classname>basic_managed_mapped_file</classname>&lt; char,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>
<typedef name="wmanaged_mapped_file"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_mapped_file">basic_managed_mapped_file</classname> of wide characters </para></description><type><classname>basic_managed_mapped_file</classname>&lt; wchar_t,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/managed_shared_memory.hpp">
<namespace name="boost">
<namespace name="interprocess">
<class name="basic_managed_shared_memory"><template>
      <template-type-parameter name="CharType"/>
      <template-type-parameter name="AllocationAlgorithm"/>
      <template-nontype-parameter name="IndexType"><type>template&lt; class IndexConfig &gt; class</type></template-nontype-parameter>
    </template><description><para>A basic shared memory named object creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; </para></description><method-group name="public member functions">
<method name="swap"><type>void</type><parameter name="other"><paramtype><classname>basic_managed_shared_memory</classname> &amp;</paramtype></parameter><description><para>Swaps the ownership of the managed shared memories managed by *this and other. Never throws. </para></description></method>
</method-group>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<constructor><description><para>Default constructor. Does nothing. Useful in combination with move semantics </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_copy_on_write_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. in copy_on_write mode. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_read_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. in read-only mode. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_copy_on_write_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. in copy_on_write mode. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_read_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. in read-only mode. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. This can throw.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name="moved"><paramtype><classname>basic_managed_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s managed memory to *this. Does not throw </para></description></constructor>
<copy-assignment><type><classname>basic_managed_shared_memory</classname> &amp;</type><parameter name="moved"><paramtype><classname>basic_managed_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s managed memory to *this. Does not throw </para></description></copy-assignment>
<method-group name="public static functions">
<method name="grow" specifiers="static"><type>bool</type><parameter name="shmname"><paramtype>const char *</paramtype></parameter><parameter name="extra_bytes"><paramtype>size_type</paramtype></parameter><description><para>Tries to resize the managed shared memory object so that we have room for more objects.</para><para>This function is not synchronized so no other thread or process should be reading or writing the file </para></description></method>
<method name="shrink_to_fit" specifiers="static"><type>bool</type><parameter name="shmname"><paramtype>const char *</paramtype></parameter><description><para>Tries to resize the managed shared memory to minimized the size of the file.</para><para>This function is not synchronized so no other thread or process should be reading or writing the file </para></description></method>
<method name="grow" specifiers="static"><type>bool</type><parameter name="shmname"><paramtype>const wchar_t *</paramtype></parameter><parameter name="extra_bytes"><paramtype>size_type</paramtype></parameter><description><para>Tries to resize the managed shared memory object so that we have room for more objects.</para><para>This function is not synchronized so no other thread or process should be reading or writing the file</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
<method name="shrink_to_fit" specifiers="static"><type>bool</type><parameter name="shmname"><paramtype>const wchar_t *</paramtype></parameter><description><para>Tries to resize the managed shared memory to minimized the size of the file.</para><para>This function is not synchronized so no other thread or process should be reading or writing the file</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class><typedef name="managed_shared_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_shared_memory">basic_managed_shared_memory</classname> of narrow characters </para></description><type><classname>basic_managed_shared_memory</classname>&lt; char,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>
<typedef name="wmanaged_shared_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_shared_memory">basic_managed_shared_memory</classname> of wide characters </para></description><type><classname>basic_managed_shared_memory</classname>&lt; wchar_t,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>
<typedef name="fixed_managed_shared_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_shared_memory">basic_managed_shared_memory</classname> of narrow characters to be placed in a fixed address </para></description><type><classname>basic_managed_shared_memory</classname>&lt; char,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname>, void * &gt;,<classname>iset_index</classname> &gt;</type></typedef>
<typedef name="wfixed_managed_shared_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_shared_memory">basic_managed_shared_memory</classname> of narrow characters to be placed in a fixed address </para></description><type><classname>basic_managed_shared_memory</classname>&lt; wchar_t,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname>, void * &gt;,<classname>iset_index</classname> &gt;</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/managed_windows_shared_memory.hpp">
<namespace name="boost">
<namespace name="interprocess">
<class name="basic_managed_windows_shared_memory"><template>
      <template-type-parameter name="CharType"/>
      <template-type-parameter name="AllocationAlgorithm"/>
      <template-nontype-parameter name="IndexType"><type>template&lt; class IndexConfig &gt; class</type></template-nontype-parameter>
    </template><description><para>A basic managed windows shared memory creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; Unlike <classname alt="boost::interprocess::basic_managed_shared_memory">basic_managed_shared_memory</classname>, it has no kernel persistence and the shared memory is destroyed when all processes destroy all their <classname alt="boost::interprocess::windows_shared_memory">windows_shared_memory</classname> objects and mapped regions for the same shared memory or the processes end/crash.</para><para>Warning: <classname alt="boost::interprocess::basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</classname> and <classname alt="boost::interprocess::basic_managed_shared_memory">basic_managed_shared_memory</classname> can't communicate between them. </para></description><typedef name="size_type"><type>base_t::size_type</type></typedef>
<method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>basic_managed_windows_shared_memory</classname> &amp;</paramtype></parameter><description><para>Swaps the ownership of the managed mapped memories managed by *this and other. Never throws. </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Default constructor. Does nothing. Useful in combination with move semantics </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_copy_on_write_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager in copy_on_write mode. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_read_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager in read-only mode. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_copy_on_write_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager in copy_on_write mode. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_read_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager in read-only mode. This can throw. </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>basic_managed_windows_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s managed memory to *this. Does not throw </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>basic_managed_windows_shared_memory</classname> &amp;</type><parameter name="moved"><paramtype><classname>basic_managed_windows_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s managed memory to *this. Does not throw </para></description></copy-assignment>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. All mapped regions are still valid after destruction. When all mapped regions and <classname alt="boost::interprocess::basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</classname> objects referring the shared memory are destroyed, the operating system will destroy the shared memory. </para></description></destructor>
</class><typedef name="managed_windows_shared_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</classname> of narrow characters </para></description><type><classname>basic_managed_windows_shared_memory</classname>&lt; char,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>
<typedef name="wmanaged_windows_shared_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</classname> of wide characters </para></description><type><classname>basic_managed_windows_shared_memory</classname>&lt; wchar_t,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/managed_xsi_shared_memory.hpp">
<namespace name="boost">
<namespace name="interprocess">
<class name="basic_managed_xsi_shared_memory"><template>
      <template-type-parameter name="CharType"/>
      <template-type-parameter name="AllocationAlgorithm"/>
      <template-nontype-parameter name="IndexType"><type>template&lt; class IndexConfig &gt; class</type></template-nontype-parameter>
    </template><description><para>A basic X/Open System Interface (XSI) shared memory named object creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl&lt;CharType, AllocationAlgorithm, IndexType&gt; </para></description><typedef name="size_type"><type>base_t::size_type</type></typedef>
<method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>basic_managed_xsi_shared_memory</classname> &amp;</paramtype></parameter><description><para>Swaps the ownership of the managed shared memories managed by *this and other. Never throws. </para></description></method>
<method name="get_shmid" cv="const noexcept"><type>int</type></method>
</method-group>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<constructor cv="noexcept"><description><para>Default constructor. Does nothing. Useful in combination with move semantics </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="key"><paramtype>const <classname>xsi_key</classname> &amp;</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="key"><paramtype>const <classname>xsi_key</classname> &amp;</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_read_only_t</classname></paramtype></parameter><parameter name="key"><paramtype>const <classname>xsi_key</classname> &amp;</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. in read-only mode. This can throw. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="key"><paramtype>const <classname>xsi_key</classname> &amp;</paramtype></parameter><parameter name="addr"><paramtype>const void *</paramtype><default>0</default></parameter><description><para>Connects to a created shared memory and its segment manager. This can throw. </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>basic_managed_xsi_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s managed memory to *this. Does not throw </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>basic_managed_xsi_shared_memory</classname> &amp;</type><parameter name="moved"><paramtype><classname>basic_managed_xsi_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s managed memory to *this. Does not throw </para></description></copy-assignment>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="shmid"><paramtype>int</paramtype></parameter><description><para>Erases a XSI shared memory object identified by shmid from the system. Returns false on error. Never throws </para></description></method>
</method-group>
</class><typedef name="managed_xsi_shared_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</classname> of narrow characters </para></description><type><classname>basic_managed_xsi_shared_memory</classname>&lt; char,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>
<typedef name="wmanaged_xsi_shared_memory"><description><para>Typedef for a default <classname alt="boost::interprocess::basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</classname> of wide characters </para></description><type><classname>basic_managed_xsi_shared_memory</classname>&lt; wchar_t,<classname>rbtree_best_fit</classname>&lt; <classname>mutex_family</classname> &gt;,<classname>iset_index</classname> &gt;</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/mapped_region.hpp">
<para>Describes mapped region class </para><namespace name="boost">
<namespace name="interprocess">
<class name="mapped_region"><description><para>The <classname alt="boost::interprocess::mapped_region">mapped_region</classname> class represents a portion or region created from a memory_mappable object.</para><para>The OS can map a region bigger than the requested one, as region must be multiple of the page size, but <classname alt="boost::interprocess::mapped_region">mapped_region</classname> will always refer to the region specified by the user. </para></description><enum name="advice_types"><enumvalue name="advice_normal"><description><para>Specifies that the application has no advice to give on its behavior with respect to the region. It is the default characteristic if no advice is given for a range of memory. </para></description></enumvalue><enumvalue name="advice_sequential"><description><para>Specifies that the application expects to access the region sequentially from lower addresses to higher addresses. The implementation can lower the priority of preceding pages within the region once a page have been accessed. </para></description></enumvalue><enumvalue name="advice_random"><description><para>Specifies that the application expects to access the region in a random order, and prefetching is likely not advantageous. </para></description></enumvalue><enumvalue name="advice_willneed"><description><para>Specifies that the application expects to access the region in the near future. The implementation can prefetch pages of the region. </para></description></enumvalue><enumvalue name="advice_dontneed"><description><para>Specifies that the application expects that it will not access the region in the near future. The implementation can unload pages within the range to save system resources. </para></description></enumvalue><description><para>This enum specifies region usage behaviors that an application can specify to the mapped region implementation. </para></description></enum>
<method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>mapped_region</classname> &amp;</paramtype></parameter><description><para>Swaps the <classname alt="boost::interprocess::mapped_region">mapped_region</classname> with another mapped region </para></description></method>
<method name="get_size" cv="const noexcept"><type>std::size_t</type><purpose>Returns the size of the mapping. Never throws. </purpose></method>
<method name="get_address" cv="const noexcept"><type>void *</type><description><para>Returns the base address of the mapping. Never throws. </para></description></method>
<method name="get_mode" cv="const noexcept"><type>mode_t</type><description><para>Returns the mode of the mapping used to construct the mapped region. Never throws. </para></description></method>
<method name="flush"><type>bool</type><parameter name="mapping_offset"><paramtype>std::size_t</paramtype><default>0</default></parameter><parameter name="numbytes"><paramtype>std::size_t</paramtype><default>0</default></parameter><parameter name="async"><paramtype>bool</paramtype><default>true</default></parameter><description><para>Flushes to the disk a byte range within the mapped memory. If 'async' is true, the function will return before flushing operation is completed If 'async' is false, function will return once data has been written into the underlying device (i.e., in mapped files OS cached information is written to disk). Never throws. Returns false if operation could not be performed. </para></description></method>
<method name="shrink_by"><type>bool</type><parameter name="bytes"><paramtype>std::size_t</paramtype></parameter><parameter name="from_back"><paramtype>bool</paramtype><default>true</default></parameter><description><para>Shrinks current mapped region. If after shrinking there is no longer need for a previously mapped memory page, accessing that page can trigger a segmentation fault. Depending on the OS, this operation might fail (XSI shared memory), it can decommit storage and free a portion of the virtual address space (e.g.POSIX) or this function can release some physical memory without freeing any virtual address space(Windows). Returns true on success. Never throws. </para></description></method>
<method name="advise"><type>bool</type><parameter name="advise"><paramtype>advice_types</paramtype></parameter><description><para>Advises the implementation on the expected behavior of the application with respect to the data in the region. The implementation may use this information to optimize handling of the region data. This function has no effect on the semantics of access to memory in the region, although it may affect the performance of access. If the advise type is not known to the implementation, the function returns false. True otherwise. </para></description></method>
</method-group>
<constructor><template>
          <template-type-parameter name="MemoryMappable"/>
        </template><parameter name="mapping"><paramtype>const MemoryMappable &amp;</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="offset"><paramtype>offset_t</paramtype><default>0</default></parameter><parameter name="size"><paramtype>std::size_t</paramtype><default>0</default></parameter><parameter name="address"><paramtype>const void *</paramtype><default>0</default></parameter><parameter name="map_options"><paramtype>map_options_t</paramtype><default>default_map_options</default></parameter><description><para>Creates a mapping region of the mapped memory "mapping", starting in offset "offset", and the mapping's size will be "size". The mapping can be opened for read only, read-write or copy-on-write.</para><para>If an address is specified, both the offset and the address must be multiples of the page size.</para><para>The map is created using "default_map_options". This flag is OS dependant and it should not be changed unless the user needs to specify special options.</para><para>In Windows systems "map_options" is a DWORD value passed as "dwDesiredAccess" to "MapViewOfFileEx". If "default_map_options" is passed it's initialized to zero. "map_options" is XORed with FILE_MAP_[COPY|READ|WRITE].</para><para>In UNIX systems and POSIX mappings "map_options" is an int value passed as "flags" to "mmap". If "default_map_options" is specified it's initialized to MAP_NOSYNC if that option exists and to zero otherwise. "map_options" XORed with MAP_PRIVATE or MAP_SHARED.</para><para>In UNIX systems and XSI mappings "map_options" is an int value passed as "shmflg" to "shmat". If "default_map_options" is specified it's initialized to zero. "map_options" is XORed with SHM_RDONLY if needed.</para><para>The OS could allocate more pages than size/page_size(), but get_address() will always return the address passed in this function (if not null) and get_size() will return the specified size. </para></description></constructor>
<constructor cv="noexcept"><description><para>Default constructor. Address will be 0 (nullptr). Size will be 0. Does not throw </para></description></constructor>
<constructor cv="noexcept"><parameter name="other"><paramtype><classname>mapped_region</classname> &amp;&amp;</paramtype></parameter><description><para>Move constructor. *this will be constructed taking ownership of "other"'s region and "other" will be left in default constructor state. </para></description></constructor>
<destructor><description><para>Destroys the mapped region. Does not throw </para></description></destructor>
<copy-assignment cv="noexcept"><type><classname>mapped_region</classname> &amp;</type><parameter name="other"><paramtype><classname>mapped_region</classname> &amp;&amp;</paramtype></parameter><description><para>Move assignment. If *this owns a memory mapped region, it will be destroyed and it will take ownership of "other"'s memory mapped region. </para></description></copy-assignment>
<method-group name="public static functions">
<method name="get_page_size" cv="noexcept" specifiers="static"><type>std::size_t</type><description><para>Returns the size of the page. This size is the minimum memory that will be used by the system when mapping a memory mappable source and will restrict the address and the offset to map. </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/mem_algo/rbtree_best_fit.hpp">
<para>Describes a best-fit algorithm based in an intrusive red-black tree used to allocate objects in shared memory. This class is intended as a base class for single segment and multi-segment implementations. </para><namespace name="boost">
<namespace name="interprocess">
<class name="rbtree_best_fit"><template>
      <template-type-parameter name="MutexFamily"/>
      <template-type-parameter name="VoidPointer"/>
      <template-nontype-parameter name="MemAlignment"><type>std::size_t</type></template-nontype-parameter>
    </template><description><para>This class implements an algorithm that stores the free nodes in a red-black tree to have logarithmic search/insert times. </para></description><typedef name="mutex_family"><purpose>Shared mutex family used for the rest of the Interprocess framework. </purpose><type>MutexFamily</type></typedef>
<typedef name="void_pointer"><purpose>Pointer type to be used with the rest of the Interprocess framework. </purpose><type>VoidPointer</type></typedef>
<typedef name="multiallocation_chain"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="difference_type"><type>boost::intrusive::pointer_traits&lt; char_ptr &gt;::difference_type</type></typedef>
<typedef name="size_type"><type>boost::container::dtl::make_unsigned&lt; difference_type &gt;::type</type></typedef>
<data-member name="PayloadPerAllocation" specifiers="static"><type>const size_type</type></data-member>
<method-group name="public member functions">
<method name="allocate"><type>void *</type><parameter name="nbytes"><paramtype>size_type</paramtype></parameter><purpose>Allocates bytes, returns 0 if there is not more memory. </purpose></method>
<method name="deallocate"><type>void</type><parameter name="addr"><paramtype>void *</paramtype></parameter><purpose>Deallocates previously allocated bytes. </purpose></method>
<method name="get_size" cv="const"><type>size_type</type><purpose>Returns the size of the memory segment. </purpose></method>
<method name="get_free_memory" cv="const"><type>size_type</type><purpose>Returns the number of free bytes of the segment. </purpose></method>
<method name="zero_free_memory"><type>void</type><description><para>Initializes to zero all the memory that's not in use. This function is normally used for security reasons. </para></description></method>
<method name="grow"><type>void</type><parameter name="extra_size"><paramtype>size_type</paramtype></parameter><description><para>Increases managed memory in extra_size bytes more </para></description></method>
<method name="shrink_to_fit"><type>void</type><purpose>Decreases managed memory as much as possible. </purpose></method>
<method name="all_memory_deallocated"><type>bool</type><purpose>Returns true if all allocated memory has been deallocated. </purpose></method>
<method name="check_sanity"><type>bool</type><description><para>Makes an internal sanity check and returns true if success </para></description></method>
<method name="allocation_command"><type>T *</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_size"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse"><paramtype>T *&amp;</paramtype></parameter></method>
<method name="raw_allocation_command"><type>void *</type><parameter name="command"><paramtype>boost::interprocess::allocation_type</paramtype></parameter><parameter name="limit_object"><paramtype>size_type</paramtype></parameter><parameter name="prefer_in_recvd_out_size"><paramtype>size_type &amp;</paramtype></parameter><parameter name="reuse_ptr"><paramtype>void *&amp;</paramtype></parameter><parameter name="sizeof_object"><paramtype>size_type</paramtype><default>1</default></parameter></method>
<method name="size" cv="const"><type>size_type</type><parameter name="ptr"><paramtype>const void *</paramtype></parameter><purpose>Returns the size of the buffer previously allocated pointed by ptr. </purpose></method>
<method name="allocate_aligned"><type>void *</type><parameter name="nbytes"><paramtype>size_type</paramtype></parameter><parameter name="alignment"><paramtype>size_type</paramtype></parameter><description><para>Allocates aligned bytes, returns 0 if there is not more memory. Alignment must be power of 2 </para></description></method>
</method-group>
<constructor><parameter name="size"><paramtype>size_type</paramtype></parameter><parameter name="extra_hdr_bytes"><paramtype>size_type</paramtype></parameter><description><para>Constructor. "size" is the total size of the managed memory segment, "extra_hdr_bytes" indicates the extra bytes beginning in the sizeof(rbtree_best_fit) offset that the allocator should not use at all. </para></description></constructor>
<destructor><purpose>Destructor. </purpose></destructor>
<method-group name="public static functions">
<method name="get_min_size" specifiers="static"><type>size_type</type><parameter name="extra_hdr_bytes"><paramtype>size_type</paramtype></parameter><purpose>Obtains the minimum size needed by the algorithm. </purpose></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/mem_algo/simple_seq_fit.hpp">
<para>Describes sequential fit algorithm used to allocate objects in shared memory. </para><namespace name="boost">
<namespace name="interprocess">
<class name="simple_seq_fit"><template>
      <template-type-parameter name="MutexFamily"/>
      <template-type-parameter name="VoidPointer"/>
    </template><description><para>This class implements the simple sequential fit algorithm with a simply linked list of free buffers. </para></description><typedef name="size_type"><type>base_t::size_type</type></typedef>
<method-group name="public member functions">
</method-group>
<constructor><parameter name="segment_size"><paramtype>size_type</paramtype></parameter><parameter name="extra_hdr_bytes"><paramtype>size_type</paramtype></parameter><description><para>Constructor. "size" is the total size of the managed memory segment, "extra_hdr_bytes" indicates the extra bytes beginning in the sizeof(simple_seq_fit) offset that the allocator should not use at all. </para></description></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/offset_ptr.hpp">
<para>Describes a smart pointer that stores the offset between this pointer and target pointee, called offset_ptr. </para><namespace name="boost">
<namespace name="interprocess">
<class name="offset_ptr"><template>
      <template-type-parameter name="PointedType"><purpose><para>The type of the pointee. </para></purpose></template-type-parameter>
      <template-type-parameter name="DifferenceType"><purpose><para>A signed integer type that can represent the arithmetic operations on the pointer </para></purpose></template-type-parameter>
      <template-type-parameter name="OffsetType"><purpose><para>An unsigned integer type that can represent the distance between two pointers reinterpret_cast-ed as unsigned integers. This type should be at least of the same size of std::uintptr_t. In some systems it's possible to communicate between 32 and 64 bit processes using 64 bit offsets. </para></purpose></template-type-parameter>
      <template-nontype-parameter name="OffsetAlignment"><type>std::size_t</type><purpose><para>Alignment of the OffsetType stored inside. In some systems might be necessary to align it to 64 bits in order to communicate 32 and 64 bit processes using 64 bit offsets.</para></purpose></template-nontype-parameter>
    </template><description><para>A smart pointer that stores the offset between between the pointer and the the object it points. This allows offset allows special properties, since the pointer is independent from the address of the pointee, if the pointer and the pointee are still separated by the same offset. This feature converts <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> in a smart pointer that can be placed in shared memory and memory mapped files mapped in different addresses in every process.</para><para>
b&gt;Note: <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> uses implementation defined properties, present in most platforms, for performance reasons:<itemizedlist>
<listitem><para>Assumes that OffsetType representation of nullptr is (OffsetType)zero.</para>
</listitem><listitem><para>Assumes that incrementing a OffsetType obtained from a pointer is equivalent to incrementing the pointer and then converting it back to OffsetType. </para>
</listitem></itemizedlist>
</para></description><typedef name="element_type"><type>PointedType</type></typedef>
<typedef name="pointer"><type>PointedType *</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="value_type"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="difference_type"><type>DifferenceType</type></typedef>
<typedef name="iterator_category"><type>std::random_access_iterator_tag</type></typedef>
<typedef name="offset_type"><type>OffsetType</type></typedef>
<typedef name="rebind"><description><para>Compatibility with pointer_traits </para></description><type><classname>offset_ptr</classname>&lt; U, DifferenceType, OffsetType, OffsetAlignment &gt;</type></typedef>
<method-group name="public member functions">
<method name="get" cv="const noexcept"><type>pointer</type><description><para>Obtains raw pointer from offset. Never throws. </para></description></method>
<method name="get_offset" cv="const noexcept"><type>offset_type</type></method>
<method name="operator-&gt;" cv="const noexcept"><type>pointer</type><description><para>Pointer-like -&gt; operator. It can return 0 pointer. Never throws. </para></description></method>
<method name="operator *" cv="const noexcept"><type>reference</type><description><para>Dereferencing operator, if it is a null <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> behavior is undefined. Never throws. </para></description></method>
<method name="operator[]" cv="const noexcept"><type>reference</type><parameter name="idx"><paramtype>difference_type</paramtype></parameter><description><para>Indexing operator. Never throws. </para></description></method>
<method name="operator+=" cv="noexcept"><type><classname>offset_ptr</classname> &amp;</type><parameter name="offset"><paramtype>difference_type</paramtype></parameter><description><para><classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> += difference_type. Never throws. </para></description></method>
<method name="operator-=" cv="noexcept"><type><classname>offset_ptr</classname> &amp;</type><parameter name="offset"><paramtype>difference_type</paramtype></parameter><description><para><classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> -= difference_type. Never throws. </para></description></method>
<method name="operator++" cv="noexcept"><type><classname>offset_ptr</classname> &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><description><para>++<classname alt="boost::interprocess::offset_ptr">offset_ptr</classname>. Never throws. </para></description></method>
<method name="operator++" cv="noexcept"><type><classname>offset_ptr</classname></type><parameter name=""><paramtype>int</paramtype></parameter><description><para>offset_ptr++. Never throws. </para></description></method>
<method name="operator--" cv="noexcept"><type><classname>offset_ptr</classname> &amp;</type><parameter name=""><paramtype>void</paramtype></parameter><description><para>–<classname alt="boost::interprocess::offset_ptr">offset_ptr</classname>. Never throws. </para></description></method>
<method name="operator--" cv="noexcept"><type><classname>offset_ptr</classname></type><parameter name=""><paramtype>int</paramtype></parameter><description><para><classname alt="boost::interprocess::offset_ptr">offset_ptr</classname>–. Never throws. </para></description></method>
<method name="conversion-operator" cv="const noexcept" specifiers="explicit"><type>bool</type><description><para>safe bool conversion operator. Never throws. </para></description></method>
<method name="operator!" cv="const noexcept"><type>bool</type><description><para>Not operator. Not needed in theory, but improves portability. Never throws </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Default constructor (null pointer). Never throws. </para></description></constructor>
<constructor cv="noexcept"><parameter name="ptr"><paramtype>pointer</paramtype></parameter><description><para>Constructor from raw pointer (allows "0" pointer conversion). Never throws. </para></description></constructor>
<constructor cv="noexcept"><template>
          <template-type-parameter name="T"/>
        </template><parameter name="ptr"><paramtype>T *</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Constructor from other pointer. Never throws. </para></description></constructor>
<constructor cv="noexcept"><parameter name="ptr"><paramtype>const <classname>offset_ptr</classname> &amp;</paramtype></parameter><description><para>Constructor from other <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> Never throws. </para></description></constructor>
<constructor cv="noexcept"><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="ptr"><paramtype>const <classname>offset_ptr</classname>&lt; T2, DifferenceType, OffsetType, OffsetAlignment &gt; &amp;</paramtype></parameter><description><para>Constructor from other <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname>. Only takes part in overload resolution if T2* is convertible to PointedType*. Never throws. </para></description></constructor>
<constructor specifiers="explicit" cv="noexcept"><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="ptr"><paramtype>const <classname>offset_ptr</classname>&lt; T2, DifferenceType, OffsetType, OffsetAlignment &gt; &amp;</paramtype></parameter><description><para>Constructor from other <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname>. Only takes part in overload resolution if PointedType* is constructible from T2* other than via a conversion (e.g. cast to a derived class). Never throws. </para></description></constructor>
<constructor cv="noexcept"><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="P2"/>
          <template-type-parameter name="O2"/>
          <template-nontype-parameter name="A2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="r"><paramtype>const <classname>offset_ptr</classname>&lt; T2, P2, O2, A2 &gt; &amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype></parameter><description><para>Emulates static_cast operator. Never throws. </para></description></constructor>
<constructor cv="noexcept"><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="P2"/>
          <template-type-parameter name="O2"/>
          <template-nontype-parameter name="A2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="r"><paramtype>const <classname>offset_ptr</classname>&lt; T2, P2, O2, A2 &gt; &amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype></parameter><description><para>Emulates const_cast operator. Never throws. </para></description></constructor>
<constructor cv="noexcept"><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="P2"/>
          <template-type-parameter name="O2"/>
          <template-nontype-parameter name="A2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="r"><paramtype>const <classname>offset_ptr</classname>&lt; T2, P2, O2, A2 &gt; &amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype></parameter><description><para>Emulates dynamic_cast operator. Never throws. </para></description></constructor>
<constructor cv="noexcept"><template>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="P2"/>
          <template-type-parameter name="O2"/>
          <template-nontype-parameter name="A2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="r"><paramtype>const <classname>offset_ptr</classname>&lt; T2, P2, O2, A2 &gt; &amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype></parameter><description><para>Emulates reinterpret_cast operator. Never throws. </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>offset_ptr</classname> &amp;</type><parameter name="from"><paramtype>pointer</paramtype></parameter><description><para>Assignment from pointer (saves extra conversion). Never throws. </para></description></copy-assignment>
<copy-assignment cv="noexcept"><type><classname>offset_ptr</classname> &amp;</type><parameter name="ptr"><paramtype>const <classname>offset_ptr</classname> &amp;</paramtype></parameter><description><para>Assignment from other <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname>. Never throws. </para></description></copy-assignment>
<copy-assignment cv="noexcept"><type><classname>offset_ptr</classname> &amp;</type><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="ptr"><paramtype>const <classname>offset_ptr</classname>&lt; T2, DifferenceType, OffsetType, OffsetAlignment &gt; &amp;</paramtype></parameter><description><para>Assignment from related <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname>. If pointers of pointee types are assignable, offset_ptrs will be assignable. Never throws. </para></description></copy-assignment>
<method-group name="public static functions">
<method name="pointer_to" cv="noexcept" specifiers="static"><type><classname>offset_ptr</classname></type><parameter name="r"><paramtype>reference</paramtype></parameter><description><para>Compatibility with pointer_traits </para></description></method>
</method-group>
<method-group name="friend functions">
<method name="operator+" cv="noexcept"><type>friend <classname>offset_ptr</classname></type><parameter name="diff"><paramtype>difference_type</paramtype></parameter><parameter name="right"><paramtype><classname>offset_ptr</classname></paramtype></parameter><description><para>difference_type + <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> operation </para></description></method>
<method name="operator+" cv="noexcept"><type>friend <classname>offset_ptr</classname></type><parameter name="left"><paramtype><classname>offset_ptr</classname></paramtype></parameter><parameter name="diff"><paramtype>difference_type</paramtype></parameter><description><para><classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> + difference_type operation </para></description></method>
<method name="operator-" cv="noexcept"><type>friend <classname>offset_ptr</classname></type><parameter name="left"><paramtype><classname>offset_ptr</classname></paramtype></parameter><parameter name="diff"><paramtype>difference_type</paramtype></parameter><description><para><classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> - diff operation </para></description></method>
<method name="operator-" cv="noexcept"><type>friend <classname>offset_ptr</classname></type><parameter name="diff"><paramtype>difference_type</paramtype></parameter><parameter name="right"><paramtype><classname>offset_ptr</classname></paramtype></parameter><description><para><classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> - diff operation </para></description></method>
<method name="operator-" cv="noexcept"><type>friend difference_type</type><parameter name="pt"><paramtype>const <classname>offset_ptr</classname> &amp;</paramtype></parameter><parameter name="pt2"><paramtype>const <classname>offset_ptr</classname> &amp;</paramtype></parameter><description><para><classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> - <classname alt="boost::interprocess::offset_ptr">offset_ptr</classname> operation </para></description></method>
</method-group>
<method-group name="private member functions">
<method name="assign" cv="noexcept"><type>void</type><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="ptr"><paramtype>const <classname>offset_ptr</classname>&lt; T2, DifferenceType, OffsetType, OffsetAlignment &gt; &amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype></parameter></method>
<method name="assign" cv="noexcept"><type>void</type><template>
          <template-type-parameter name="T2"/>
        </template><parameter name="ptr"><paramtype>const <classname>offset_ptr</classname>&lt; T2, DifferenceType, OffsetType, OffsetAlignment &gt; &amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype></parameter></method>
</method-group>
</class><function name="operator&lt;&lt;"><type>std::basic_ostream&lt; E, T &gt; &amp;</type><template>
          <template-type-parameter name="E"/>
          <template-type-parameter name="T"/>
          <template-type-parameter name="W"/>
          <template-type-parameter name="X"/>
          <template-type-parameter name="Y"/>
          <template-nontype-parameter name="Z"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="os"><paramtype>std::basic_ostream&lt; E, T &gt; &amp;</paramtype></parameter><parameter name="p"><paramtype><classname>offset_ptr</classname>&lt; W, X, Y, Z &gt; const &amp;</paramtype></parameter><description><para>operator&lt;&lt; for offset ptr </para></description></function>
<function name="operator&gt;&gt;"><type>std::basic_istream&lt; E, T &gt; &amp;</type><template>
          <template-type-parameter name="E"/>
          <template-type-parameter name="T"/>
          <template-type-parameter name="W"/>
          <template-type-parameter name="X"/>
          <template-type-parameter name="Y"/>
          <template-nontype-parameter name="Z"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="is"><paramtype>std::basic_istream&lt; E, T &gt; &amp;</paramtype></parameter><parameter name="p"><paramtype><classname>offset_ptr</classname>&lt; W, X, Y, Z &gt; &amp;</paramtype></parameter><description><para>operator&gt;&gt; for offset ptr </para></description></function>
<function name="static_pointer_cast"><type><classname>boost::interprocess::offset_ptr</classname>&lt; T1, P1, O1, A1 &gt;</type><template>
          <template-type-parameter name="T1"/>
          <template-type-parameter name="P1"/>
          <template-type-parameter name="O1"/>
          <template-nontype-parameter name="A1"><type>std::size_t</type></template-nontype-parameter>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="P2"/>
          <template-type-parameter name="O2"/>
          <template-nontype-parameter name="A2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="r"><paramtype>const <classname>boost::interprocess::offset_ptr</classname>&lt; T2, P2, O2, A2 &gt; &amp;</paramtype></parameter><purpose>Simulation of static_cast between pointers. Never throws. </purpose></function>
<function name="const_pointer_cast"><type><classname>boost::interprocess::offset_ptr</classname>&lt; T1, P1, O1, A1 &gt;</type><template>
          <template-type-parameter name="T1"/>
          <template-type-parameter name="P1"/>
          <template-type-parameter name="O1"/>
          <template-nontype-parameter name="A1"><type>std::size_t</type></template-nontype-parameter>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="P2"/>
          <template-type-parameter name="O2"/>
          <template-nontype-parameter name="A2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="r"><paramtype>const <classname>boost::interprocess::offset_ptr</classname>&lt; T2, P2, O2, A2 &gt; &amp;</paramtype></parameter><purpose>Simulation of const_cast between pointers. Never throws. </purpose></function>
<function name="dynamic_pointer_cast"><type><classname>boost::interprocess::offset_ptr</classname>&lt; T1, P1, O1, A1 &gt;</type><template>
          <template-type-parameter name="T1"/>
          <template-type-parameter name="P1"/>
          <template-type-parameter name="O1"/>
          <template-nontype-parameter name="A1"><type>std::size_t</type></template-nontype-parameter>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="P2"/>
          <template-type-parameter name="O2"/>
          <template-nontype-parameter name="A2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="r"><paramtype>const <classname>boost::interprocess::offset_ptr</classname>&lt; T2, P2, O2, A2 &gt; &amp;</paramtype></parameter><purpose>Simulation of dynamic_cast between pointers. Never throws. </purpose></function>
<function name="reinterpret_pointer_cast"><type><classname>boost::interprocess::offset_ptr</classname>&lt; T1, P1, O1, A1 &gt;</type><template>
          <template-type-parameter name="T1"/>
          <template-type-parameter name="P1"/>
          <template-type-parameter name="O1"/>
          <template-nontype-parameter name="A1"><type>std::size_t</type></template-nontype-parameter>
          <template-type-parameter name="T2"/>
          <template-type-parameter name="P2"/>
          <template-type-parameter name="O2"/>
          <template-nontype-parameter name="A2"><type>std::size_t</type></template-nontype-parameter>
        </template><parameter name="r"><paramtype>const <classname>boost::interprocess::offset_ptr</classname>&lt; T2, P2, O2, A2 &gt; &amp;</paramtype></parameter><purpose>Simulation of reinterpret_cast between pointers. Never throws. </purpose></function>











































</namespace>
</namespace>
</header>
<header name="boost/interprocess/permissions.hpp">
<para>Describes permissions class </para><namespace name="boost">
<namespace name="interprocess">
<class name="permissions"><description><para>The permissions class represents permissions to be set to shared memory or files, that can be constructed form usual permission representations: a SECURITY_ATTRIBUTES pointer in windows or ORed rwx chmod integer in UNIX. </para></description><method-group name="public member functions">
<method name="set_default" cv="noexcept"><type>void</type><description><para>Sets permissions to default values: A null security attributes pointer for windows or 0644 for UNIX. </para></description></method>
<method name="set_unrestricted" cv="noexcept"><type>void</type><description><para>Sets permissions to unrestricted access: A null DACL for windows or 0666 for UNIX. </para></description></method>
<method name="set_permissions" cv="noexcept"><type>void</type><parameter name="perm"><paramtype>os_permissions_type</paramtype></parameter><description><para>Sets permissions from a user provided os-dependent permissions. </para></description></method>
<method name="get_permissions" cv="const noexcept"><type>os_permissions_type</type><description><para>Returns stored os-dependent permissions </para></description></method>
</method-group>
<constructor cv="noexcept"><parameter name="type"><paramtype>os_permissions_type</paramtype></parameter><description><para>Constructs a permissions object from a user provided os-dependent permissions. </para></description></constructor>
<constructor cv="noexcept"><description><para>Constructs a default permissions object: A null security attributes pointer for windows or 0644 for UNIX. </para></description></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/segment_manager.hpp">
<para>Describes the object placed in a memory segment that provides named object allocation capabilities for single-segment and multi-segment allocations. </para><namespace name="boost">
<namespace name="interprocess">
<class name="segment_manager"><template>
      <template-type-parameter name="CharType"/>
      <template-type-parameter name="MemoryAlgorithm"/>
      <template-nontype-parameter name="IndexType"><type>template&lt; class IndexConfig &gt; class</type></template-nontype-parameter>
    </template><inherit access="public">boost::interprocess::segment_manager_base&lt; MemoryAlgorithm &gt;</inherit><description><para>This object is placed in the beginning of memory segment and implements the allocation (named or anonymous) of portions of the segment. This object contains two indexes that maintain an association between a name and a portion of the segment.</para><para>The first index contains the mappings for normal named objects using the char type specified in the template parameter.</para><para>The second index contains the association for unique instances. The key will be the const char * returned from type_info.name() function for the unique type to be constructed.</para><para>segment_manager&lt;CharType, MemoryAlgorithm, IndexType&gt; inherits publicly from segment_manager_base&lt;MemoryAlgorithm&gt; and inherits from it many public functions related to anonymous object and raw memory allocation. See <classname alt="boost::interprocess::segment_manager_base">segment_manager_base</classname> reference to know about those functions. </para></description><struct name="allocator"><template>
      <template-type-parameter name="T"/>
    </template><description><para>This is the default allocator to allocate types T from this managed segment </para></description><typedef name="type"><type><classname>boost::interprocess::allocator</classname>&lt; T, <classname>segment_manager</classname> &gt;</type></typedef>
</struct><struct name="deleter"><template>
      <template-type-parameter name="T"/>
    </template><description><para>This is the default deleter to delete types T from this managed segment. </para></description><typedef name="type"><type><classname>boost::interprocess::deleter</classname>&lt; T, <classname>segment_manager</classname> &gt;</type></typedef>
</struct><typedef name="memory_algorithm"><type>MemoryAlgorithm</type></typedef>
<typedef name="void_pointer"><type>segment_manager_base_t::void_pointer</type></typedef>
<typedef name="size_type"><type>segment_manager_base_t::size_type</type></typedef>
<typedef name="difference_type"><type>segment_manager_base_t::difference_type</type></typedef>
<typedef name="char_type"><type>CharType</type></typedef>
<typedef name="segment_manager_base_type"><type><classname>segment_manager_base</classname>&lt; MemoryAlgorithm &gt;</type></typedef>
<typedef name="mutex_family"><type>segment_manager_base_t::mutex_family</type></typedef>
<typedef name="const_named_iterator"><type>transform_iterator&lt; typename named_index_t::const_iterator, named_transform &gt;</type></typedef>
<typedef name="const_unique_iterator"><type>transform_iterator&lt; typename unique_index_t::const_iterator, unique_transform &gt;</type></typedef>
<data-member name="PayloadPerAllocation" specifiers="static"><type>const size_type</type></data-member>
<method-group name="public member functions">
<method name="find"><type>std::pair&lt; T *, size_type &gt;</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><description><para>Tries to find a previous named/unique allocation. Returns the address and the object count. On failure the first member of the returned pair is 0. </para></description></method>
<method name="find_no_lock"><type>std::pair&lt; T *, size_type &gt;</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><description><para>Tries to find a previous named/unique allocation. Returns the address and the object count. On failure the first member of the returned pair is 0. This search is not mutex-protected! Use it only inside atomic_func() calls, where the internal mutex is guaranteed to be locked. </para></description></method>
<method name="construct"><type>construct_proxy&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><description><para>Returns throwing "construct" proxy object </para></description></method>
<method name="find_or_construct"><type>construct_proxy&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><description><para>Returns throwing "search or construct" proxy object </para></description></method>
<method name="construct"><type>construct_proxy&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><parameter name=""><paramtype>const std::nothrow_t &amp;</paramtype></parameter><description><para>Returns no throwing "construct" proxy object </para></description></method>
<method name="find_or_construct"><type>construct_proxy&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><parameter name=""><paramtype>const std::nothrow_t &amp;</paramtype></parameter><description><para>Returns no throwing "search or construct" proxy object </para></description></method>
<method name="construct_it"><type>construct_iter_proxy&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><purpose>Returns throwing "construct from iterators" proxy object. </purpose></method>
<method name="find_or_construct_it"><type>construct_iter_proxy&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><description><para>Returns throwing "search or construct from iterators" proxy object </para></description></method>
<method name="construct_it"><type>construct_iter_proxy&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><parameter name=""><paramtype>const std::nothrow_t &amp;</paramtype></parameter><description><para>Returns no throwing "construct from iterators" proxy object </para></description></method>
<method name="find_or_construct_it"><type>construct_iter_proxy&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><parameter name=""><paramtype>const std::nothrow_t &amp;</paramtype></parameter><description><para>Returns no throwing "search or construct from iterators" proxy object </para></description></method>
<method name="atomic_func"><type>void</type><template>
          <template-type-parameter name="Func"/>
        </template><parameter name="f"><paramtype>Func &amp;</paramtype></parameter><description><para>Calls object function blocking recursive <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> and guarantees that no new named_alloc or destroy will be executed by any process while executing the object function call </para></description></method>
<method name="try_atomic_func"><type>bool</type><template>
          <template-type-parameter name="Func"/>
        </template><parameter name="f"><paramtype>Func &amp;</paramtype></parameter><description><para>Tries to calls a functor guaranteeing that no new construction, search or destruction will be executed by any process while executing the object function call. If the atomic function can't be immediatelly executed because the internal mutex is already locked, returns false. If the functor throws, this function throws. </para></description></method>
<method name="destroy"><type>bool</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="name"><paramtype>char_ptr_holder_t</paramtype></parameter><description><para>Destroys a previously created named/unique instance. Returns false if the object was not present. </para></description></method>
<method name="destroy_ptr"><type>void</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="p"><paramtype>const T *</paramtype></parameter><description><para>Destroys an anonymous, unique or named object using its address </para></description></method>
<method name="reserve_named_objects"><type>void</type><parameter name="num"><paramtype>size_type</paramtype></parameter><description><para>Preallocates needed index resources to optimize the creation of "num" named objects in the managed memory segment. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory. </para></description></method>
<method name="reserve_unique_objects"><type>void</type><parameter name="num"><paramtype>size_type</paramtype></parameter><description><para>Preallocates needed index resources to optimize the creation of "num" unique objects in the managed memory segment. Can throw <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> if there is no enough memory. </para></description></method>
<method name="shrink_to_fit_indexes"><type>void</type><description><para>Calls shrink_to_fit in both named and unique object indexes to try to free unused memory from those indexes. </para></description></method>
<method name="get_num_named_objects"><type>size_type</type><description><para>Returns the number of named objects stored in the segment. </para></description></method>
<method name="get_num_unique_objects"><type>size_type</type><description><para>Returns the number of unique objects stored in the segment. </para></description></method>
<method name="named_begin" cv="const"><type>const_named_iterator</type><description><para>Returns a constant iterator to the beginning of the information about the named allocations performed in this segment manager </para></description></method>
<method name="named_end" cv="const"><type>const_named_iterator</type><description><para>Returns a constant iterator to the end of the information about the named allocations performed in this segment manager </para></description></method>
<method name="unique_begin" cv="const"><type>const_unique_iterator</type><description><para>Returns a constant iterator to the beginning of the information about the unique allocations performed in this segment manager </para></description></method>
<method name="unique_end" cv="const"><type>const_unique_iterator</type><description><para>Returns a constant iterator to the end of the information about the unique allocations performed in this segment manager </para></description></method>
<method name="get_allocator"><type><classname>allocator</classname>&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><description><para>Returns an instance of the default allocator for type T initialized that allocates memory from this segment manager. </para></description></method>
<method name="get_deleter"><type><classname>deleter</classname>&lt; T &gt;::type</type><template>
          <template-type-parameter name="T"/>
        </template><description><para>Returns an instance of the default deleter for type T that will delete an object constructed in this segment manager. </para></description></method>
</method-group>
<constructor specifiers="explicit"><parameter name="segment_size"><paramtype>size_type</paramtype></parameter><description><para>Constructor of the segment manager "size" is the size of the memory segment where the segment manager is being constructed. Can throw </para></description></constructor>
<method-group name="public static functions">
<method name="get_instance_name" specifiers="static"><type>const CharType *</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="ptr"><paramtype>const T *</paramtype></parameter><description><para>Returns the name of an object created with construct/find_or_construct functions. Does not throw </para></description></method>
<method name="get_instance_length" specifiers="static"><type>size_type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="ptr"><paramtype>const T *</paramtype></parameter><description><para>Returns the length of an object created with construct/find_or_construct functions. Does not throw. </para></description></method>
<method name="get_instance_type" specifiers="static"><type>instance_type</type><template>
          <template-type-parameter name="T"/>
        </template><parameter name="ptr"><paramtype>const T *</paramtype></parameter><description><para>Returns is the the name of an object created with construct/find_or_construct functions. Does not throw </para></description></method>
<method name="get_min_size" specifiers="static"><type>size_type</type><description><para>Obtains the minimum size needed by the segment manager </para></description></method>
</method-group>
</class><class name="segment_manager_base"><template>
      <template-type-parameter name="MemoryAlgorithm"/>
    </template><inherit access="private">MemoryAlgorithm</inherit><description><para>This object is the public base class of segment manager. This class only depends on the memory allocation algorithm and implements all the allocation features not related to named or unique objects.</para><para>Storing a reference to <classname alt="boost::interprocess::segment_manager">segment_manager</classname> forces the holder class to be dependent on index types and character types. When such dependence is not desirable and only anonymous and raw allocations are needed, <classname alt="boost::interprocess::segment_manager_base">segment_manager_base</classname> is the correct answer. </para></description><typedef name="segment_manager_base_type"><type><classname>segment_manager_base</classname>&lt; MemoryAlgorithm &gt;</type></typedef>
<typedef name="void_pointer"><type>MemoryAlgorithm::void_pointer</type></typedef>
<typedef name="mutex_family"><type>MemoryAlgorithm::mutex_family</type></typedef>
<typedef name="memory_algorithm"><type>MemoryAlgorithm</type></typedef>
<data-member name="PayloadPerAllocation" specifiers="static"><type>const size_type</type><description><para>This constant indicates the payload size associated with each allocation of the memory algorithm </para></description></data-member>
<method-group name="public member functions">
<method name="get_size" cv="const"><type>size_type</type><description><para>Returns the size of the memory segment </para></description></method>
<method name="get_free_memory" cv="const"><type>size_type</type><description><para>Returns the number of free bytes of the memory segment </para></description></method>
<method name="allocate"><type>void *</type><parameter name="nbytes"><paramtype>size_type</paramtype></parameter><parameter name=""><paramtype>const std::nothrow_t &amp;</paramtype></parameter><description><para>Allocates nbytes bytes. This function is only used in single-segment management. Never throws </para></description></method>
<method name="get_memory_algorithm"><type>MemoryAlgorithm &amp;</type><description><para>Returns a reference to the internal memory algorithm. This function is useful for custom memory algorithms that need additional configuration options after construction. Never throws. This function should be only used by advanced users. </para></description></method>
<method name="get_memory_algorithm" cv="const"><type>const MemoryAlgorithm &amp;</type><description><para>Returns a const reference to the internal memory algorithm. This function is useful for custom memory algorithms that need additional configuration options after construction. Never throws. This function should be only used by advanced users. </para></description></method>
<method name="allocate"><type>void *</type><parameter name="nbytes"><paramtype>size_type</paramtype></parameter><description><para>Allocates nbytes bytes. Throws <classname alt="boost::interprocess::bad_alloc">boost::interprocess::bad_alloc</classname> on failure </para></description></method>
<method name="allocate_aligned"><type>void *</type><parameter name="nbytes"><paramtype>size_type</paramtype></parameter><parameter name="alignment"><paramtype>size_type</paramtype></parameter><parameter name=""><paramtype>const std::nothrow_t &amp;</paramtype></parameter><description><para>Allocates nbytes bytes. This function is only used in single-segment management. Never throws </para></description></method>
<method name="allocate_aligned"><type>void *</type><parameter name="nbytes"><paramtype>size_type</paramtype></parameter><parameter name="alignment"><paramtype>size_type</paramtype></parameter><description><para>Allocates nbytes bytes. This function is only used in single-segment management. Throws <classname alt="boost::interprocess::bad_alloc">bad_alloc</classname> when fails </para></description></method>
<method name="deallocate"><type>void</type><parameter name="addr"><paramtype>void *</paramtype></parameter><description><para>Deallocates the bytes allocated with allocate/allocate_many() pointed by addr </para></description></method>
<method name="grow"><type>void</type><parameter name="extra_size"><paramtype>size_type</paramtype></parameter><description><para>Increases managed memory in extra_size bytes more. This only works with single-segment management. </para></description></method>
<method name="shrink_to_fit"><type>void</type><description><para>Decreases managed memory to the minimum. This only works with single-segment management. </para></description></method>
<method name="all_memory_deallocated"><type>bool</type><description><para>Returns the result of "all_memory_deallocated()" function of the used memory algorithm </para></description></method>
<method name="check_sanity"><type>bool</type><description><para>Returns the result of "check_sanity()" function of the used memory algorithm </para></description></method>
<method name="zero_free_memory"><type>void</type><description><para>Writes to zero free memory (memory not yet allocated) of the memory algorithm </para></description></method>
<method name="size" cv="const"><type>size_type</type><parameter name="ptr"><paramtype>const void *</paramtype></parameter><purpose>Returns the size of the buffer previously allocated pointed by ptr. </purpose></method>
</method-group>
<constructor><parameter name="sz"><paramtype>size_type</paramtype></parameter><parameter name="reserved_bytes"><paramtype>size_type</paramtype></parameter><description><para>Constructor of the <classname alt="boost::interprocess::segment_manager_base">segment_manager_base</classname></para><para>"size" is the size of the memory segment where the basic segment manager is being constructed.</para><para>"reserved_bytes" is the number of bytes after the end of the memory algorithm object itself that the memory algorithm will exclude from dynamic allocation</para><para>Can throw </para></description></constructor>
<method-group name="public static functions">
<method name="get_min_size" specifiers="static"><type>size_type</type><parameter name="size"><paramtype>size_type</paramtype></parameter><description><para>Obtains the minimum size needed by the segment manager </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/shared_memory_object.hpp">
<para>Describes a shared memory object management class. </para><namespace name="boost">
<namespace name="interprocess">
<class name="shared_memory_object"><description><para>A class that wraps a shared memory mapping that can be used to create mapped regions from the mapped files </para></description><method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="moved"><paramtype><classname>shared_memory_object</classname> &amp;</paramtype></parameter><purpose>Swaps the shared_memory_objects. Does not throw. </purpose></method>
<method name="truncate"><type>void</type><parameter name="length"><paramtype>offset_t</paramtype></parameter><purpose>Sets the size of the shared memory mapping. </purpose></method>
<method name="get_name" cv="const noexcept"><type>const char *</type><purpose>Returns the name of the shared memory object. </purpose></method>
<method name="get_size" cv="const noexcept"><type>bool</type><parameter name="size"><paramtype>offset_t &amp;</paramtype></parameter><description><para>Returns true if the size of the shared memory object can be obtained and writes the size in the passed reference </para></description></method>
<method name="get_mode" cv="const noexcept"><type>mode_t</type><purpose>Returns access mode. </purpose></method>
<method name="get_mapping_handle" cv="const noexcept"><type>mapping_handle_t</type><purpose>Returns mapping handle. Never throws. </purpose></method>
</method-group>
<constructor cv="noexcept"><purpose>Default constructor. Represents an empty <classname alt="boost::interprocess::shared_memory_object">shared_memory_object</classname>. </purpose></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a shared memory object with name "name" and mode "mode", with the access mode "mode" If the file previously exists, throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Tries to create a shared memory object with name "name" and mode "mode", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><description><para>Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a shared memory object with name "name" and mode "mode", with the access mode "mode" If the file previously exists, throws an error.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Tries to create a shared memory object with name "name" and mode "mode", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><description><para>Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>shared_memory_object</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>shared_memory_object</classname> &amp;</type><parameter name="moved"><paramtype><classname>shared_memory_object</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw </para></description></copy-assignment>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. All mapped regions are still valid after destruction. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Erases a shared memory object from the system. Returns false on error. Never throws </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Erases a shared memory object from the system. Returns false on error. Never throws</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/smart_ptr/deleter.hpp">
<para>Describes the functor to delete objects from the segment. </para><namespace name="boost">
<namespace name="interprocess">
<class name="deleter"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="SegmentManager"/>
    </template><description><para>A deleter that uses the segment manager's destroy_ptr function to destroy the passed pointer resource.</para><para>This deleter is used </para></description><typedef name="pointer"><type>boost::intrusive::pointer_traits&lt; typename SegmentManager::void_pointer &gt;::template rebind_pointer&lt; T &gt;::type</type></typedef>
<method-group name="public member functions">
<method name="operator()"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter></method>
</method-group>
<constructor cv="noexcept"><parameter name="pmngr"><paramtype>segment_manager_pointer</paramtype></parameter></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/smart_ptr/enable_shared_from_this.hpp">
<para>Describes an utility to form a shared pointer from this </para><namespace name="boost">
<namespace name="interprocess">

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/smart_ptr/intrusive_ptr.hpp">
<para>Describes an intrusive ownership pointer. </para><namespace name="boost">
<namespace name="interprocess">
<class name="intrusive_ptr"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="VoidPointer"/>
    </template><description><para>The <classname alt="boost::interprocess::intrusive_ptr">intrusive_ptr</classname> class template stores a pointer to an object with an embedded reference count. <classname alt="boost::interprocess::intrusive_ptr">intrusive_ptr</classname> is parameterized on T (the type of the object pointed to) and VoidPointer(a void pointer type that defines the type of pointer that <classname alt="boost::interprocess::intrusive_ptr">intrusive_ptr</classname> will store). intrusive_ptr&lt;T, void *&gt; defines a class with a T* member whereas <classname alt="boost::interprocess::intrusive_ptr">intrusive_ptr</classname>&lt;T, offset_ptr&lt;void&gt; &gt; defines a class with a offset_ptr&lt;T&gt; member. Relies on unqualified calls to:</para><para>void intrusive_ptr_add_ref(T * p) BOOST_NOEXCEPT; void intrusive_ptr_release(T * p) BOOST_NOEXCEPT;</para><para>with (p != 0)</para><para>The object is responsible for destroying itself. </para></description><typedef name="pointer"><purpose>Provides the type of the internal stored pointer. </purpose><type>boost::intrusive::pointer_traits&lt; VoidPointer &gt;::template rebind_pointer&lt; T &gt;::type</type></typedef>
<typedef name="element_type"><purpose>Provides the type of the stored pointer. </purpose><type>T</type></typedef>
<method-group name="public member functions">
<method name="reset" cv="noexcept"><type>void</type><description><para>Release internal pointer and set it to 0. If internal pointer is not 0, calls intrusive_ptr_release(to_raw_pointer(m_ptr)). Does not throw </para></description></method>
<method name="get" cv="noexcept"><type>pointer &amp;</type><description><para>Returns a reference to the internal pointer. Does not throw </para></description></method>
<method name="get" cv="const noexcept"><type>const pointer &amp;</type><description><para>Returns a reference to the internal pointer. Does not throw </para></description></method>
<method name="operator *" cv="const noexcept"><type>T &amp;</type><description><para>Returns *get(). Does not throw </para></description></method>
<method name="operator-&gt;" cv="const noexcept"><type>const pointer &amp;</type><description><para>Returns *get(). Does not throw </para></description></method>
<method name="operator-&gt;" cv="noexcept"><type>pointer &amp;</type><description><para>Returns get(). Does not throw </para></description></method>
<method name="conversion-operator" cv="const noexcept"><type>unspecified_bool_type</type><description><para>Conversion to boolean. Does not throw </para></description></method>
<method name="operator!" cv="const noexcept"><type>bool</type><description><para>Not operator. Does not throw </para></description></method>
<method name="swap" cv="noexcept"><type>void</type><parameter name="rhs"><paramtype><classname>intrusive_ptr</classname> &amp;</paramtype></parameter><description><para>Exchanges the contents of the two smart pointers. Does not throw </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Constructor. Initializes internal pointer to 0. Does not throw </para></description></constructor>
<constructor cv="noexcept"><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="add_ref"><paramtype>bool</paramtype><default>true</default></parameter><description><para>Constructor. Copies pointer and if "p" is not zero and "add_ref" is true calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </para></description></constructor>
<constructor cv="noexcept"><parameter name="rhs"><paramtype><classname>intrusive_ptr</classname> const &amp;</paramtype></parameter><description><para>Copy constructor. Copies the internal pointer and if "p" is not zero calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </para></description></constructor>
<constructor cv="noexcept"><parameter name="rhs"><paramtype><classname>intrusive_ptr</classname> &amp;&amp;</paramtype></parameter><purpose>Move constructor. Moves the internal pointer. Does not throw. </purpose></constructor>
<constructor cv="noexcept"><template>
          <template-type-parameter name="U"/>
        </template><parameter name="rhs"><paramtype><classname>intrusive_ptr</classname>&lt; U, VP &gt; const &amp;</paramtype></parameter><description><para>Constructor from related. Copies the internal pointer and if "p" is not zero calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </para></description></constructor>
<destructor><purpose>Destructor. Calls reset(). Does not throw. </purpose></destructor>
<copy-assignment cv="noexcept"><type><classname>intrusive_ptr</classname> &amp;</type><parameter name="rhs"><paramtype>BOOST_COPY_ASSIGN_REF(<classname>intrusive_ptr</classname>)</paramtype></parameter><description><para>Assignment operator. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </para></description></copy-assignment>
<copy-assignment cv="noexcept"><type><classname>intrusive_ptr</classname> &amp;</type><parameter name="rhs"><paramtype><classname>intrusive_ptr</classname> &amp;&amp;</paramtype></parameter><description><para>Move Assignment operator Does not throw </para></description></copy-assignment>
<copy-assignment cv="noexcept"><type><classname>intrusive_ptr</classname> &amp;</type><template>
          <template-type-parameter name="U"/>
        </template><parameter name="rhs"><paramtype><classname>intrusive_ptr</classname>&lt; U, VP &gt; const &amp;</paramtype></parameter><description><para>Assignment from related. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </para></description></copy-assignment>
<copy-assignment cv="noexcept"><type><classname>intrusive_ptr</classname> &amp;</type><parameter name="rhs"><paramtype>pointer</paramtype></parameter><description><para>Assignment from pointer. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </para></description></copy-assignment>
</class>





































<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="U"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="a"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>intrusive_ptr</classname>&lt; U, VP &gt; const &amp;</paramtype></parameter><description><para>Returns a.get() == b.get(). Does not throw </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="U"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="a"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>intrusive_ptr</classname>&lt; U, VP &gt; const &amp;</paramtype></parameter><description><para>Returns a.get() != b.get(). Does not throw </para></description></function>
<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="a"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype>const typename <classname>intrusive_ptr</classname>&lt; T, VP &gt;::pointer &amp;</paramtype></parameter><description><para>Returns a.get() == b. Does not throw </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="a"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype>const typename <classname>intrusive_ptr</classname>&lt; T, VP &gt;::pointer &amp;</paramtype></parameter><description><para>Returns a.get() != b. Does not throw </para></description></function>
<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="a"><paramtype>const typename <classname>intrusive_ptr</classname>&lt; T, VP &gt;::pointer &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; const &amp;</paramtype></parameter><description><para>Returns a == b.get(). Does not throw </para></description></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="a"><paramtype>const typename <classname>intrusive_ptr</classname>&lt; T, VP &gt;::pointer &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; const &amp;</paramtype></parameter><description><para>Returns a != b.get(). Does not throw </para></description></function>
<function name="operator&lt;"><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="a"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; const &amp;</paramtype></parameter><description><para>Returns a.get() &lt; b.get(). Does not throw </para></description></function>
<function name="swap"><type>void</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="lhs"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; &amp;</paramtype></parameter><parameter name="rhs"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt; &amp;</paramtype></parameter><description><para>Exchanges the contents of the two intrusive_ptrs. Does not throw </para></description></function>
<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; E, T &gt; &amp;</type><template>
          <template-type-parameter name="E"/>
          <template-type-parameter name="T"/>
          <template-type-parameter name="Y"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="os"><paramtype>std::basic_ostream&lt; E, T &gt; &amp;</paramtype></parameter><parameter name="p"><paramtype><classname>intrusive_ptr</classname>&lt; Y, VP &gt; const &amp;</paramtype></parameter></function>
<function name="to_raw_pointer"><type><classname>boost::interprocess::intrusive_ptr</classname>&lt; T, VP &gt;::pointer</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VP"/>
        </template><parameter name="p"><paramtype><classname>intrusive_ptr</classname>&lt; T, VP &gt;</paramtype></parameter><description><para>Returns p.get(). Does not throw </para></description></function>

</namespace>
</namespace>
</header>
<header name="boost/interprocess/smart_ptr/scoped_ptr.hpp">
<para>Describes the smart pointer scoped_ptr </para><namespace name="boost">
<namespace name="interprocess">
<class name="scoped_ptr"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="Deleter"/>
    </template><inherit access="private">Deleter</inherit><description><para><classname alt="boost::interprocess::scoped_ptr">scoped_ptr</classname> stores a pointer to a dynamically allocated object. The object pointed to is guaranteed to be deleted, either on destruction of the <classname alt="boost::interprocess::scoped_ptr">scoped_ptr</classname>, or via an explicit reset. The user can avoid this deletion using release(). <classname alt="boost::interprocess::scoped_ptr">scoped_ptr</classname> is parameterized on T (the type of the object pointed to) and Deleter (the functor to be executed to delete the internal pointer). The internal pointer will be of the same pointer type as typename Deleter::pointer type (that is, if typename Deleter::pointer is offset_ptr&lt;void&gt;, the internal pointer will be offset_ptr&lt;T&gt;). </para></description><typedef name="element_type"><type>T</type></typedef>
<typedef name="deleter_type"><type>Deleter</type></typedef>
<typedef name="pointer"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="unspecified_bool_type"><type>pointer this_type::*</type></typedef>
<method-group name="public member functions">
<method name="reset"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype><default>0</default></parameter><description><para>Deletes the object pointed to by the stored pointer and then stores a copy of p. Never throws </para></description></method>
<method name="reset"><type>void</type><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="d"><paramtype>const Deleter &amp;</paramtype></parameter><description><para>Deletes the object pointed to by the stored pointer and then stores a copy of p and a copy of d. </para></description></method>
<method name="release" cv="noexcept"><type>pointer</type><description><para>Assigns internal pointer as 0 and returns previous pointer. This will avoid deletion on destructor </para></description></method>
<method name="operator *" cv="const noexcept"><type>reference</type><description><para>Returns a reference to the object pointed to by the stored pointer. Never throws. </para></description></method>
<method name="operator-&gt;" cv="noexcept"><type>pointer &amp;</type><description><para>Returns the internal stored pointer. Never throws. </para></description></method>
<method name="operator-&gt;" cv="const noexcept"><type>const pointer &amp;</type><description><para>Returns the internal stored pointer. Never throws. </para></description></method>
<method name="get" cv="noexcept"><type>pointer &amp;</type><description><para>Returns the stored pointer. Never throws. </para></description></method>
<method name="get" cv="const noexcept"><type>const pointer &amp;</type><description><para>Returns the stored pointer. Never throws. </para></description></method>
<method name="conversion-operator" cv="const noexcept"><type>unspecified_bool_type</type><description><para>Conversion to bool Never throws </para></description></method>
<method name="operator!" cv="const noexcept"><type>bool</type><description><para>Returns true if the stored pointer is 0. Never throws. </para></description></method>
<method name="swap" cv="noexcept"><type>void</type><parameter name="b"><paramtype><classname>scoped_ptr</classname> &amp;</paramtype></parameter><description><para>Exchanges the internal pointer and deleter with other <classname alt="boost::interprocess::scoped_ptr">scoped_ptr</classname> Never throws. </para></description></method>
</method-group>
<constructor specifiers="explicit"><parameter name="p"><paramtype>const pointer &amp;</paramtype><default>0</default></parameter><parameter name="d"><paramtype>const Deleter &amp;</paramtype><default>Deleter()</default></parameter><description><para>Constructs a <classname alt="boost::interprocess::scoped_ptr">scoped_ptr</classname>, storing a copy of p(which can be 0) and d. Does not throw. </para></description></constructor>
<destructor><description><para>If the stored pointer is not 0, destroys the object pointed to by the stored pointer. calling the operator() of the stored deleter. Never throws </para></description></destructor>
</class>



































<function name="swap"><type>void</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="D"/>
        </template><parameter name="a"><paramtype><classname>scoped_ptr</classname>&lt; T, D &gt; &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>scoped_ptr</classname>&lt; T, D &gt; &amp;</paramtype></parameter><description><para>Exchanges the internal pointer and deleter with other <classname alt="boost::interprocess::scoped_ptr">scoped_ptr</classname> Never throws. </para></description></function>
<function name="to_raw_pointer"><type><classname>scoped_ptr</classname>&lt; T, D &gt;::pointer</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="D"/>
        </template><parameter name="p"><paramtype><classname>scoped_ptr</classname>&lt; T, D &gt; const &amp;</paramtype></parameter><description><para>Returns a copy of the stored pointer Never throws </para></description></function>











</namespace>
</namespace>
</header>
<header name="boost/interprocess/smart_ptr/shared_ptr.hpp">
<para>Describes the smart pointer shared_ptr </para><namespace name="boost">
<namespace name="interprocess">
<class name="enable_shared_from_this"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="A"/>
      <template-type-parameter name="D"/>
    </template><description><para>This class is used as a base class that allows a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> to the current object to be obtained from within a member function. <classname alt="boost::interprocess::enable_shared_from_this">enable_shared_from_this</classname> defines two member functions called shared_from_this that return a shared_ptr&lt;T&gt; and shared_ptr&lt;T const&gt;, depending on constness, to this. </para></description><method-group name="public member functions">
<method name="shared_from_this"><type><classname>shared_ptr</classname>&lt; T, A, D &gt;</type></method>
<method name="shared_from_this" cv="const"><type><classname>shared_ptr</classname>&lt; T const, A, D &gt;</type></method>
</method-group>
</class><struct name="managed_shared_ptr"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="ManagedMemory"/>
    </template><description><para>Returns the type of a shared pointer of type T with the allocator <classname alt="boost::interprocess::allocator">boost::interprocess::allocator</classname> allocator and <classname alt="boost::interprocess::deleter">boost::interprocess::deleter</classname> deleter that can be constructed in the given managed segment type. </para></description><typedef name="void_allocator"><type>ManagedMemory::template <classname>allocator</classname>&lt; void &gt;::<classname>type</classname></type></typedef>
<typedef name="deleter"><type>ManagedMemory::template deleter&lt; T &gt;::<classname>type</classname></type></typedef>
<typedef name="type"><type><classname>shared_ptr</classname>&lt; T, void_allocator, deleter &gt;</type></typedef>
</struct><class name="shared_ptr"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="VoidAllocator"/>
      <template-type-parameter name="Deleter"/>
    </template><description><para><classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> stores a pointer to a dynamically allocated object. The object pointed to is guaranteed to be deleted when the last <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> pointing to it is destroyed or reset.</para><para><classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> is parameterized on T (the type of the object pointed to), VoidAllocator (the void allocator to be used to allocate the auxiliary data) and Deleter (the deleter whose operator() will be used to delete the object.</para><para>The internal pointer will be of the same pointer type as typename VoidAllocator::pointer type (that is, if typename VoidAllocator::pointer is offset_ptr&lt;void&gt;, the internal pointer will be offset_ptr&lt;T&gt;).</para><para>Because the implementation uses reference counting, cycles of <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> instances will not be reclaimed. For example, if main() holds a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> to A, which directly or indirectly holds a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> back to A, A's use count will be 2. Destruction of the original <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> will leave A dangling with a use count of 1. Use <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> to "break cycles." </para></description><typedef name="element_type"><type>T</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<typedef name="void_ptr"><type>boost::container::allocator_traits&lt; VoidAllocator &gt;::pointer</type></typedef>
<typedef name="pointer"><type>boost::intrusive::pointer_traits&lt; void_ptr &gt;::template rebind_pointer&lt; T &gt;::type</type></typedef>
<typedef name="reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_reference"><type><emphasis>unspecified</emphasis></type></typedef>
<typedef name="const_deleter_pointer"><type>boost::intrusive::pointer_traits&lt; void_ptr &gt;::template rebind_pointer&lt; const Deleter &gt;::type</type></typedef>
<typedef name="const_allocator_pointer"><type>boost::intrusive::pointer_traits&lt; void_ptr &gt;::template rebind_pointer&lt; const VoidAllocator &gt;::type</type></typedef>
<method-group name="public member functions">
<method name="reset"><type>void</type><description><para>This is equivalent to: this_type().swap(*this); </para></description></method>
<method name="reset"><type>void</type><template>
          <template-type-parameter name="Pointer"/>
        </template><parameter name="p"><paramtype>const Pointer &amp;</paramtype></parameter><parameter name="a"><paramtype>const VoidAllocator &amp;</paramtype><default>VoidAllocator()</default></parameter><parameter name="d"><paramtype>const Deleter &amp;</paramtype><default>Deleter()</default></parameter><description><para>This is equivalent to: this_type(p, a, d).swap(*this); </para></description></method>
<method name="reset"><type>void</type><template>
          <template-type-parameter name="Y"/>
        </template><parameter name="r"><paramtype><classname>shared_ptr</classname>&lt; Y, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter></method>
<method name="operator *" cv="const"><type>reference</type><description><para>Returns a reference to the pointed type </para></description></method>
<method name="operator-&gt;" cv="const"><type>pointer</type><description><para>Returns the pointer pointing to the owned object </para></description></method>
<method name="get" cv="const"><type>pointer</type><description><para>Returns the pointer pointing to the owned object </para></description></method>
<method name="operator!" cv="const"><type>bool</type><description><para>Not operator. Returns true if this-&gt;get() != 0, false otherwise </para></description></method>
<method name="unique" cv="const"><type>bool</type><description><para>Returns use_count() == 1. unique() might be faster than use_count() </para></description></method>
<method name="use_count" cv="const"><type>long</type><description><para>Returns the number of <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> objects, *this included, that share ownership with *this, or an unspecified nonnegative value when *this is empty. use_count() is not necessarily efficient. Use only for debugging and testing purposes, not for production code. </para></description></method>
<method name="swap"><type>void</type><parameter name="other"><paramtype><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt; &amp;</paramtype></parameter><description><para>Exchanges the contents of the two smart pointers. </para></description></method>
</method-group>
<constructor><description><para>Constructs an empty <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname>. Use_count() == 0 &amp;&amp; get()== 0. </para></description></constructor>
<constructor specifiers="explicit"><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><parameter name="a"><paramtype>const VoidAllocator &amp;</paramtype><default>VoidAllocator()</default></parameter><parameter name="d"><paramtype>const Deleter &amp;</paramtype><default>Deleter()</default></parameter><description><para>Constructs a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> that owns the pointer p. Auxiliary data will be allocated with a copy of a and the object will be deleted with a copy of d. Requirements: Deleter and A's copy constructor must not throw. </para></description></constructor>
<constructor><parameter name="r"><paramtype>const <classname>shared_ptr</classname> &amp;</paramtype></parameter><description><para>Copy constructs a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname>. If r is empty, constructs an empty <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname>. Otherwise, constructs a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> that shares ownership with r. Never throws. </para></description></constructor>
<constructor><parameter name="other"><paramtype>const <classname>shared_ptr</classname> &amp;</paramtype></parameter><parameter name="p"><paramtype>const pointer &amp;</paramtype></parameter><description><para>Constructs a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> that shares ownership with other and stores p. Postconditions: get() == p &amp;&amp; use_count() == r.use_count(). Throws: nothing. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="Y"/>
        </template><parameter name="r"><paramtype><classname>shared_ptr</classname>&lt; Y, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter><description><para>If r is empty, constructs an empty <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname>. Otherwise, constructs a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> that shares ownership with r. Never throws. </para></description></constructor>
<constructor specifiers="explicit"><template>
          <template-type-parameter name="Y"/>
        </template><parameter name="r"><paramtype><classname>weak_ptr</classname>&lt; Y, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter><description><para>Constructs a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> that shares ownership with r and stores a copy of the pointer stored in r. </para></description></constructor>
<constructor specifiers="explicit"><parameter name="other"><paramtype><classname>shared_ptr</classname> &amp;&amp;</paramtype></parameter><description><para>Move-Constructs a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> that takes ownership of other resource and other is put in default-constructed state. Throws: nothing. </para></description></constructor>
<copy-assignment><type><classname>shared_ptr</classname> &amp;</type><template>
          <template-type-parameter name="Y"/>
        </template><parameter name="r"><paramtype><classname>shared_ptr</classname>&lt; Y, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter><description><para>Equivalent to shared_ptr(r).swap(*this). Never throws </para></description></copy-assignment>
<copy-assignment><type><classname>shared_ptr</classname> &amp;</type><parameter name="r"><paramtype>BOOST_COPY_ASSIGN_REF(<classname>shared_ptr</classname>)</paramtype></parameter><description><para>Equivalent to shared_ptr(r).swap(*this). Never throws </para></description></copy-assignment>
<copy-assignment><type><classname>shared_ptr</classname> &amp;</type><parameter name="other"><paramtype><classname>shared_ptr</classname> &amp;&amp;</paramtype></parameter><description><para>Move-assignment. Equivalent to shared_ptr(other).swap(*this). Never throws </para></description></copy-assignment>
</class>
























<function name="operator=="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
          <template-type-parameter name="U"/>
          <template-type-parameter name="VoidAllocator2"/>
          <template-type-parameter name="Deleter2"/>
        </template><parameter name="a"><paramtype><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>shared_ptr</classname>&lt; U, VoidAllocator2, Deleter2 &gt; const &amp;</paramtype></parameter></function>
<function name="operator!="><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
          <template-type-parameter name="U"/>
          <template-type-parameter name="VoidAllocator2"/>
          <template-type-parameter name="Deleter2"/>
        </template><parameter name="a"><paramtype><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>shared_ptr</classname>&lt; U, VoidAllocator2, Deleter2 &gt; const &amp;</paramtype></parameter></function>
<function name="operator&lt;"><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
          <template-type-parameter name="U"/>
          <template-type-parameter name="VoidAllocator2"/>
          <template-type-parameter name="Deleter2"/>
        </template><parameter name="a"><paramtype><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>shared_ptr</classname>&lt; U, VoidAllocator2, Deleter2 &gt; const &amp;</paramtype></parameter></function>
<function name="swap"><type>void</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
        </template><parameter name="a"><paramtype><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt; &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt; &amp;</paramtype></parameter></function>
<function name="static_pointer_cast"><type><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt;</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
          <template-type-parameter name="U"/>
        </template><parameter name="r"><paramtype><classname>shared_ptr</classname>&lt; U, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter></function>
<function name="const_pointer_cast"><type><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt;</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
          <template-type-parameter name="U"/>
        </template><parameter name="r"><paramtype><classname>shared_ptr</classname>&lt; U, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter></function>
<function name="dynamic_pointer_cast"><type><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt;</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
          <template-type-parameter name="U"/>
        </template><parameter name="r"><paramtype><classname>shared_ptr</classname>&lt; U, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter></function>
<function name="to_raw_pointer"><type>T *</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
        </template><parameter name="p"><paramtype><classname>shared_ptr</classname>&lt; T, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter></function>
<function name="operator&lt;&lt;"><type>std::basic_ostream&lt; E, T &gt; &amp;</type><template>
          <template-type-parameter name="E"/>
          <template-type-parameter name="T"/>
          <template-type-parameter name="Y"/>
          <template-type-parameter name="VoidAllocator"/>
          <template-type-parameter name="Deleter"/>
        </template><parameter name="os"><paramtype>std::basic_ostream&lt; E, T &gt; &amp;</paramtype></parameter><parameter name="p"><paramtype><classname>shared_ptr</classname>&lt; Y, VoidAllocator, Deleter &gt; const &amp;</paramtype></parameter></function>
<function name="make_managed_shared_ptr"><type><classname>managed_shared_ptr</classname>&lt; T, ManagedMemory &gt;::type</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="ManagedMemory"/>
        </template><parameter name="constructed_object"><paramtype>T *</paramtype></parameter><parameter name="managed_memory"><paramtype>ManagedMemory &amp;</paramtype></parameter><description><para>Returns an instance of a shared pointer constructed with the default allocator and deleter from a pointer of type T that has been allocated in the passed managed segment </para></description></function>
<function name="make_managed_shared_ptr"><type><classname>managed_shared_ptr</classname>&lt; T, ManagedMemory &gt;::type</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="ManagedMemory"/>
        </template><parameter name="constructed_object"><paramtype>T *</paramtype></parameter><parameter name="managed_memory"><paramtype>ManagedMemory &amp;</paramtype></parameter><parameter name=""><paramtype>const std::nothrow_t &amp;</paramtype></parameter><description><para>Returns an instance of a shared pointer constructed with the default allocator and deleter from a pointer of type T that has been allocated in the passed managed segment. Does not throw, return null shared pointer in error. </para></description></function>













</namespace>
</namespace>
</header>
<header name="boost/interprocess/smart_ptr/unique_ptr.hpp">
<para>This header provides utilities to define a unique_ptr that plays nicely with managed segments. </para><namespace name="boost">
<namespace name="interprocess">
<struct name="managed_unique_ptr"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="ManagedMemory"/>
    </template><description><para>Returns the type of a unique pointer of type T with <classname alt="boost::interprocess::deleter">boost::interprocess::deleter</classname> deleter that can be constructed in the given managed segment type. </para></description><typedef name="type"><type>boost::movelib::unique_ptr&lt; T, typename ManagedMemory::template <classname>deleter</classname>&lt; T &gt;::type &gt;</type></typedef>
</struct>























<function name="make_managed_unique_ptr"><type><classname>managed_unique_ptr</classname>&lt; T, ManagedMemory &gt;::type</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="ManagedMemory"/>
        </template><parameter name="constructed_object"><paramtype>T *</paramtype></parameter><parameter name="managed_memory"><paramtype>ManagedMemory &amp;</paramtype></parameter><description><para>Returns an instance of a unique pointer constructed with boost::interproces::deleter from a pointer of type T that has been allocated in the passed managed segment </para></description></function>
























</namespace>
</namespace>
</header>
<header name="boost/interprocess/smart_ptr/weak_ptr.hpp">
<para>Describes the smart pointer weak_ptr. </para><namespace name="boost">
<namespace name="interprocess">
<struct name="managed_weak_ptr"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="ManagedMemory"/>
    </template><description><para>Returns the type of a weak pointer of type T with the allocator <classname alt="boost::interprocess::allocator">boost::interprocess::allocator</classname> allocator and <classname alt="boost::interprocess::deleter">boost::interprocess::deleter</classname> deleter that can be constructed in the given managed segment type. </para></description><typedef name="type"><type><classname>weak_ptr</classname>&lt; T, typename ManagedMemory::template <classname>allocator</classname>&lt; void &gt;::<classname>type</classname>, typename ManagedMemory::template <classname>deleter</classname>&lt; T &gt;::<classname>type</classname> &gt;</type></typedef>
</struct><class name="weak_ptr"><template>
      <template-type-parameter name="T"/>
      <template-type-parameter name="A"/>
      <template-type-parameter name="D"/>
    </template><description><para>The <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> class template stores a "weak reference" to an object that's already managed by a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname>. To access the object, a <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> can be converted to a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> using the <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> constructor or the member function lock. When the last <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> to the object goes away and the object is deleted, the attempt to obtain a <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> from the <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> instances that refer to the deleted object will fail: the constructor will throw an exception of type bad_weak_ptr, and weak_ptr::lock will return an empty <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname>.</para><para>Every <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> meets the CopyConstructible and Assignable requirements of the C++ Standard Library, and so can be used in standard library containers. Comparison operators are supplied so that <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> works with the standard library's associative containers.</para><para><classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> operations never throw exceptions.</para><para>The class template is parameterized on T, the type of the object pointed to. </para></description><typedef name="element_type"><type>T</type></typedef>
<typedef name="value_type"><type>T</type></typedef>
<method-group name="public member functions">
<method name="lock" cv="const"><type><classname>shared_ptr</classname>&lt; T, A, D &gt;</type><description><para>Returns: expired()? shared_ptr&lt;T&gt;(): shared_ptr&lt;T&gt;(*this).</para><para>Throws: nothing. </para></description></method>
<method name="use_count" cv="const"><type>long</type><description><para>Returns: 0 if *this is empty; otherwise, the number of <classname alt="boost::interprocess::shared_ptr">shared_ptr</classname> objects that share ownership with *this.</para><para>Throws: nothing.</para><para>Notes: use_count() is not necessarily efficient. Use only for debugging and testing purposes, not for production code. </para></description></method>
<method name="expired" cv="const"><type>bool</type><description><para>Returns: Returns: use_count() == 0.</para><para>Throws: nothing.</para><para>Notes: expired() may be faster than use_count(). </para></description></method>
<method name="reset"><type>void</type><description><para>Effects: Equivalent to: weak_ptr().swap(*this). </para></description></method>
<method name="swap"><type>void</type><parameter name="other"><paramtype>this_type &amp;</paramtype></parameter><description><para>Effects: Exchanges the contents of the two smart pointers.</para><para>Throws: nothing. </para></description></method>
</method-group>
<constructor><description><para>Effects: Constructs an empty <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname>. Postconditions: use_count() == 0. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="Y"/>
        </template><parameter name="r"><paramtype><classname>weak_ptr</classname>&lt; Y, A, D &gt; const &amp;</paramtype></parameter><description><para>Effects: If r is empty, constructs an empty <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname>; otherwise, constructs a <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> that shares ownership with r as if by storing a copy of the pointer stored in r.</para><para>Postconditions: use_count() == r.use_count().</para><para>Throws: nothing. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="Y"/>
        </template><parameter name="r"><paramtype><classname>shared_ptr</classname>&lt; Y, A, D &gt; const &amp;</paramtype></parameter><description><para>Effects: If r is empty, constructs an empty <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname>; otherwise, constructs a <classname alt="boost::interprocess::weak_ptr">weak_ptr</classname> that shares ownership with r as if by storing a copy of the pointer stored in r.</para><para>Postconditions: use_count() == r.use_count().</para><para>Throws: nothing. </para></description></constructor>
<copy-assignment><type><classname>weak_ptr</classname> &amp;</type><template>
          <template-type-parameter name="Y"/>
        </template><parameter name="r"><paramtype><classname>weak_ptr</classname>&lt; Y, A, D &gt; const &amp;</paramtype></parameter><description><para>Effects: Equivalent to weak_ptr(r).swap(*this).</para><para>Throws: nothing.</para><para>Notes: The implementation is free to meet the effects (and the implied guarantees) via different means, without creating a temporary. </para></description></copy-assignment>
<copy-assignment><type><classname>weak_ptr</classname> &amp;</type><template>
          <template-type-parameter name="Y"/>
        </template><parameter name="r"><paramtype><classname>shared_ptr</classname>&lt; Y, A, D &gt; const &amp;</paramtype></parameter><description><para>Effects: Equivalent to weak_ptr(r).swap(*this).</para><para>Throws: nothing.</para><para>Notes: The implementation is free to meet the effects (and the implied guarantees) via different means, without creating a temporary. </para></description></copy-assignment>
</class>




















<function name="operator&lt;"><type>bool</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="A"/>
          <template-type-parameter name="D"/>
          <template-type-parameter name="U"/>
          <template-type-parameter name="A2"/>
          <template-type-parameter name="D2"/>
        </template><parameter name="a"><paramtype><classname>weak_ptr</classname>&lt; T, A, D &gt; const &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>weak_ptr</classname>&lt; U, A2, D2 &gt; const &amp;</paramtype></parameter></function>
<function name="swap"><type>void</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="A"/>
          <template-type-parameter name="D"/>
        </template><parameter name="a"><paramtype><classname>weak_ptr</classname>&lt; T, A, D &gt; &amp;</paramtype></parameter><parameter name="b"><paramtype><classname>weak_ptr</classname>&lt; T, A, D &gt; &amp;</paramtype></parameter></function>
<function name="make_managed_weak_ptr"><type><classname>managed_weak_ptr</classname>&lt; T, ManagedMemory &gt;::type</type><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="ManagedMemory"/>
        </template><parameter name="constructed_object"><paramtype>T *</paramtype></parameter><parameter name="managed_memory"><paramtype>ManagedMemory &amp;</paramtype></parameter><description><para>Returns an instance of a weak pointer constructed with the default allocator and deleter from a pointer of type T that has been allocated in the passed managed segment </para></description></function>

























</namespace>
</namespace>
</header>
<header name="boost/interprocess/streams/bufferstream.hpp">
<para>This file defines basic_bufferbuf, basic_ibufferstream, basic_obufferstream, and basic_bufferstream classes. These classes represent streamsbufs and streams whose sources or destinations are fixed size character buffers. </para><namespace name="boost">
<namespace name="interprocess">
<class name="basic_bufferbuf"><template>
      <template-type-parameter name="CharT"/>
      <template-type-parameter name="CharTraits"/>
    </template><inherit access="public">std::basic_streambuf&lt; CharT, CharTraits &gt;</inherit><description><para>A streambuf class that controls the transmission of elements to and from a basic_xbufferstream. The elements are transmitted from a to a fixed size buffer </para></description><typedef name="char_type"><type>CharT</type></typedef>
<typedef name="int_type"><type>CharTraits::int_type</type></typedef>
<typedef name="pos_type"><type>CharTraits::pos_type</type></typedef>
<typedef name="off_type"><type>CharTraits::off_type</type></typedef>
<typedef name="traits_type"><type>CharTraits</type></typedef>
<typedef name="basic_streambuf_t"><type>std::basic_streambuf&lt; char_type, traits_type &gt;</type></typedef>
<method-group name="public member functions">
<method name="buffer" cv="const"><type>std::pair&lt; CharT *, std::size_t &gt;</type><description><para>Returns the pointer and size of the internal buffer. Does not throw. </para></description></method>
<method name="buffer"><type>void</type><parameter name="buf"><paramtype>CharT *</paramtype></parameter><parameter name="length"><paramtype>std::size_t</paramtype></parameter><description><para>Sets the underlying buffer to a new value Does not throw. </para></description></method>
</method-group>
<constructor specifiers="explicit"><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in|std::ios_base::out</default></parameter><description><para>Constructor. Does not throw. </para></description></constructor>
<constructor specifiers="explicit"><parameter name="buf"><paramtype>CharT *</paramtype></parameter><parameter name="length"><paramtype>std::size_t</paramtype></parameter><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in|std::ios_base::out</default></parameter><description><para>Constructor. Assigns formatting buffer. Does not throw. </para></description></constructor>
<destructor/>
</class><class name="basic_bufferstream"><template>
      <template-type-parameter name="CharT"/>
      <template-type-parameter name="CharTraits"/>
    </template><inherit access="public">std::basic_iostream&lt; CharT, CharTraits &gt;</inherit><description><para>A basic_iostream class that uses a fixed size character buffer as its formatting buffer. </para></description><typedef name="char_type"><type>std::basic_ios&lt; CharT, CharTraits &gt;::char_type</type></typedef>
<typedef name="int_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::int_type</type></typedef>
<typedef name="pos_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::pos_type</type></typedef>
<typedef name="off_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::off_type</type></typedef>
<typedef name="traits_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::traits_type</type></typedef>
<method-group name="public member functions">
<method name="rdbuf" cv="const"><type><classname>basic_bufferbuf</classname>&lt; CharT, CharTraits &gt; *</type><description><para>Returns the address of the stored stream buffer. </para></description></method>
<method name="buffer" cv="const"><type>std::pair&lt; CharT *, std::size_t &gt;</type><description><para>Returns the pointer and size of the internal buffer. Does not throw. </para></description></method>
<method name="buffer"><type>void</type><parameter name="buf"><paramtype>CharT *</paramtype></parameter><parameter name="length"><paramtype>std::size_t</paramtype></parameter><description><para>Sets the underlying buffer to a new value. Resets stream position. Does not throw. </para></description></method>
</method-group>
<constructor><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in|std::ios_base::out</default></parameter><description><para>Constructor. Does not throw. </para></description></constructor>
<constructor><parameter name="buf"><paramtype>CharT *</paramtype></parameter><parameter name="length"><paramtype>std::size_t</paramtype></parameter><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in|std::ios_base::out</default></parameter><description><para>Constructor. Assigns formatting buffer. Does not throw. </para></description></constructor>
<destructor/>
</class><class name="basic_ibufferstream"><template>
      <template-type-parameter name="CharT"/>
      <template-type-parameter name="CharTraits"/>
    </template><inherit access="public">std::basic_istream&lt; CharT, CharTraits &gt;</inherit><description><para>A basic_istream class that uses a fixed size character buffer as its formatting buffer. </para></description><typedef name="char_type"><type>std::basic_ios&lt; CharT, CharTraits &gt;::char_type</type></typedef>
<typedef name="int_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::int_type</type></typedef>
<typedef name="pos_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::pos_type</type></typedef>
<typedef name="off_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::off_type</type></typedef>
<typedef name="traits_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::traits_type</type></typedef>
<method-group name="public member functions">
<method name="rdbuf" cv="const"><type><classname>basic_bufferbuf</classname>&lt; CharT, CharTraits &gt; *</type><description><para>Returns the address of the stored stream buffer. </para></description></method>
<method name="buffer" cv="const"><type>std::pair&lt; const CharT *, std::size_t &gt;</type><description><para>Returns the pointer and size of the internal buffer. Does not throw. </para></description></method>
<method name="buffer"><type>void</type><parameter name="buf"><paramtype>const CharT *</paramtype></parameter><parameter name="length"><paramtype>std::size_t</paramtype></parameter><description><para>Sets the underlying buffer to a new value. Resets stream position. Does not throw. </para></description></method>
</method-group>
<constructor><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in</default></parameter><description><para>Constructor. Does not throw. </para></description></constructor>
<constructor><parameter name="buf"><paramtype>const CharT *</paramtype></parameter><parameter name="length"><paramtype>std::size_t</paramtype></parameter><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in</default></parameter><description><para>Constructor. Assigns formatting buffer. Does not throw. </para></description></constructor>
<destructor/>
</class><class name="basic_obufferstream"><template>
      <template-type-parameter name="CharT"/>
      <template-type-parameter name="CharTraits"/>
    </template><inherit access="public">std::basic_ostream&lt; CharT, CharTraits &gt;</inherit><description><para>A basic_ostream class that uses a fixed size character buffer as its formatting buffer. </para></description><typedef name="char_type"><type>std::basic_ios&lt; CharT, CharTraits &gt;::char_type</type></typedef>
<typedef name="int_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::int_type</type></typedef>
<typedef name="pos_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::pos_type</type></typedef>
<typedef name="off_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::off_type</type></typedef>
<typedef name="traits_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::traits_type</type></typedef>
<method-group name="public member functions">
<method name="rdbuf" cv="const"><type><classname>basic_bufferbuf</classname>&lt; CharT, CharTraits &gt; *</type><description><para>Returns the address of the stored stream buffer. </para></description></method>
<method name="buffer" cv="const"><type>std::pair&lt; CharT *, std::size_t &gt;</type><description><para>Returns the pointer and size of the internal buffer. Does not throw. </para></description></method>
<method name="buffer"><type>void</type><parameter name="buf"><paramtype>CharT *</paramtype></parameter><parameter name="length"><paramtype>std::size_t</paramtype></parameter><description><para>Sets the underlying buffer to a new value. Resets stream position. Does not throw. </para></description></method>
</method-group>
<constructor><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::out</default></parameter><description><para>Constructor. Does not throw. </para></description></constructor>
<constructor><parameter name="buf"><paramtype>CharT *</paramtype></parameter><parameter name="length"><paramtype>std::size_t</paramtype></parameter><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::out</default></parameter><description><para>Constructor. Assigns formatting buffer. Does not throw. </para></description></constructor>
<destructor/>
</class><typedef name="bufferbuf"><type><classname>basic_bufferbuf</classname>&lt; char &gt;</type></typedef>
<typedef name="bufferstream"><type><classname>basic_bufferstream</classname>&lt; char &gt;</type></typedef>
<typedef name="ibufferstream"><type><classname>basic_ibufferstream</classname>&lt; char &gt;</type></typedef>
<typedef name="obufferstream"><type><classname>basic_obufferstream</classname>&lt; char &gt;</type></typedef>
<typedef name="wbufferbuf"><type><classname>basic_bufferbuf</classname>&lt; wchar_t &gt;</type></typedef>
<typedef name="wbufferstream"><type><classname>basic_bufferstream</classname>&lt; wchar_t &gt;</type></typedef>
<typedef name="wibufferstream"><type><classname>basic_ibufferstream</classname>&lt; wchar_t &gt;</type></typedef>
<typedef name="wobufferstream"><type><classname>basic_obufferstream</classname>&lt; wchar_t &gt;</type></typedef>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/streams/vectorstream.hpp">
<para>This file defines basic_vectorbuf, basic_ivectorstream, basic_ovectorstream, and basic_vectorstreamclasses. These classes represent streamsbufs and streams whose sources or destinations are STL-like vectors that can be swapped with external vectors to avoid unnecessary allocations/copies. </para><namespace name="boost">
<namespace name="interprocess">
<class name="basic_ivectorstream"><template>
      <template-type-parameter name="CharVector"/>
      <template-type-parameter name="CharTraits"/>
    </template><inherit access="public">std::basic_istream&lt; CharVector::value_type, CharTraits &gt;</inherit><description><para>A basic_istream class that holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </para></description><typedef name="vector_type"><type>CharVector</type></typedef>
<typedef name="char_type"><type>std::basic_ios&lt; typename CharVector::value_type, CharTraits &gt;::char_type</type></typedef>
<typedef name="int_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::int_type</type></typedef>
<typedef name="pos_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::pos_type</type></typedef>
<typedef name="off_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::off_type</type></typedef>
<typedef name="traits_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::traits_type</type></typedef>
<method-group name="public member functions">
<method name="rdbuf" cv="const"><type><classname>basic_vectorbuf</classname>&lt; CharVector, CharTraits &gt; *</type><description><para>Returns the address of the stored stream buffer. </para></description></method>
<method name="swap_vector"><type>void</type><parameter name="vect"><paramtype>vector_type &amp;</paramtype></parameter><description><para>Swaps the underlying vector with the passed vector. This function resets the read position in the stream. Does not throw. </para></description></method>
<method name="vector" cv="const"><type>const vector_type &amp;</type><description><para>Returns a const reference to the internal vector. Does not throw. </para></description></method>
<method name="reserve"><type>void</type><parameter name="size"><paramtype>typename vector_type::size_type</paramtype></parameter><description><para>Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws. </para></description></method>
<method name="clear"><type>void</type><description><para>Calls clear() method of the internal vector. Resets the stream to the first position. </para></description></method>
</method-group>
<constructor><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in</default></parameter><description><para>Constructor. Throws if vector_type default constructor throws. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="VectorParameter"/>
        </template><parameter name="param"><paramtype>const VectorParameter &amp;</paramtype></parameter><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in</default></parameter><description><para>Constructor. Throws if vector_type(const VectorParameter &amp;param) throws. </para></description></constructor>
</class><class name="basic_ovectorstream"><template>
      <template-type-parameter name="CharVector"/>
      <template-type-parameter name="CharTraits"/>
    </template><inherit access="public">std::basic_ostream&lt; CharVector::value_type, CharTraits &gt;</inherit><description><para>A basic_ostream class that holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </para></description><typedef name="vector_type"><type>CharVector</type></typedef>
<typedef name="char_type"><type>std::basic_ios&lt; typename CharVector::value_type, CharTraits &gt;::char_type</type></typedef>
<typedef name="int_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::int_type</type></typedef>
<typedef name="pos_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::pos_type</type></typedef>
<typedef name="off_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::off_type</type></typedef>
<typedef name="traits_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::traits_type</type></typedef>
<method-group name="public member functions">
<method name="rdbuf" cv="const"><type><classname>basic_vectorbuf</classname>&lt; CharVector, CharTraits &gt; *</type><description><para>Returns the address of the stored stream buffer. </para></description></method>
<method name="swap_vector"><type>void</type><parameter name="vect"><paramtype>vector_type &amp;</paramtype></parameter><description><para>Swaps the underlying vector with the passed vector. This function resets the write position in the stream. Does not throw. </para></description></method>
<method name="vector" cv="const"><type>const vector_type &amp;</type><description><para>Returns a const reference to the internal vector. Does not throw. </para></description></method>
<method name="reserve"><type>void</type><parameter name="size"><paramtype>typename vector_type::size_type</paramtype></parameter><description><para>Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws. </para></description></method>
</method-group>
<constructor><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::out</default></parameter><description><para>Constructor. Throws if vector_type default constructor throws. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="VectorParameter"/>
        </template><parameter name="param"><paramtype>const VectorParameter &amp;</paramtype></parameter><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::out</default></parameter><description><para>Constructor. Throws if vector_type(const VectorParameter &amp;param) throws. </para></description></constructor>
</class><class name="basic_vectorbuf"><template>
      <template-type-parameter name="CharVector"/>
      <template-type-parameter name="CharTraits"/>
    </template><inherit access="public">std::basic_streambuf&lt; CharVector::value_type, CharTraits &gt;</inherit><description><para>A streambuf class that controls the transmission of elements to and from a <classname alt="boost::interprocess::basic_ivectorstream">basic_ivectorstream</classname>, <classname alt="boost::interprocess::basic_ovectorstream">basic_ovectorstream</classname> or <classname alt="boost::interprocess::basic_vectorstream">basic_vectorstream</classname>. It holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </para></description><typedef name="vector_type"><type>CharVector</type></typedef>
<typedef name="char_type"><type>CharVector::value_type</type></typedef>
<typedef name="int_type"><type>CharTraits::int_type</type></typedef>
<typedef name="pos_type"><type>CharTraits::pos_type</type></typedef>
<typedef name="off_type"><type>CharTraits::off_type</type></typedef>
<typedef name="traits_type"><type>CharTraits</type></typedef>
<method-group name="public member functions">
<method name="swap_vector"><type>void</type><parameter name="vect"><paramtype>vector_type &amp;</paramtype></parameter><description><para>Swaps the underlying vector with the passed vector. This function resets the read/write position in the stream. Does not throw. </para></description></method>
<method name="vector" cv="const"><type>const vector_type &amp;</type><description><para>Returns a const reference to the internal vector. Does not throw. </para></description></method>
<method name="reserve"><type>void</type><parameter name="size"><paramtype>typename vector_type::size_type</paramtype></parameter><description><para>Preallocates memory from the internal vector. Resets the stream to the first position. Throws if the internals vector's memory allocation throws. </para></description></method>
<method name="clear"><type>void</type><description><para>Calls clear() method of the internal vector. Resets the stream to the first position. </para></description></method>
</method-group>
<constructor specifiers="explicit"><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in|std::ios_base::out</default></parameter><description><para>Constructor. Throws if vector_type default constructor throws. </para></description></constructor>
<constructor specifiers="explicit"><template>
          <template-type-parameter name="VectorParameter"/>
        </template><parameter name="param"><paramtype>const VectorParameter &amp;</paramtype></parameter><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in|std::ios_base::out</default></parameter><description><para>Constructor. Throws if vector_type(const VectorParameter &amp;param) throws. </para></description></constructor>
</class><class name="basic_vectorstream"><template>
      <template-type-parameter name="CharVector"/>
      <template-type-parameter name="CharTraits"/>
    </template><inherit access="public">std::basic_iostream&lt; CharVector::value_type, CharTraits &gt;</inherit><description><para>A basic_iostream class that holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </para></description><typedef name="vector_type"><type>CharVector</type></typedef>
<typedef name="char_type"><type>std::basic_ios&lt; typename CharVector::value_type, CharTraits &gt;::char_type</type></typedef>
<typedef name="int_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::int_type</type></typedef>
<typedef name="pos_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::pos_type</type></typedef>
<typedef name="off_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::off_type</type></typedef>
<typedef name="traits_type"><type>std::basic_ios&lt; char_type, CharTraits &gt;::traits_type</type></typedef>
<method-group name="public member functions">
<method name="rdbuf" cv="const"><type><classname>basic_vectorbuf</classname>&lt; CharVector, CharTraits &gt; *</type></method>
<method name="swap_vector"><type>void</type><parameter name="vect"><paramtype>vector_type &amp;</paramtype></parameter><description><para>Swaps the underlying vector with the passed vector. This function resets the read/write position in the stream. Does not throw. </para></description></method>
<method name="vector" cv="const"><type>const vector_type &amp;</type><description><para>Returns a const reference to the internal vector. Does not throw. </para></description></method>
<method name="reserve"><type>void</type><parameter name="size"><paramtype>typename vector_type::size_type</paramtype></parameter><description><para>Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws. </para></description></method>
<method name="clear"><type>void</type><description><para>Calls clear() method of the internal vector. Resets the stream to the first position. </para></description></method>
</method-group>
<constructor><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in|std::ios_base::out</default></parameter><description><para>Constructor. Throws if vector_type default constructor throws. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="VectorParameter"/>
        </template><parameter name="param"><paramtype>const VectorParameter &amp;</paramtype></parameter><parameter name="mode"><paramtype>std::ios_base::openmode</paramtype><default>std::ios_base::in|std::ios_base::out</default></parameter><description><para>Constructor. Throws if vector_type(const VectorParameter &amp;param) throws. </para></description></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/cv_status.hpp">
<namespace name="boost">
<namespace name="interprocess">
















































<function name="BOOST_SCOPED_ENUM_DECLARE_BEGIN"><type/><parameter name=""><paramtype>cv_status</paramtype></parameter></function>
</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/file_lock.hpp">
<para>Describes a class that wraps file locking capabilities. </para><namespace name="boost">
<namespace name="interprocess">
<class name="file_lock"><description><para>A file lock, is a mutual exclusion utility similar to a mutex using a file. A file lock has sharable and exclusive locking capabilities and can be used with <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> and <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> classes. A file lock can't guarantee synchronization between threads of the same process so just use file locks to synchronize threads from different processes. </para></description><method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>file_lock</classname> &amp;</paramtype></parameter><description><para>Swaps two file_locks. Does not throw. </para></description></method>
<method name="lock"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, or sharable ownership of the mutex, it waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive, or sharable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, or sharable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="lock_sharable"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that owns a mutex object calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="lock_shared"><type>void</type><description><para>Same as <computeroutput>lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="try_lock_sharable"><type>bool</type><description><para>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="try_lock_shared"><type>bool</type><description><para>Same as <computeroutput>try_lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="timed_lock_sharable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="try_lock_shared_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_shared_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock_sharable"><type>void</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_shared"><type>void</type><description><para>Same as <computeroutput>unlock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Constructs an empty file mapping. Does not throw </para></description></constructor>
<constructor><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a file lock. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if the file does not exist or there are no operating system resources. </para></description></constructor>
<constructor><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a file lock. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if the file does not exist or there are no operating system resources.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>file_lock</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s file mapping object to *this. After the call, "moved" does not represent any file mapping object. Does not throw </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>file_lock</classname> &amp;</type><parameter name="moved"><paramtype><classname>file_lock</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s file mapping to *this. After the call, "moved" does not represent any file mapping. Does not throw </para></description></copy-assignment>
<destructor><purpose>Closes a file lock. Does not throw. </purpose></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/interprocess_condition.hpp">
<para>Describes process-shared variables interprocess_condition class </para><namespace name="boost">
<namespace name="interprocess">
<class name="interprocess_condition"><description><para>This class is a condition variable that can be placed in shared memory or memory mapped files. Destroys the object of type std::condition_variable_any</para><para>Unlike std::condition_variable in C++11, it is NOT safe to invoke the destructor if all threads have been only notified. It is required that they have exited their respective wait functions. </para></description><method-group name="public member functions">
<method name="notify_one"><type>void</type><description><para>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </para></description></method>
<method name="notify_all"><type>void</type><description><para>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </para></description></method>
<method name="wait"><type>void</type><template>
          <template-type-parameter name="L"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><description><para>Releases the lock on the <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), and then reacquires the lock. </para></description></method>
<method name="wait"><type>void</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>The same as: while (!pred()) wait(lock) </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Releases the lock on the <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </para></description></method>
<method name="wait_until"><type>cv_status</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="wait_until"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="wait_for"><type>cv_status</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Duration"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface and uses relative timeouts. </para></description></method>
<method name="wait_for"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Duration"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface and uses relative timeouts </para></description></method>
</method-group>
<constructor><purpose>Constructs a <classname alt="boost::interprocess::interprocess_condition">interprocess_condition</classname>. On error throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </purpose></constructor>
<destructor><description><para>Destroys *this liberating system resources. </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/interprocess_condition_any.hpp">
<para>Describes process-shared variables interprocess_condition_any class </para><namespace name="boost">
<namespace name="interprocess">
<class name="interprocess_condition_any"><description><para>This class is a condition variable that can be placed in shared memory or memory mapped files.</para><para>The <classname alt="boost::interprocess::interprocess_condition_any">interprocess_condition_any</classname> class is a generalization of <classname alt="boost::interprocess::interprocess_condition">interprocess_condition</classname>. Whereas <classname alt="boost::interprocess::interprocess_condition">interprocess_condition</classname> works only on Locks with mutex_type == <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> <classname alt="boost::interprocess::interprocess_condition_any">interprocess_condition_any</classname> can operate on any user-defined lock that meets the BasicLockable requirements (lock()/unlock() member functions).</para><para>Unlike std::condition_variable_any in C++11, it is NOT safe to invoke the destructor if all threads have been only notified. It is required that they have exited their respective wait functions. </para></description><method-group name="public member functions">
<method name="notify_one"><type>void</type><description><para>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </para></description></method>
<method name="notify_all"><type>void</type><description><para>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </para></description></method>
<method name="wait"><type>void</type><template>
          <template-type-parameter name="L"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><description><para>Releases the lock on the <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), and then reacquires the lock. </para></description></method>
<method name="wait"><type>void</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>The same as: while (!pred()) wait(lock) </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Releases the lock on the <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </para></description></method>
<method name="wait_until"><type>cv_status</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="wait_until"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="wait_for"><type>cv_status</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Duration"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface and uses relative timeouts. </para></description></method>
<method name="wait_for"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Duration"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface and uses relative timeouts </para></description></method>
</method-group>
<constructor><purpose>Constructs a <classname alt="boost::interprocess::interprocess_condition_any">interprocess_condition_any</classname>. On error throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </purpose></constructor>
<destructor><description><para>Destroys *this liberating system resources. </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/interprocess_mutex.hpp">
<para>Describes a mutex class that can be placed in memory shared by several processes. </para><namespace name="boost">
<namespace name="interprocess">
<class name="interprocess_mutex"><description><para>Wraps a <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </para></description><method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex, it waits until it can obtain the ownership. If a thread takes ownership of the mutex the mutex must be unlocked by the same mutex. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex returns immediately. Returns: If the thread acquires ownership of the mutex, returns true, if the another thread has ownership of the mutex, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread will try to obtain exclusive ownership of the mutex if it can do so in until the specified time is reached. If the mutex supports recursive locking, the mutex must be unlocked the same number of times it is locked. Returns: If the thread acquires ownership of the mutex, returns true, if the timeout expires returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock"><type>void</type><description><para>Effects: The calling thread releases the exclusive ownership of the mutex. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
</method-group>
<constructor><description><para>Constructor. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></constructor>
<destructor><description><para>Destructor. If any process uses the mutex after the destructor is called the result is undefined. Does not throw. </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/interprocess_recursive_mutex.hpp">
<para>Describes interprocess_recursive_mutex and shared_recursive_try_mutex classes </para><namespace name="boost">
<namespace name="interprocess">
<class name="interprocess_recursive_mutex"><description><para>Wraps a <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> that can be placed in shared memory and can be shared between processes. Allows several locking calls by the same process. Allows timed lock tries </para></description><method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex, it waits until it can obtain the ownership. If a thread takes ownership of the mutex the mutex must be unlocked by the same mutex. The mutex must be unlocked the same number of times it is locked. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program shall not deadlock if the thread that has ownership calls this function. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Tries to lock the <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname>, returns false when <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> is already locked, returns true when success. The mutex must be unlocked the same number of times it is locked. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if a severe error is found</para><para>Note: A program shall not deadlock if the thread that has ownership calls this function. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Tries to lock the <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname>, if <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> can't be locked before abs_time time, returns false. The mutex must be unlocked the same number of times it is locked. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if a severe error is found</para><para>Note: A program shall not deadlock if the thread that has ownership calls this function. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock"><type>void</type><description><para>Effects: The calling thread releases the exclusive ownership of the mutex. If the mutex supports recursive locking, the mutex must be unlocked the same number of times it is locked. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
</method-group>
<constructor><description><para>Constructor. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></constructor>
<destructor><description><para>Destructor. If any process uses the mutex after the destructor is called the result is undefined. Does not throw. </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/interprocess_semaphore.hpp">
<para>Describes a interprocess_semaphore class for inter-process synchronization </para><namespace name="boost">
<namespace name="interprocess">
<class name="interprocess_semaphore"><description><para>Wraps a <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </para></description><method-group name="public member functions">
<method name="post"><type>void</type><description><para>Increments the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname> count. If there are processes/threads blocked waiting for the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname>, then one of these processes will return successfully from its wait function. If there is an error an <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> exception is thrown. </para></description></method>
<method name="wait"><type>void</type><description><para>Decrements the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname>. If the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname> value is not greater than zero, then the calling process/thread blocks until it can decrement the counter. If there is an error an <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> exception is thrown. </para></description></method>
<method name="try_wait"><type>bool</type><description><para>Decrements the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname> if the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname>'s value is greater than zero and returns true. If the value is not greater than zero returns false. If there is an error an <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> exception is thrown. </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Decrements the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname> if the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname>'s value is greater than zero and returns true. Otherwise, waits for the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname> to the posted or the timeout expires. If the timeout expires, the function returns false. If the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname> is posted the function returns true. If there is an error throws sem_exception </para></description></method>
</method-group>
<constructor><parameter name="initialCount"><paramtype>unsigned int</paramtype></parameter><description><para>Creates a <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname> with the given initial count. <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if there is an error. </para></description></constructor>
<destructor><description><para>Destroys the <classname alt="boost::interprocess::interprocess_semaphore">interprocess_semaphore</classname>. Does not throw </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/interprocess_sharable_mutex.hpp">
<para>Describes interprocess_sharable_mutex class </para><namespace name="boost">
<namespace name="interprocess">
<class name="interprocess_sharable_mutex"><description><para>Wraps a <classname alt="boost::interprocess::interprocess_sharable_mutex">interprocess_sharable_mutex</classname> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </para></description><method-group name="private member functions">
</method-group>
<constructor><parameter name=""><paramtype>const <classname>interprocess_sharable_mutex</classname> &amp;</paramtype></parameter></constructor>
<copy-assignment><type><classname>interprocess_sharable_mutex</classname> &amp;</type><parameter name=""><paramtype>const <classname>interprocess_sharable_mutex</classname> &amp;</paramtype></parameter></copy-assignment>
<method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive or sharable ownership of the mutex, it waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive or sharable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive or sharable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="lock_sharable"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="lock_shared"><type>void</type><description><para>Same as <computeroutput>lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="try_lock_sharable"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_shared"><type>bool</type><description><para>Same as <computeroutput>try_lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="timed_lock_sharable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_shared_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_shared_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock_sharable"><type>void</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_shared"><type>void</type><description><para>Same as <computeroutput>unlock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
</method-group>
<constructor><description><para>Constructs the sharable lock. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></constructor>
<destructor><description><para>Destroys the sharable lock. Does not throw. </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/interprocess_upgradable_mutex.hpp">
<para>Describes interprocess_upgradable_mutex class </para><namespace name="boost">
<namespace name="interprocess">
<class name="interprocess_upgradable_mutex"><description><para>Wraps a <classname alt="boost::interprocess::interprocess_upgradable_mutex">interprocess_upgradable_mutex</classname> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </para></description><method-group name="private member functions">
</method-group>
<constructor><parameter name=""><paramtype>const <classname>interprocess_upgradable_mutex</classname> &amp;</paramtype></parameter></constructor>
<copy-assignment><type><classname>interprocess_upgradable_mutex</classname> &amp;</type><parameter name=""><paramtype>const <classname>interprocess_upgradable_mutex</classname> &amp;</paramtype></parameter></copy-assignment>
<method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, sharable or upgradable ownership of the mutex, it waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive, sharable or upgradable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, sharable or upgradable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="lock_sharable"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="lock_shared"><type>void</type><description><para>Same as <computeroutput>lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="try_lock_sharable"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_shared"><type>bool</type><description><para>Same as <computeroutput>try_lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="timed_lock_sharable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_shared_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_shared_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock_sharable"><type>void</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_shared"><type>void</type><description><para>Same as <computeroutput>unlock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="lock_upgradable"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_upgradable"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting. If no other thread has exclusive or upgradable ownership of the mutex this succeeds. Returns: If it can acquire upgradable ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="timed_lock_upgradable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="unlock_upgradable"><type>void</type><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The calling thread releases the upgradable ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_and_lock_upgradable"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The thread atomically releases exclusive ownership and acquires upgradable ownership. This operation is non-blocking. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_and_lock_sharable"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The thread atomically releases exclusive ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_upgradable_and_lock_sharable"><type>void</type><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_upgradable_and_lock"><type>void</type><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and acquires exclusive ownership. This operation will block until all threads with sharable ownership release their sharable lock. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="try_unlock_upgradable_and_lock"><type>bool</type><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable ownership, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="timed_unlock_upgradable_and_lock"><type>*bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership, waiting if necessary until abs_time. This operation will fail if there are threads with sharable ownership or timeout reaches, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="try_unlock_sharable_and_lock"><type>bool</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The thread atomically releases sharable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="try_unlock_sharable_and_lock_upgradable"><type>bool</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The thread atomically releases sharable ownership and tries to acquire upgradable ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
</method-group>
<constructor><description><para>Constructs the upgradable lock. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></constructor>
<destructor><description><para>Destroys the upgradable lock. Does not throw. </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/lock_options.hpp">
<para>Describes the lock options with associated with interprocess_mutex lock constructors. </para><namespace name="boost">
<namespace name="interprocess">
<struct name="accept_ownership_type"><purpose>Type to indicate to a mutex lock constructor that the mutex is already locked. </purpose></struct><struct name="defer_lock_type"><purpose>Type to indicate to a mutex lock constructor that must not lock the mutex. </purpose></struct><struct name="try_to_lock_type"><purpose>Type to indicate to a mutex lock constructor that must try to lock the mutex. </purpose></struct><data-member name="defer_lock" specifiers="static"><type>const <classname>defer_lock_type</classname></type><description><para>An object indicating that the locking must be deferred. </para></description></data-member>
<data-member name="try_to_lock" specifiers="static"><type>const <classname>try_to_lock_type</classname></type><description><para>An object indicating that a try_lock() operation must be executed. </para></description></data-member>
<data-member name="accept_ownership" specifiers="static"><type>const <classname>accept_ownership_type</classname></type><description><para>An object indicating that the ownership of lockable object must be accepted by the new owner. </para></description></data-member>

















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/mutex_family.hpp">
<para>Describes a shared interprocess_mutex family fit algorithm used to allocate objects in shared memory. </para><namespace name="boost">
<namespace name="interprocess">
<struct name="mutex_family"><description><para>Describes <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> family to use with Interprocess framework based on boost::interprocess synchronization objects. </para></description><typedef name="mutex_type"><type><classname>boost::interprocess::interprocess_mutex</classname></type></typedef>
<typedef name="recursive_mutex_type"><type><classname>boost::interprocess::interprocess_recursive_mutex</classname></type></typedef>
</struct><struct name="null_mutex_family"><description><para>Describes <classname alt="boost::interprocess::interprocess_mutex">interprocess_mutex</classname> family to use with Interprocess frameworks based on null operation synchronization objects. </para></description><typedef name="mutex_type"><type><classname>boost::interprocess::null_mutex</classname></type></typedef>
<typedef name="recursive_mutex_type"><type><classname>boost::interprocess::null_mutex</classname></type></typedef>
</struct>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/named_condition.hpp">
<para>Describes a named condition class for inter-process synchronization </para><namespace name="boost">
<namespace name="interprocess">
<class name="named_condition"><description><para>A global condition variable that can be created by name. This condition variable is designed to work with <classname alt="boost::interprocess::named_mutex">named_mutex</classname> and can't be placed in shared memory or memory mapped files. </para></description><method-group name="public member functions">
<method name="notify_one"><type>*void</type><description><para>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </para></description></method>
<method name="notify_all"><type>void</type><description><para>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </para></description></method>
<method name="wait"><type>void</type><template>
          <template-type-parameter name="L"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><description><para>Releases the lock on the <classname alt="boost::interprocess::named_mutex">named_mutex</classname> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), and then reacquires the lock. </para></description></method>
<method name="wait"><type>void</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>The same as: while (!pred()) wait(lock) </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Releases the lock on the <classname alt="boost::interprocess::named_mutex">named_mutex</classname> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </para></description></method>
<method name="wait_until"><type>cv_status</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="wait_until"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="wait_for"><type>cv_status</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Duration"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface and uses relative timeouts. </para></description></method>
<method name="wait_for"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Duration"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface and uses relative timeouts </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global condition with a name. If the condition can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global condition with a name. If the condition is created, this call is equivalent to named_condition(create_only_t, ... ) If the condition is already created, this call is equivalent named_condition(open_only_t, ... ) Does not throw </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a global condition with a name if that condition is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens a global condition with a name if that condition is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. Creates a global condition with a name. If the condition can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname></para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global condition with a name. If the condition is created, this call is equivalent to named_condition(create_only_t, ... ) If the condition is already created, this call is equivalent named_condition(open_only_t, ... ) Does not throw</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a global condition with a name if that condition is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Erases a named condition from the system. Returns false on error. Never throws. </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Erases a named condition from the system. Returns false on error. Never throws.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/named_condition_any.hpp">
<para>Describes a named condition class for inter-process synchronization </para><namespace name="boost">
<namespace name="interprocess">
<class name="named_condition_any"><description><para>A global condition variable that can be created by name. This condition variable is designed to work with <classname alt="boost::interprocess::named_mutex">named_mutex</classname> and can't be placed in shared memory or memory mapped files. </para></description><method-group name="public member functions">
<method name="notify_one"><type>*void</type><description><para>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </para></description></method>
<method name="notify_all"><type>void</type><description><para>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </para></description></method>
<method name="wait"><type>void</type><template>
          <template-type-parameter name="L"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><description><para>Releases the lock on the <classname alt="boost::interprocess::named_mutex">named_mutex</classname> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), and then reacquires the lock. </para></description></method>
<method name="wait"><type>void</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>The same as: while (!pred()) wait(lock) </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Releases the lock on the <classname alt="boost::interprocess::named_mutex">named_mutex</classname> object associated with lock, blocks the current thread of execution until readied by a call to this-&gt;notify_one() or this-&gt;notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </para></description></method>
<method name="wait_until"><type>cv_status</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="wait_until"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="TimePoint"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="wait_for"><type>cv_status</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Duration"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface and uses relative timeouts. </para></description></method>
<method name="wait_for"><type>bool</type><template>
          <template-type-parameter name="L"/>
          <template-type-parameter name="Duration"/>
          <template-type-parameter name="Pr"/>
        </template><parameter name="lock"><paramtype>L &amp;</paramtype></parameter><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><parameter name="pred"><paramtype>Pr</paramtype></parameter><description><para>Same as <computeroutput>timed_wait</computeroutput>, but this function is modeled after the standard library interface and uses relative timeouts </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global condition with a name. If the condition can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global condition with a name. If the condition is created, this call is equivalent to named_condition_any(create_only_t, ... ) If the condition is already created, this call is equivalent named_condition_any(open_only_t, ... ) Does not throw </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a global condition with a name if that condition is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global condition with a name. If the condition can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname></para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global condition with a name. If the condition is created, this call is equivalent to named_condition_any(create_only_t, ... ) If the condition is already created, this call is equivalent named_condition_any(open_only_t, ... ) Does not throw</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a global condition with a name if that condition is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Erases a named condition from the system. Returns false on error. Never throws. </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Erases a named condition from the system. Returns false on error. Never throws.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/named_mutex.hpp">
<para>Describes a named mutex class for inter-process synchronization </para><namespace name="boost">
<namespace name="interprocess">
<class name="named_mutex"><description><para>A mutex with a global name, so it can be found from different processes. This mutex can't be placed in shared memory, and each process should have it's own <classname alt="boost::interprocess::named_mutex">named_mutex</classname>. </para></description><method-group name="public member functions">
<method name="unlock"><type>void</type><description><para>Unlocks a previously locked mutex. </para></description></method>
<method name="lock"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Locks the mutex, sleeps when the mutex is already locked. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if a severe error is found</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Tries to lock the mutex, returns false when the mutex is already locked, returns true when success. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if a severe error is found</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Tries to lock the the mutex until time abs_time, Returns false when timeout expires, returns true when locks. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if a severe error is found</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global mutex with a name. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global mutex with a name. If the mutex is created, this call is equivalent to named_mutex(create_only_t, ... ) If the mutex is already created, this call is equivalent named_mutex(open_only_t, ... ) Does not throw </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a global mutex with a name if that mutex is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global mutex with a name. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global mutex with a name. If the mutex is created, this call is equivalent to named_mutex(create_only_t, ... ) If the mutex is already created, this call is equivalent named_mutex(open_only_t, ... ) Does not throw</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a global mutex with a name if that mutex is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Erases a named mutex from the system. Returns false on error. Never throws. </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Erases a named mutex from the system. Returns false on error. Never throws.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/named_recursive_mutex.hpp">
<para>Describes a named named_recursive_mutex class for inter-process synchronization </para><namespace name="boost">
<namespace name="interprocess">
<class name="named_recursive_mutex"><description><para>A recursive mutex with a global name, so it can be found from different processes. This mutex can't be placed in shared memory, and each process should have it's own <classname alt="boost::interprocess::named_recursive_mutex">named_recursive_mutex</classname>. </para></description><method-group name="public member functions">
<method name="unlock"><type>void</type><description><para>Unlocks a previously locked <classname alt="boost::interprocess::named_recursive_mutex">named_recursive_mutex</classname>. </para></description></method>
<method name="lock"><type>void</type><description><para>Locks <classname alt="boost::interprocess::named_recursive_mutex">named_recursive_mutex</classname>, sleeps when <classname alt="boost::interprocess::named_recursive_mutex">named_recursive_mutex</classname> is already locked. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if a severe error is found.</para><para>Note: A program shall not deadlock if the thread that has ownership calls this function. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Tries to lock the <classname alt="boost::interprocess::named_recursive_mutex">named_recursive_mutex</classname>, returns false when <classname alt="boost::interprocess::named_recursive_mutex">named_recursive_mutex</classname> is already locked, returns true when success. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if a severe error is found.</para><para>Note: A program shall not deadlock if the thread that has ownership calls this function. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Tries to lock the <classname alt="boost::interprocess::named_recursive_mutex">named_recursive_mutex</classname> until time abs_time, Returns false when timeout expires, returns true when locks. Throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> if a severe error is found</para><para>Note: A program shall not deadlock if the thread that has ownership calls this function. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global recursive_mutex with a name. If the recursive_mutex can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global recursive_mutex with a name. If the recursive_mutex is created, this call is equivalent to named_recursive_mutex(create_only_t, ... ) If the recursive_mutex is already created, this call is equivalent named_recursive_mutex(open_only_t, ... ) Does not throw </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a global recursive_mutex with a name if that recursive_mutex is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global recursive_mutex with a name. If the recursive_mutex can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname></para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global recursive_mutex with a name. If the recursive_mutex is created, this call is equivalent to named_recursive_mutex(create_only_t, ... ) If the recursive_mutex is already created, this call is equivalent named_recursive_mutex(open_only_t, ... ) Does not throw</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a global recursive_mutex with a name if that recursive_mutex is previously created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Erases a named recursive mutex from the system </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Erases a named recursive mutex from the system</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/named_semaphore.hpp">
<para>Describes a named semaphore class for inter-process synchronization </para><namespace name="boost">
<namespace name="interprocess">
<class name="named_semaphore"><description><para>A semaphore with a global name, so it can be found from different processes. Allows several resource sharing patterns and efficient acknowledgment mechanisms. </para></description><method-group name="public member functions">
<method name="post"><type>void</type><description><para>Increments the semaphore count. If there are processes/threads blocked waiting for the semaphore, then one of these processes will return successfully from its wait function. If there is an error an <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> exception is thrown. </para></description></method>
<method name="wait"><type>void</type><description><para>Decrements the semaphore. If the semaphore value is not greater than zero, then the calling process/thread blocks until it can decrement the counter. If there is an error an <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> exception is thrown. </para></description></method>
<method name="try_wait"><type>bool</type><description><para>Decrements the semaphore if the semaphore's value is greater than zero and returns true. If the value is not greater than zero returns false. If there is an error an <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> exception is thrown. </para></description></method>
<method name="timed_wait"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Decrements the semaphore if the semaphore's value is greater than zero and returns true. Otherwise, waits for the semaphore to the posted or the timeout expires. If the timeout expires, the function returns false. If the semaphore is posted the function returns true. If there is an error throws sem_exception </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="initialCount"><paramtype>unsigned int</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global semaphore with a name, and an initial count. If the semaphore can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="initialCount"><paramtype>unsigned int</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global semaphore with a name, and an initial count. If the semaphore is created, this call is equivalent to named_semaphore(create_only_t, ...) If the semaphore is already created, this call is equivalent to named_semaphore(open_only_t, ... ) and initialCount is ignored. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a global semaphore with a name if that semaphore is previously. created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="initialCount"><paramtype>unsigned int</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global semaphore with a name, and an initial count. If the semaphore can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname></para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="initialCount"><paramtype>unsigned int</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global semaphore with a name, and an initial count. If the semaphore is created, this call is equivalent to named_semaphore(create_only_t, ...) If the semaphore is already created, this call is equivalent to named_semaphore(open_only_t, ... ) and initialCount is ignored.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a global semaphore with a name if that semaphore is previously. created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Erases a named semaphore from the system. Returns false on error. Never throws. </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Erases a named semaphore from the system. Returns false on error. Never throws.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/named_sharable_mutex.hpp">
<para>Describes a named sharable mutex class for inter-process synchronization </para><namespace name="boost">
<namespace name="interprocess">
<class name="named_sharable_mutex"><description><para>A sharable mutex with a global name, so it can be found from different processes. This mutex can't be placed in shared memory, and each process should have it's own named sharable mutex. </para></description><method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive or sharable ownership of the mutex, it waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive or sharable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, or sharable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="lock_sharable"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="lock_shared"><type>void</type><description><para>Same as <computeroutput>lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="try_lock_sharable"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="try_lock_shared"><type>bool</type><description><para>Same as <computeroutput>try_lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="timed_lock_sharable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="try_lock_shared_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_shared_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock_sharable"><type>void</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_shared"><type>void</type><description><para>Same as <computeroutput>unlock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global sharable mutex with a name. If the sharable mutex can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global sharable mutex with a name. If the sharable mutex is created, this call is equivalent to named_sharable_mutex(create_only_t, ...) If the sharable mutex is already created, this call is equivalent to named_sharable_mutex(open_only_t, ... ). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a global sharable mutex with a name if that sharable mutex is previously. created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global sharable mutex with a name. If the sharable mutex can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname></para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global sharable mutex with a name. If the sharable mutex is created, this call is equivalent to named_sharable_mutex(create_only_t, ...) If the sharable mutex is already created, this call is equivalent to named_sharable_mutex(open_only_t, ... ).</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a global sharable mutex with a name if that sharable mutex is previously. created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Erases a named sharable mutex from the system. Returns false on error. Never throws. </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Erases a named sharable mutex from the system. Returns false on error. Never throws. </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/named_upgradable_mutex.hpp">
<para>Describes a named upgradable mutex class for inter-process synchronization </para><namespace name="boost">
<namespace name="interprocess">
<class name="named_upgradable_mutex"><description><para>A upgradable mutex with a global name, so it can be found from different processes. This mutex can't be placed in shared memory, and each process should have it's own named upgradable mutex. </para></description><method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, sharable or upgradable ownership of the mutex, it waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive, sharable or upgradable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, sharable or upgradable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="lock_sharable"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="lock_shared"><type>void</type><description><para>Same as <computeroutput>lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="try_lock_sharable"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="try_lock_shared"><type>bool</type><description><para>Same as <computeroutput>try_lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="timed_lock_sharable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="try_lock_shared_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_shared_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock_sharable</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock_sharable"><type>void</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_shared"><type>void</type><description><para>Same as <computeroutput>unlock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="lock_upgradable"><type>void</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="try_lock_upgradable"><type>bool</type><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting. If no other thread has exclusive or upgradable ownership of the mutex this succeeds. Returns: If it can acquire upgradable ownership immediately returns true. If it has to wait, returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="timed_lock_upgradable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Requires: The calling thread does not own the mutex.</para><para>Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error.</para><para>Note: A program may deadlock if the thread that has ownership calls this function. If the implementation can detect the deadlock, an exception could be thrown </para></description></method>
<method name="unlock_upgradable"><type>void</type><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The calling thread releases the upgradable ownership of the mutex. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_and_lock_upgradable"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The thread atomically releases exclusive ownership and acquires upgradable ownership. This operation is non-blocking. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_and_lock_sharable"><type>void</type><description><para>Precondition: The thread must have exclusive ownership of the mutex. Effects: The thread atomically releases exclusive ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_upgradable_and_lock_sharable"><type>void</type><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="unlock_upgradable_and_lock"><type>void</type><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and acquires exclusive ownership. This operation will block until all threads with sharable ownership release it. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="try_unlock_upgradable_and_lock"><type>bool</type><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable ownership, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="timed_unlock_upgradable_and_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership, waiting if necessary until abs_time. This operation will fail if there are threads with sharable ownership or timeout reaches, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="try_unlock_sharable_and_lock"><type>bool</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The thread atomically releases sharable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
<method name="try_unlock_sharable_and_lock_upgradable"><type>bool</type><description><para>Precondition: The thread must have sharable ownership of the mutex. Effects: The thread atomically releases sharable ownership and tries to acquire upgradable ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: An exception derived from <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> on error. </para></description></method>
</method-group>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global upgradable mutex with a name. If the upgradable mutex can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname> </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global upgradable mutex with a name. If the upgradable mutex is created, this call is equivalent to named_upgradable_mutex(create_only_t, ...) If the upgradable mutex is already created, this call is equivalent to named_upgradable_mutex(open_only_t, ... ). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Opens a global upgradable mutex with a name if that upgradable mutex is previously. created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a global upgradable mutex with a name. If the upgradable mutex can't be created throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname></para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens or creates a global upgradable mutex with a name. If the upgradable mutex is created, this call is equivalent to named_upgradable_mutex(create_only_t, ...) If the upgradable mutex is already created, this call is equivalent to named_upgradable_mutex(open_only_t, ... ).</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Opens a global upgradable mutex with a name if that upgradable mutex is previously. created. If it is not previously created this function throws <classname alt="boost::interprocess::interprocess_exception">interprocess_exception</classname>.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></constructor>
<destructor><description><para>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const char *</paramtype></parameter><description><para>Erases a named upgradable mutex from the system. Returns false on error. Never throws. </para></description></method>
<method name="remove" specifiers="static"><type>bool</type><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><description><para>Erases a named upgradable mutex from the system. Returns false on error. Never throws.</para><para>Note: This function is only available on operating systems with native wchar_t APIs (e.g. Windows). </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/null_mutex.hpp">
<para>Describes null_mutex classes </para><namespace name="boost">
<namespace name="interprocess">
<class name="null_mutex"><description><para>Implements a mutex that simulates a mutex without doing any operation and simulates a successful operation. </para></description><method-group name="public member functions">
<method name="lock"><type>void</type><purpose>Simulates a mutex lock() operation. Empty function. </purpose></method>
<method name="try_lock"><type>bool</type><description><para>Simulates a mutex try_lock() operation. Equivalent to "return true;" </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name=""><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Simulates a mutex timed_lock() operation. Equivalent to "return true;" </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name=""><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name=""><paramtype>const Duration &amp;</paramtype></parameter><description><para>Same as <computeroutput>timed_lock</computeroutput>, but this function is modeled after the standard library interface. </para></description></method>
<method name="unlock"><type>void</type><description><para>Simulates a mutex unlock() operation. Empty function. </para></description></method>
<method name="lock_sharable"><type>void</type><description><para>Simulates a mutex lock_sharable() operation. Empty function. </para></description></method>
<method name="lock_shared"><type>void</type><description><para>Same as <computeroutput>lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="try_lock_sharable"><type>bool</type><description><para>Simulates a mutex try_lock_sharable() operation. Equivalent to "return true;" </para></description></method>
<method name="try_lock_shared"><type>bool</type><description><para>Same as <computeroutput>try_lock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="timed_lock_sharable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name=""><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Simulates a mutex timed_lock_sharable() operation. Equivalent to "return true;" </para></description></method>
<method name="unlock_sharable"><type>void</type><description><para>Simulates a mutex unlock_sharable() operation. Empty function. </para></description></method>
<method name="unlock_shared"><type>void</type><description><para>Same as <computeroutput>unlock_sharable</computeroutput> but with a std-compatible interface </para></description></method>
<method name="lock_upgradable"><type>void</type><description><para>Simulates a mutex lock_upgradable() operation. Empty function. </para></description></method>
<method name="try_lock_upgradable"><type>bool</type><description><para>Simulates a mutex try_lock_upgradable() operation. Equivalent to "return true;" </para></description></method>
<method name="timed_lock_upgradable"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name=""><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Simulates a mutex timed_lock_upgradable() operation. Equivalent to "return true;" </para></description></method>
<method name="unlock_upgradable"><type>void</type><description><para>Simulates a mutex unlock_upgradable() operation. Empty function. </para></description></method>
<method name="unlock_and_lock_upgradable"><type>void</type><description><para>Simulates unlock_and_lock_upgradable(). Empty function. </para></description></method>
<method name="unlock_and_lock_sharable"><type>void</type><description><para>Simulates unlock_and_lock_sharable(). Empty function. </para></description></method>
<method name="unlock_upgradable_and_lock_sharable"><type>void</type><description><para>Simulates unlock_upgradable_and_lock_sharable(). Empty function. </para></description></method>
<method name="unlock_upgradable_and_lock"><type>void</type><description><para>Simulates unlock_upgradable_and_lock(). Empty function. </para></description></method>
<method name="try_unlock_upgradable_and_lock"><type>bool</type><description><para>Simulates try_unlock_upgradable_and_lock(). Equivalent to "return true;" </para></description></method>
<method name="timed_unlock_upgradable_and_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name=""><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Simulates timed_unlock_upgradable_and_lock(). Equivalent to "return true;" </para></description></method>
<method name="try_unlock_sharable_and_lock"><type>bool</type><description><para>Simulates try_unlock_sharable_and_lock(). Equivalent to "return true;" </para></description></method>
<method name="try_unlock_sharable_and_lock_upgradable"><type>bool</type><description><para>Simulates try_unlock_sharable_and_lock_upgradable(). Equivalent to "return true;" </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Constructor. Empty. </para></description></constructor>
<destructor><description><para>Destructor. Empty. </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/scoped_lock.hpp">
<para>Describes the scoped_lock class. </para><namespace name="boost">
<namespace name="interprocess">
<class name="scoped_lock"><template>
      <template-type-parameter name="Mutex"/>
    </template><description><para><classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> is meant to carry out the tasks for locking, unlocking, try-locking and timed-locking (recursive or not) for the Mutex. The Mutex need not supply all of this functionality. If the client of scoped_lock&lt;Mutex&gt; does not use functionality which the Mutex does not supply, no harm is done. Mutex ownership transfer is supported through the syntax of move semantics. Ownership transfer is allowed both by construction and assignment. The <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> does not support copy semantics. A compile time error results if copy construction or copy assignment is attempted. Mutex ownership can also be moved from an <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> and <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> via constructor. In this role, <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> shares the same functionality as a write_lock. </para></description><typedef name="mutex_type"><type>Mutex</type></typedef>
<method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls lock() on the referenced mutex. Postconditions: owns() == true. Notes: The <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> changes from a state of not owning the mutex, to owning the mutex, blocking if necessary. </para></description></method>
<method name="try_lock"><type>*bool</type><description><para>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock() on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt;try_lock(). Notes: The <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if blocking was not required. If the mutex_type does not support try_lock(), this function will fail at compile time if instantiated, but otherwise have no effect. </para></description></method>
<method name="timed_lock"><type>*bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls timed_lock(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt; timed_lock(abs_time). Notes: The <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership by the specified time. If the mutex_type does not support timed_lock (), this function will fail at compile time if instantiated, but otherwise have no effect. </para></description></method>
<method name="try_lock_until"><type>*bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock_until(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt; timed_lock(abs_time). Notes: The <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership by the specified time. If the mutex_type does not support timed_lock (), this function will fail at compile time if instantiated, but otherwise have no effect. </para></description></method>
<method name="try_lock_for"><type>*bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock_until(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt; timed_lock(abs_time). Notes: The <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership by the specified time. If the mutex_type does not support timed_lock (), this function will fail at compile time if instantiated, but otherwise have no effect. </para></description></method>
<method name="unlock"><type>*void</type><description><para>Effects: If mutex() == 0 or if not locked, throws a lock_exception() exception. Calls unlock() on the referenced mutex. Postconditions: owns() == false. Notes: The <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> changes from a state of owning the mutex, to not owning the mutex. </para></description></method>
<method name="owns" cv="const noexcept"><type>bool</type><description><para>Effects: Returns true if this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> has acquired the referenced mutex. </para></description></method>
<method name="conversion-operator" cv="const noexcept"><type>unspecified_bool_type</type><description><para>Conversion to bool. Returns owns(). </para></description></method>
<method name="mutex" cv="const noexcept"><type>mutex_type *</type><description><para>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. </para></description></method>
<method name="release" cv="noexcept"><type>mutex_type *</type><description><para>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. Postconditions: mutex() == 0 and owns() == false. </para></description></method>
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>scoped_lock</classname>&lt; mutex_type &gt; &amp;</paramtype></parameter><description><para>Effects: Swaps state with moved lock. Throws: Nothing. </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Effects: Default constructs a <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname>. Postconditions: owns() == false and mutex() == 0. </para></description></constructor>
<constructor specifiers="explicit"><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><description><para>Effects: m.lock(). Postconditions: owns() == true and mutex() == &amp;m. Notes: The constructor will take ownership of the mutex. If another thread already owns the mutex, this thread will block until the mutex is released. Whether or not this constructor handles recursive locking depends upon the mutex. </para></description></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>defer_lock_type</classname></paramtype></parameter><description><para>Postconditions: owns() == false, and mutex() == &amp;m. Notes: The constructor will not take ownership of the mutex. There is no effect required on the referenced mutex. </para></description></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>accept_ownership_type</classname></paramtype></parameter><description><para>Postconditions: owns() == true, and mutex() == &amp;m. Notes: The constructor will suppose that the mutex is already locked. There is no effect required on the referenced mutex. </para></description></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>try_to_lock_type</classname></paramtype></parameter><description><para>Effects: m.try_lock(). Postconditions: mutex() == &amp;m. owns() == the return value of the m.try_lock() executed within the constructor. Notes: The constructor will take ownership of the mutex if it can do so without waiting. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock, this constructor will fail at compile time if instantiated, but otherwise have no effect. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: m.timed_lock(abs_time). Postconditions: mutex() == &amp;m. owns() == the return value of the m.timed_lock(abs_time) executed within the constructor. Notes: The constructor will take ownership of the mutex if it can do it until abs_time is reached. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock, this constructor will fail at compile time if instantiated, but otherwise have no effect. </para></description></constructor>
<constructor cv="noexcept"><parameter name="scop"><paramtype><classname>scoped_lock</classname> &amp;&amp;</paramtype></parameter><description><para>Postconditions: mutex() == the value scop.mutex() had before the constructor executes. s1.mutex() == 0. owns() == the value of scop.owns() before the constructor executes. scop.owns(). Notes: If the scop <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> owns the mutex, ownership is moved to thisscoped_lock with no blocking. If the scop <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> does not own the mutex, then neither will this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname>. Only a moved <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname>'s will match this signature. An non-moved <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> can be moved with the expression: "boost::move(lock);". This constructor does not alter the state of the mutex, only potentially who owns it. </para></description></constructor>
<constructor specifiers="explicit"><template>
          <template-type-parameter name="T"/>
        </template><parameter name="upgr"><paramtype><classname>upgradable_lock</classname>&lt; T &gt; &amp;&amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Effects: If upgr.owns() then calls unlock_upgradable_and_lock() on the referenced mutex. upgr.release() is called. Postconditions: mutex() == the value upgr.mutex() had before the construction. upgr.mutex() == 0. owns() == upgr.owns() before the construction. upgr.owns() == false after the construction. Notes: If upgr is locked, this constructor will lock this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> while unlocking upgr. If upgr is unlocked, then this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> will be unlocked as well. Only a moved <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname>'s will match this signature. An non-moved <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> can be moved with the expression: "boost::move(lock);" This constructor may block if other threads hold a <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> on this mutex (<classname alt="boost::interprocess::sharable_lock">sharable_lock</classname>'s can share ownership with an <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname>). </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T"/>
        </template><parameter name="upgr"><paramtype><classname>upgradable_lock</classname>&lt; T &gt; &amp;&amp;</paramtype></parameter><parameter name=""><paramtype><classname>try_to_lock_type</classname></paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Effects: If upgr.owns() then calls try_unlock_upgradable_and_lock() on the referenced mutex: a)if try_unlock_upgradable_and_lock() returns true then mutex() obtains the value from upgr.release() and owns() is set to true. b)if try_unlock_upgradable_and_lock() returns false then upgr is unaffected and this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> construction as the same effects as a default construction. c)Else upgr.owns() is false. mutex() obtains the value from upgr.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from upgr immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T"/>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="upgr"><paramtype><classname>upgradable_lock</classname>&lt; T &gt; &amp;&amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Effects: If upgr.owns() then calls timed_unlock_upgradable_and_lock(abs_time) on the referenced mutex: a)if timed_unlock_upgradable_and_lock(abs_time) returns true then mutex() obtains the value from upgr.release() and owns() is set to true. b)if timed_unlock_upgradable_and_lock(abs_time) returns false then upgr is unaffected and this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> construction as the same effects as a default construction. c)Else upgr.owns() is false. mutex() obtains the value from upgr.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from upgr immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T"/>
        </template><parameter name="shar"><paramtype><classname>sharable_lock</classname>&lt; T &gt; &amp;&amp;</paramtype></parameter><parameter name=""><paramtype><classname>try_to_lock_type</classname></paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Effects: If shar.owns() then calls try_unlock_sharable_and_lock() on the referenced mutex. a)if try_unlock_sharable_and_lock() returns true then mutex() obtains the value from shar.release() and owns() is set to true. b)if try_unlock_sharable_and_lock() returns false then shar is unaffected and this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> construction has the same effects as a default construction. c)Else shar.owns() is false. mutex() obtains the value from shar.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from shar immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner. </para></description></constructor>
<destructor><description><para>Effects: if (owns()) mp_mutex-&gt;unlock(). Notes: The destructor behavior ensures that the mutex lock is not leaked. </para></description></destructor>
<copy-assignment><type><classname>scoped_lock</classname> &amp;</type><parameter name="scop"><paramtype><classname>scoped_lock</classname> &amp;&amp;</paramtype></parameter><description><para>Effects: If owns() before the call, then unlock() is called on mutex(). *this gets the state of scop and scop gets set to a default constructed state. Notes: With a recursive mutex it is possible that both this and scop own the same mutex before the assignment. In this case, this will own the mutex after the assignment (and scop will not), but the mutex's lock count will be decremented by one. </para></description></copy-assignment>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/sharable_lock.hpp">
<para>Describes the upgradable_lock class that serves to acquire the upgradable lock of a mutex. </para><namespace name="boost">
<namespace name="interprocess">
<class name="sharable_lock"><template>
      <template-type-parameter name="SharableMutex"/>
    </template><description><para><classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> is meant to carry out the tasks for sharable-locking (such as read-locking), unlocking, try-sharable-locking and timed-sharable-locking (recursive or not) for the Mutex. The Mutex need not supply all of this functionality. If the client of sharable_lock&lt;Mutex&gt; does not use functionality which the Mutex does not supply, no harm is done. Mutex ownership can be shared among sharable_locks, and a single <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname>. <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> does not support copy semantics. But <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> supports ownership transfer from an <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname>, <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> and <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> via transfer_lock syntax. </para></description><typedef name="mutex_type"><type>SharableMutex</type></typedef>
<method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Effects: If mutex() == 0 or already locked, throws a lock_exception() exception. Calls lock_sharable() on the referenced mutex. Postconditions: owns() == true. Notes: The <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> changes from a state of not owning the mutex, to owning the mutex, blocking if necessary. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Effects: If mutex() == 0 or already locked, throws a lock_exception() exception. Calls try_lock_sharable() on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt;try_lock_sharable(). Notes: The <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if blocking was not required. If the mutex_type does not support try_lock_sharable(), this function will fail at compile time if instantiated, but otherwise have no effect. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: If mutex() == 0 or already locked, throws a lock_exception() exception. Calls timed_lock_sharable(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt;timed_lock_sharable(elps_time). Notes: The <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership within the specified time interval. If the mutex_type does not support timed_lock_sharable(), this function will fail at compile time if instantiated, but otherwise have no effect. </para></description></method>
<method name="try_lock_until"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: If mutex() == 0 or already locked, throws a lock_exception() exception. Calls try_lock_shared_until(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt;timed_lock_sharable(elps_time). Notes: The <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership within the specified time interval. If the mutex_type does not support timed_lock_sharable(), this function will fail at compile time if instantiated, but otherwise have no effect.</para><para>Note: Similar to timed_lock, but with a std-like interface </para></description></method>
<method name="try_lock_for"><type>bool</type><template>
          <template-type-parameter name="Duration"/>
        </template><parameter name="dur"><paramtype>const Duration &amp;</paramtype></parameter><description><para>Effects: If mutex() == 0 or already locked, throws a lock_exception() exception. Calls try_lock_shared_until(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt;timed_lock_sharable(elps_time). Notes: The <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership within the specified time interval. If the mutex_type does not support timed_lock_sharable(), this function will fail at compile time if instantiated, but otherwise have no effect.</para><para>Note: Similar to timed_lock, but with a std-like interface </para></description></method>
<method name="unlock"><type>void</type><description><para>Effects: If mutex() == 0 or not locked, throws a lock_exception() exception. Calls unlock_sharable() on the referenced mutex. Postconditions: owns() == false. Notes: The <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> changes from a state of owning the mutex, to not owning the mutex. </para></description></method>
<method name="owns" cv="const noexcept"><type>bool</type><description><para>Effects: Returns true if this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> has acquired the referenced mutex. </para></description></method>
<method name="conversion-operator" cv="const noexcept"><type>unspecified_bool_type</type><description><para>Conversion to bool. Returns owns(). </para></description></method>
<method name="mutex" cv="const noexcept"><type>mutex_type *</type><description><para>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. </para></description></method>
<method name="release" cv="noexcept"><type>mutex_type *</type><description><para>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. Postconditions: mutex() == 0 and owns() == false. </para></description></method>
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>sharable_lock</classname>&lt; mutex_type &gt; &amp;</paramtype></parameter><description><para>Effects: Swaps state with moved lock. Throws: Nothing. </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Effects: Default constructs a <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname>. Postconditions: owns() == false and mutex() == 0. </para></description></constructor>
<constructor specifiers="explicit"><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><description><para>Effects: m.lock_sharable(). Postconditions: owns() == true and mutex() == &amp;m. Notes: The constructor will take sharable-ownership of the mutex. If another thread already owns the mutex with exclusive ownership (<classname alt="boost::interprocess::scoped_lock">scoped_lock</classname>), this thread will block until the mutex is released. If another thread owns the mutex with sharable or upgradable ownership, then no blocking will occur. Whether or not this constructor handles recursive locking depends upon the mutex. </para></description></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>defer_lock_type</classname></paramtype></parameter><description><para>Postconditions: owns() == false, and mutex() == &amp;m. Notes: The constructor will not take ownership of the mutex. There is no effect required on the referenced mutex. </para></description></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>accept_ownership_type</classname></paramtype></parameter><description><para>Postconditions: owns() == true, and mutex() == &amp;m. Notes: The constructor will suppose that the mutex is already sharable locked. There is no effect required on the referenced mutex. </para></description></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>try_to_lock_type</classname></paramtype></parameter><description><para>Effects: m.try_lock_sharable() Postconditions: mutex() == &amp;m. owns() == the return value of the m.try_lock_sharable() executed within the constructor. Notes: The constructor will take sharable-ownership of the mutex if it can do so without waiting. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock_sharable, this constructor will fail at compile time if instantiated, but otherwise have no effect. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: m.timed_lock_sharable(abs_time) Postconditions: mutex() == &amp;m. owns() == the return value of the m.timed_lock_sharable() executed within the constructor. Notes: The constructor will take sharable-ownership of the mutex if it can do so within the time specified. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support timed_lock_sharable, this constructor will fail at compile time if instantiated, but otherwise have no effect. </para></description></constructor>
<constructor cv="noexcept"><parameter name="upgr"><paramtype><classname>sharable_lock</classname>&lt; mutex_type &gt; &amp;&amp;</paramtype></parameter><description><para>Postconditions: mutex() == upgr.mutex(). owns() == the value of upgr.owns() before the construction. upgr.owns() == false after the construction. Notes: If the upgr <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> owns the mutex, ownership is moved to this <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> with no blocking. If the upgr <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> does not own the mutex, then neither will this <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname>. Only a moved <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname>'s will match this signature. An non-moved <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> can be moved with the expression: "boost::move(lock);". This constructor does not alter the state of the mutex, only potentially who owns it. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T"/>
        </template><parameter name="upgr"><paramtype><classname>upgradable_lock</classname>&lt; T &gt; &amp;&amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Effects: If upgr.owns() then calls unlock_upgradable_and_lock_sharable() on the referenced mutex. Postconditions: mutex() == the value upgr.mutex() had before the construction. upgr.mutex() == 0 owns() == the value of upgr.owns() before construction. upgr.owns() == false after the construction. Notes: If upgr is locked, this constructor will lock this <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> while unlocking upgr. Only a moved <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname>'s will match this signature. An non-moved <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> can be moved with the expression: "boost::move(lock);". </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T"/>
        </template><parameter name="scop"><paramtype><classname>scoped_lock</classname>&lt; T &gt; &amp;&amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Effects: If scop.owns() then calls unlock_and_lock_sharable() on the referenced mutex. Postconditions: mutex() == the value scop.mutex() had before the construction. scop.mutex() == 0 owns() == scop.owns() before the constructor. After the construction, scop.owns() == false. Notes: If scop is locked, this constructor will transfer the exclusive ownership to a sharable-ownership of this <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname>. Only a moved <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname>'s will match this signature. An non-moved <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> can be moved with the expression: "boost::move(lock);". </para></description></constructor>
<destructor><description><para>Effects: if (owns()) mp_mutex-&gt;unlock_sharable(). Notes: The destructor behavior ensures that the mutex lock is not leaked. </para></description></destructor>
<copy-assignment><type><classname>sharable_lock</classname> &amp;</type><parameter name="upgr"><paramtype><classname>sharable_lock</classname>&lt; mutex_type &gt; &amp;&amp;</paramtype></parameter><description><para>Effects: If owns() before the call, then unlock_sharable() is called on mutex(). *this gets the state of upgr and upgr gets set to a default constructed state. Notes: With a recursive mutex it is possible that both this and upgr own the mutex before the assignment. In this case, this will own the mutex after the assignment (and upgr will not), but the mutex's lock count will be decremented by one. </para></description></copy-assignment>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/sync/upgradable_lock.hpp">
<para>Describes the upgradable_lock class that serves to acquire the upgradable lock of a mutex. </para><namespace name="boost">
<namespace name="interprocess">
<class name="upgradable_lock"><template>
      <template-type-parameter name="UpgradableMutex"/>
    </template><description><para><classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> is meant to carry out the tasks for read-locking, unlocking, try-read-locking and timed-read-locking (recursive or not) for the Mutex. Additionally the <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> can transfer ownership to a <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> using transfer_lock syntax. The Mutex need not supply all of the functionality. If the client of upgradable_lock&lt;Mutex&gt; does not use functionality which the Mutex does not supply, no harm is done. Mutex ownership can be shared among read_locks, and a single <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname>. <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> does not support copy semantics. However <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> supports ownership transfer from a upgradable_locks or scoped_locks via transfer_lock syntax. </para></description><typedef name="mutex_type"><type>UpgradableMutex</type></typedef>
<method-group name="public member functions">
<method name="lock"><type>void</type><description><para>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls lock_upgradable() on the referenced mutex. Postconditions: owns() == true. Notes: The <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> changes from a state of not owning the mutex, to owning the mutex, blocking if necessary. </para></description></method>
<method name="try_lock"><type>bool</type><description><para>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock_upgradable() on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt;try_lock_upgradable(). Notes: The <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if blocking was not required. If the mutex_type does not support try_lock_upgradable(), this function will fail at compile time if instantiated, but otherwise have no effect. </para></description></method>
<method name="timed_lock"><type>bool</type><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls timed_lock_upgradable(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-&gt;timed_lock_upgradable(abs_time). Notes: The <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership within the specified time. If the mutex_type does not support timed_lock_upgradable(abs_time), this function will fail at compile time if instantiated, but otherwise have no effect. </para></description></method>
<method name="unlock"><type>void</type><description><para>Effects: If mutex() == 0 or if not locked, throws a lock_exception() exception. Calls unlock_upgradable() on the referenced mutex. Postconditions: owns() == false. Notes: The <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> changes from a state of owning the mutex, to not owning the mutex. </para></description></method>
<method name="owns" cv="const noexcept"><type>bool</type><description><para>Effects: Returns true if this <classname alt="boost::interprocess::scoped_lock">scoped_lock</classname> has acquired the referenced mutex. </para></description></method>
<method name="conversion-operator" cv="const noexcept"><type>unspecified_bool_type</type><description><para>Conversion to bool. Returns owns(). </para></description></method>
<method name="mutex" cv="const noexcept"><type>mutex_type *</type><description><para>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. </para></description></method>
<method name="release" cv="noexcept"><type>mutex_type *</type><description><para>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. Postconditions: mutex() == 0 and owns() == false. </para></description></method>
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>upgradable_lock</classname>&lt; mutex_type &gt; &amp;</paramtype></parameter><description><para>Effects: Swaps state with moved lock. Throws: Nothing. </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Effects: Default constructs a <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname>. Postconditions: owns() == false and mutex() == 0. </para></description></constructor>
<constructor specifiers="explicit"><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>defer_lock_type</classname></paramtype></parameter><description><para>Postconditions: owns() == false, and mutex() == &amp;m. Notes: The constructor will not take ownership of the mutex. There is no effect required on the referenced mutex. </para></description></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>accept_ownership_type</classname></paramtype></parameter><description><para>Postconditions: owns() == true, and mutex() == &amp;m. Notes: The constructor will suppose that the mutex is already upgradable locked. There is no effect required on the referenced mutex. </para></description></constructor>
<constructor><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name=""><paramtype><classname>try_to_lock_type</classname></paramtype></parameter><description><para>Effects: m.try_lock_upgradable(). Postconditions: mutex() == &amp;m. owns() == the return value of the m.try_lock_upgradable() executed within the constructor. Notes: The constructor will take upgradable-ownership of the mutex if it can do so without waiting. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock_upgradable, this constructor will fail at compile time if instantiated, but otherwise have no effect. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="TimePoint"/>
        </template><parameter name="m"><paramtype>mutex_type &amp;</paramtype></parameter><parameter name="abs_time"><paramtype>const TimePoint &amp;</paramtype></parameter><description><para>Effects: m.timed_lock_upgradable(abs_time) Postconditions: mutex() == &amp;m. owns() == the return value of the m.timed_lock_upgradable() executed within the constructor. Notes: The constructor will take upgradable-ownership of the mutex if it can do so within the time specified. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support timed_lock_upgradable, this constructor will fail at compile time if instantiated, but otherwise have no effect. </para></description></constructor>
<constructor cv="noexcept"><parameter name="upgr"><paramtype><classname>upgradable_lock</classname>&lt; mutex_type &gt; &amp;&amp;</paramtype></parameter><description><para>Effects: No effects on the underlying mutex. Postconditions: mutex() == the value upgr.mutex() had before the construction. upgr.mutex() == 0. owns() == upgr.owns() before the construction. upgr.owns() == false. Notes: If upgr is locked, this constructor will lock this <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> while unlocking upgr. If upgr is unlocked, then this <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> will be unlocked as well. Only a moved <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname>'s will match this signature. An non-moved <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> can be moved with the expression: "boost::move(lock);". This constructor does not alter the state of the mutex, only potentially who owns it. </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T"/>
        </template><parameter name="scop"><paramtype><classname>scoped_lock</classname>&lt; T &gt; &amp;&amp;</paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Effects: If scop.owns(), m_.unlock_and_lock_upgradable(). Postconditions: mutex() == the value scop.mutex() had before the construction. scop.mutex() == 0. owns() == scop.owns() before the constructor. After the construction, scop.owns() == false. Notes: If scop is locked, this constructor will transfer the exclusive-ownership to an upgradable-ownership of this <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname>. Only a moved <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname>'s will match this signature. An non-moved <classname alt="boost::interprocess::sharable_lock">sharable_lock</classname> can be moved with the expression: "boost::move(lock);". </para></description></constructor>
<constructor><template>
          <template-type-parameter name="T"/>
        </template><parameter name="shar"><paramtype><classname>sharable_lock</classname>&lt; T &gt; &amp;&amp;</paramtype></parameter><parameter name=""><paramtype><classname>try_to_lock_type</classname></paramtype></parameter><parameter name=""><paramtype><emphasis>unspecified</emphasis></paramtype><default>0</default></parameter><description><para>Effects: If shar.owns() then calls try_unlock_sharable_and_lock_upgradable() on the referenced mutex. a)if try_unlock_sharable_and_lock_upgradable() returns true then mutex() obtains the value from shar.release() and owns() is set to true. b)if try_unlock_sharable_and_lock_upgradable() returns false then shar is unaffected and this <classname alt="boost::interprocess::upgradable_lock">upgradable_lock</classname> construction has the same effects as a default construction. c)Else shar.owns() is false. mutex() obtains the value from shar.release() and owns() is set to false. Notes: This construction will not block. It will try to obtain mutex ownership from shar immediately, while changing the lock type from a "read lock" to an "upgradable lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "upgradable lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner. </para></description></constructor>
<destructor><description><para>Effects: if (owns()) m_-&gt;unlock_upgradable(). Notes: The destructor behavior ensures that the mutex lock is not leaked. </para></description></destructor>
<copy-assignment><type><classname>upgradable_lock</classname> &amp;</type><parameter name="upgr"><paramtype><classname>upgradable_lock</classname> &amp;&amp;</paramtype></parameter><description><para>Effects: If owns(), then unlock_upgradable() is called on mutex(). *this gets the state of upgr and upgr gets set to a default constructed state. Notes: With a recursive mutex it is possible that both this and upgr own the mutex before the assignment. In this case, this will own the mutex after the assignment (and upgr will not), but the mutex's upgradable lock count will be decremented by one. </para></description></copy-assignment>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/windows_shared_memory.hpp">
<para>Describes a class representing a native windows shared memory. </para><namespace name="boost">
<namespace name="interprocess">
<class name="windows_shared_memory"><description><para>A class that wraps the native Windows shared memory that is implemented as a file mapping of the paging file. Unlike <classname alt="boost::interprocess::shared_memory_object">shared_memory_object</classname>, <classname alt="boost::interprocess::windows_shared_memory">windows_shared_memory</classname> has no kernel persistence and the shared memory is destroyed when all processes destroy all their <classname alt="boost::interprocess::windows_shared_memory">windows_shared_memory</classname> objects and mapped regions for the same shared memory or the processes end/crash.</para><para>Warning: Windows native shared memory and interprocess portable shared memory (<classname alt="boost::interprocess::shared_memory_object">boost::interprocess::shared_memory_object</classname>) can't communicate between them. </para></description><method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>windows_shared_memory</classname> &amp;</paramtype></parameter><purpose>Swaps to shared_memory_objects. Does not throw. </purpose></method>
<method name="get_name" cv="const noexcept"><type>const char *</type><purpose>Returns the name of the shared memory. </purpose></method>
<method name="get_mode" cv="const noexcept"><type>mode_t</type><purpose>Returns access mode. </purpose></method>
<method name="get_mapping_handle" cv="const noexcept"><type>mapping_handle_t</type><purpose>Returns the mapping handle. Never throws. </purpose></method>
<method name="get_size" cv="const noexcept"><type>offset_t</type><description><para>Returns the size of the windows shared memory. It will be a 4K rounded size of the "size" passed in the constructor. </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Default constructor. Represents an empty <classname alt="boost::interprocess::windows_shared_memory">windows_shared_memory</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a new native shared memory with name "name" and at least size "size", with the access mode "mode". If the file previously exists, throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Tries to create a shared memory object with name "name" and at least size "size", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const char *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><description><para>Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a new native shared memory with name "name" and at least size "size", with the access mode "mode". If the file previously exists, throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Tries to create a shared memory object with name "name" and at least size "size", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="name"><paramtype>const wchar_t *</paramtype></parameter><parameter name="mode"><paramtype>mode_t</paramtype></parameter><description><para>Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error. </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>windows_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>windows_shared_memory</classname> &amp;</type><parameter name="moved"><paramtype><classname>windows_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw </para></description></copy-assignment>
<destructor><description><para>Destroys *this. All mapped regions are still valid after destruction. When all mapped regions and <classname alt="boost::interprocess::windows_shared_memory">windows_shared_memory</classname> objects referring the shared memory are destroyed, the operating system will destroy the shared memory. </para></description></destructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/xsi_key.hpp">
<para>Describes a class representing a xsi key type. </para><namespace name="boost">
<namespace name="interprocess">
<class name="xsi_key"><description><para>A class that wraps XSI (System V) key_t type. This type calculates key_t from path and id using ftok, sets key to a specified value, or sets key to IPC_PRIVATE using the default constructor. </para></description><method-group name="public member functions">
<method name="get_key" cv="const"><type>key_t</type><purpose>Returns the internal key_t value. </purpose></method>
</method-group>
<constructor><description><para>Default constructor. Represents a private <classname alt="boost::interprocess::xsi_key">xsi_key</classname>. </para></description></constructor>
<constructor specifiers="explicit"><parameter name="key"><paramtype>key_t</paramtype></parameter><purpose>Creates a new XSI key using a specified value. Constructor is explicit to avoid ambiguity with shmid. </purpose></constructor>
<constructor><parameter name="path"><paramtype>const char *</paramtype></parameter><parameter name="id"><paramtype>boost::uint8_t</paramtype></parameter><description><para>Creates a new XSI shared memory with a key obtained from a call to ftok (with path "path" and id "id"), of size "size" and permissions "perm". If the shared memory previously exists, throws an error. </para></description></constructor>
</class>
















































</namespace>
</namespace>
</header>
<header name="boost/interprocess/xsi_shared_memory.hpp">
<para>Describes a class representing a native xsi shared memory. </para><namespace name="boost">
<namespace name="interprocess">
<class name="xsi_shared_memory"><description><para>A class that wraps XSI (System V) shared memory. Unlike <classname alt="boost::interprocess::shared_memory_object">shared_memory_object</classname>, <classname alt="boost::interprocess::xsi_shared_memory">xsi_shared_memory</classname> needs a valid <classname alt="boost::interprocess::xsi_key">xsi_key</classname> to identify a shared memory object.</para><para>Warning: XSI shared memory and interprocess portable shared memory (<classname alt="boost::interprocess::shared_memory_object">boost::interprocess::shared_memory_object</classname>) can't communicate between them. </para></description><method-group name="public member functions">
<method name="swap" cv="noexcept"><type>void</type><parameter name="other"><paramtype><classname>xsi_shared_memory</classname> &amp;</paramtype></parameter><purpose>Swaps two xsi_shared_memorys. Does not throw. </purpose></method>
<method name="get_shmid" cv="const noexcept"><type>int</type><description><para>Returns the shared memory ID that identifies the shared memory </para></description></method>
<method name="get_mapping_handle" cv="const noexcept"><type>mapping_handle_t</type><description><para>Returns the mapping handle. Never throws </para></description></method>
</method-group>
<constructor cv="noexcept"><description><para>Default constructor. Represents an empty <classname alt="boost::interprocess::xsi_shared_memory">xsi_shared_memory</classname>. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="shmid"><paramtype>int</paramtype></parameter><description><para>Initializes *this with a shmid previously obtained (possibly from another process) This lower-level initializer allows shared memory mapping without having a key. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>create_only_t</classname></paramtype></parameter><parameter name="key"><paramtype>const <classname>xsi_key</classname> &amp;</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Creates a new XSI shared memory from 'key', with size "size" and permissions "perm". If the shared memory previously exists, throws an error. </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_or_create_t</classname></paramtype></parameter><parameter name="key"><paramtype>const <classname>xsi_key</classname> &amp;</paramtype></parameter><parameter name="size"><paramtype>std::size_t</paramtype></parameter><parameter name="perm"><paramtype>const <classname>permissions</classname> &amp;</paramtype><default><classname alt="boost::interprocess::permissions">permissions</classname>()</default></parameter><description><para>Opens an existing shared memory with identifier 'key' or creates a new XSI shared memory from identifier 'key', with size "size" and permissions "perm". </para></description></constructor>
<constructor><parameter name=""><paramtype><classname>open_only_t</classname></paramtype></parameter><parameter name="key"><paramtype>const <classname>xsi_key</classname> &amp;</paramtype></parameter><description><para>Tries to open a XSI shared memory with identifier 'key' If the shared memory does not previously exist, it throws an error. </para></description></constructor>
<constructor cv="noexcept"><parameter name="moved"><paramtype><classname>xsi_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw </para></description></constructor>
<copy-assignment cv="noexcept"><type><classname>xsi_shared_memory</classname> &amp;</type><parameter name="moved"><paramtype><classname>xsi_shared_memory</classname> &amp;&amp;</paramtype></parameter><description><para>Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw </para></description></copy-assignment>
<destructor><description><para>Destroys *this. The shared memory won't be destroyed, just this connection to it. Use remove() to destroy the shared memory. </para></description></destructor>
<method-group name="public static functions">
<method name="remove" specifiers="static"><type>bool</type><parameter name="shmid"><paramtype>int</paramtype></parameter><description><para>Erases the XSI shared memory object identified by shmid from the system. Returns false on error. Never throws </para></description></method>
</method-group>
</class>
















































</namespace>
</namespace>
</header>
</library-reference>