/usr/include/OpenDRIM/cmpi/cmpift.h is in libopendrim0-dev 1.1.3-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 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 | /* ------------------------------------------------------------------------- */
/* */
/* Copyright (c) 2006 The Open Group */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining a */
/* copy of this software (the "Software"), to deal in the Software without */
/* restriction, including without limitation the rights to use, copy, */
/* modify, merge, publish, distribute, sublicense, and/or sell copies of */
/* the Software, and to permit persons to whom the Software is furnished */
/* to do so, subject to the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be included */
/* in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS */
/* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT */
/* OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR */
/* THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/* */
/* ------------------------------------------------------------------------- */
#ifndef _CMPIFT_H_
# define _CMPIFT_H_
# include "cmpidt.h"
# include "cmpios.h"
# ifdef __cplusplus
extern "C"
{
# endif
//---------------------------------------------------
//--
// _CMPIBrokerEncFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers to broker and factory services
of encapsulated CMPIObjects. This table is made available
by the Management Broker, aka CIMOM, whenever a provider
is loaded and initialized.
*/
struct _CMPIBrokerEncFT
{
/** Function table version
*/
int ftVersion;
/** Instance factory service.
@param mb Pointer to the broker.
@param op ObjectPath containing namespace and classname.
@param rc Output: Service return status (suppressed when NULL).
@return The newly created Instance.
*/
CMPIInstance *(*newInstance)
(const CMPIBroker * mb, const CMPIObjectPath * op, CMPIStatus * rc);
/** ObjectPath factory service.
@param mb Pointer to the broker.
@param ns Namespace
@param cn Classname.
@param rc Output: Service return status (suppressed when NULL).
@return The newly created ObjectPath.
*/
CMPIObjectPath *(*newObjectPath)
(const CMPIBroker * mb, const char *ns, const char *cn,
CMPIStatus * rc);
/** Args container factory service.
@param mb Pointer to the broker.
@param rc Output: Service return status (suppressed when NULL).
@return The newly created Args container.
*/
CMPIArgs *(*newArgs) (const CMPIBroker * mb, CMPIStatus * rc);
/** String container factory service.
@param mb Pointer to the broker.
@param data String data
@param rc Output: Service return status (suppressed when NULL).
@return The newly created String.
*/
CMPIString *(*newString)
(const CMPIBroker * mb, const char *data, CMPIStatus * rc);
/** Array container factory service.
@param mb Pointer to the broker.
@param max Maximum number of elements
@param type Element type
@param rc Output: Service return status (suppressed when NULL).
@return The newly created Array.
*/
CMPIArray *(*newArray)
(const CMPIBroker * mb, CMPICount max, CMPIType type, CMPIStatus * rc);
/** DateTime factory service. Initialized with the time of day.
@param mb Pointer to the broker.
@param rc Output: Service return status (suppressed when NULL).
@return The newly created DateTime.
*/
CMPIDateTime *(*newDateTime) (const CMPIBroker * mb, CMPIStatus * rc);
/** DateTime factory service. Initialized from <binTime>.
@param mb Pointer to the broker.
@param binTime Date/Time definition in binary format in microsecods
starting since 00:00:00 GMT, Jan 1,1970.
@param interval Wenn true, defines Date/Time definition to be an interval value
@param rc Output: Service return status (suppressed when NULL).
@return The newly created DateTime.
*/
CMPIDateTime *(*newDateTimeFromBinary)
(const CMPIBroker * mb, CMPIUint64 binTime, CMPIBoolean interval,
CMPIStatus * rc);
/** DateTime factory service. Is initialized from <utcTime>.
@param mb Pointer to the broker.
@param utcTime Date/Time definition in UTC format
@param rc Output: Service return status (suppressed when NULL).
@return The newly created DateTime.
*/
CMPIDateTime *(*newDateTimeFromChars)
(const CMPIBroker * mb, const char *utcTime, CMPIStatus * rc);
/** SelectExp factory service.
@param mb Pointer to the broker.
@param query The select expression.
@param lang The query language.
@param projection Output: Projection specification (suppressed when NULL).
@param rc Output: Service return status (suppressed when NULL).
@return The newly created SelectExp.
*/
CMPISelectExp *(*newSelectExp)
(const CMPIBroker * mb, const char *query, const char *lang,
CMPIArray ** projection, CMPIStatus * st);
/** Function to determine whether a CIM class is of <type> or any of
<type> subclasses.
@param mb Pointer to the broker.
@param op The class path (namespace and classname components).
@param type The type to tested for.
@param rc Output: Service return status (suppressed when NULL).
@return True if test successful.
*/
CMPIBoolean (*classPathIsA)
(const CMPIBroker * mb, const CMPIObjectPath * op, const char *type,
CMPIStatus * rc);
/** Attempts to transforms an CMPI object to a broker specific string format.
Intended for debugging purposes only.
@param mb Pointer to the broker.
@param object A valid CMPI object.
@param rc Output: Service return status (suppressed when NULL).
@return String from representation of <object>.
*/
CMPIString *(*toString)
(const CMPIBroker * mb, const void *object, CMPIStatus * rc);
/** Verifies whether <object> is of CMPI type <type>.
Intended for debugging purposes only.
@param mb Pointer to the broker.
@param object A valid CMPI object.
@param type A string specifying a valid CMPI Object type
("CMPIInstance", "CMPIObjectPath", etc).
@param rc Output: Service return status (suppressed when NULL).
@return True if test successful.
*/
CMPIBoolean (*isOfType)
(const CMPIBroker * mb, const void *object, const char *type,
CMPIStatus * rc);
/** Retrieves the CMPI type of <object>.
Intended for debugging purposes only.
@param mb Pointer to the broker.
@param object A valid CMPI object.
@param rc Output: Service return status (suppressed when NULL).
@return CMPI object type.
*/
CMPIString *(*getType)
(const CMPIBroker * mb, const void *object, CMPIStatus * rc);
/** Retrieves translated message.
@param mb Pointer to the broker.
@param msgId The message identifier.
@param defMsg The default message.
@param rc Output: Service return status (suppressed when NULL).
@param count The number of message substitution values.
@return the trabslated message.
*/
CMPIString *(*getMessage)
(const CMPIBroker * mb, const char *msgId, const char *defMsg,
CMPIStatus * rc, CMPICount count, ...);
/** Logs a diagnostic message.
@param mb The mb argument points to a CMPIBroker structure.
@param severity The level argument describes the level of log message. Levels are defined in Section 4.9.
@param id The component argument, if not NULL, is the component ID.
@param text The text argument, if not NULL, is the message text to be logged.
@param string The string argument, if not NULL, is the message text to be logged. string will be
ignored when text is not NULL.
@return Service return status.
*/
CMPIStatus (*logMessage)
(const CMPIBroker *, int severity, const char *id,
const char *text, const CMPIString * string);
/** Logs a trace entry. Intended for debugging purposes.
@param mb The mb argument points to a CMPIBroker structure.
@param level The level argument describes the level of log message. Levels are defined in Section 4.9.
@param component The component argument, if not NULL, is the component ID.
@param text The text argument, if not NULL, is the message text to be logged.
@param string The string argument, if not NULL, is the message text to be logged. string will be
ignored when text is not NULL.
@return Service return status.
*/
CMPIStatus (*trace)
(const CMPIBroker *, int level, const char *component,
const char *text, const CMPIString * string);
# ifdef CMPI_VER_200
/** Error factory service.
@param mb Pointer to the broker.
@param msgID A string which uniquely identifies, within the scope of the 'owner' argument, the format of the message.
@param msg A string which represenst the formatted message.
@parem sev The percieved severity of the error.
@param pc The probably cause of this error
@param status Service return status.
@return The newly created Error.
*/
CMPIError* (*newCMPIError)
(const CMPIBroker*, const char*, const char*, const char*,
const CMPIErrorSeverity, const CMPIErrorProbableCause,const CMPIrc,
CMPIStatus *rc);
/** Opens a message file.
@param mb Broker this pointer
@param msgFile The message file identifier.
@param msgFileHandle Output: The handle representing the open message file.
@return Service return status.
*/
CMPIStatus (*openMessageFile)
(const CMPIBroker* mb, const char *msgFile,
CMPIMsgFileHandle* msgFileHandle);
/** Closes a message file.
@param mb Broker this pointer
@param msgFileHandle The handle representing the open message file.
@return Service return status.
*/
CMPIStatus (*closeMessageFile)
(const CMPIBroker* mb, const CMPIMsgFileHandle msgFileHandle);
/** Retrieves translated message.
@param mb Broker this pointer
@param msgId The message identifier.
@param msgFileHandle The handle representing the open message file.
@param defMsg The default message.
@param rc Output: Service return status (suppressed when NULL).
@param count The number of message substitution values.
@return the translated message.
*/
CMPIString* (*getMessage2)
(const CMPIBroker* mb, const char *msgId,
const CMPIMsgFileHandle msgFileHandle, const char *defMsg,
CMPIStatus* rc, CMPICount count, ...);
# endif /* CMPI_VER_200 */
};
//---------------------------------------------------
//--
// _CMPIBrokerFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers to broker CIMOM services
(up-calls). This table is made available by the Management Broker,
whenever a provider is loaded and initialized.
*/
struct _CMPIBrokerFT
{
/** 32 bits describing CMPI features supported by this CIMOM.
See CMPI_MB_Class_x and CMPI_MB_Supports_xxx flags.
*/
unsigned int brokerCapabilities;
/** CIMOM version as defined by CIMOM
*/
unsigned int brokerVersion;
/** CIMOM name
*/
const char *brokerName;
/** This function prepares the CMPI run time system to accept
a thread that will be using CMPI services. The returned
CMPIContext object must be used by the subsequent attachThread()
and detachThread() invocations.
@param mb Pointer to the broker.
@param ctx Old Context object
@return New Context object to be used by thread to be attached.
*/
CMPIContext *(*prepareAttachThread)
(const CMPIBroker * mb, const CMPIContext * ctx);
/** This function informs the CMPI run time system that the current
thread with Context will begin using CMPI services.
@param mb Pointer to the broker.
@param ctx Context object
@return Service return status.
*/
CMPIStatus (*attachThread) (const CMPIBroker *, const CMPIContext *);
/** This function informs the CMPI run time system that the current thread
will not be using CMPI services anymore. The Context object will be
freed during this operation.
@param mb Pointer to the broker.
@param ctx Context object
@return Service return status.
*/
CMPIStatus (*detachThread)
(const CMPIBroker * mb, const CMPIContext * ctx);
// class 0 services
/** This function requests delivery of an Indication. The CIMOM will
locate pertinent subscribers and notify them about the event.
@param mb Pointer to the broker.
@param ctx Context object
@param ns Namespace
@param ind Indication Instance
@return Service return status.
*/
CMPIStatus (*deliverIndication)
(const CMPIBroker * mb, const CMPIContext * ctx,
const char *ns, const CMPIInstance * ind);
// class 1 services
/** Enumerate Instance Names of the class (and subclasses) defined by <op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace and classname components.
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPathes.
*/
CMPIEnumeration *(*enumerateInstanceNames)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, CMPIStatus * rc);
/** Get Instance using <op> as reference. Instance structure can be
controled using the CMPIInvocationFlags entry in <ctx>.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return The Instance.
*/
CMPIInstance *(*getInstance)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char **properties, CMPIStatus * rc);
// class 2 services
/** Create Instance from <inst> using <op> as reference.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param inst Complete instance.
@param rc Output: Service return status (suppressed when NULL).
@return The assigned instance reference.
*/
CMPIObjectPath *(*createInstance)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const CMPIInstance * inst, CMPIStatus * rc);
/** Replace an existing Instance from <inst> using <op> as reference.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param inst Complete instance.
@return Service return status.
*/
CMPIStatus (*modifyInstance)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const CMPIInstance * inst,
const char **properties);
/** Delete an existing Instance using <op> as reference.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@return Service return status.
*/
CMPIStatus (*deleteInstance)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op);
/** Query the enumeration of instances of the class (and subclasses) defined
by <op> using <query> expression.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace and classname components.
@param query Query expression
@param lang Query Language
@param rc Output: Service return status (suppressed when NULL).
@return Resulting eumeration of Instances.
*/
CMPIEnumeration *(*execQuery)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *query, const char *lang,
CMPIStatus * rc);
/** Enumerate Instances of the class (and subclasses) defined by <op>.
Instance structure and inheritance scope can be controled using the
CMPIInvocationFlags entry in <ctx>.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace and classname components.
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of Instances.
*/
CMPIEnumeration *(*enumerateInstances)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char **properties, CMPIStatus * rc);
/** Enumerate instances associated with the Instance defined by the <op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op Source ObjectPath containing namespace, classname and key components.
@param assocClass If not NULL, MUST be a valid Association Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be associated to the source Object via an
Instance of this Class or one of its subclasses.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param resultRole If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the returned Object plays the specified role
(i.e. the name of the Property in the Association Class that refers to
the returned Object MUST match the value of this parameter).
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of Instances.
*/
CMPIEnumeration *(*associators)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *assocClass,
const char *resultClass, const char *role, const char *resultRole,
const char **properties, CMPIStatus * rc);
/** Enumerate ObjectPaths associated with the Instance defined by <op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op Source ObjectPath containing namespace, classname and key components.
@param assocClass If not NULL, MUST be a valid Association Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be associated to the source Object via an
Instance of this Class or one of its subclasses.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param resultRole If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the returned Object plays the specified role
(i.e. the name of the Property in the Association Class that refers to
the returned Object MUST match the value of this parameter).
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CMPIEnumeration *(*associatorNames)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *assocClass,
const char *resultClass, const char *role, const char *resultRole,
CMPIStatus * rc);
/** Enumerates the association instances that refer to the instance defined by
<op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op Source ObjectPath containing namespace, classname and key components.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CMPIEnumeration *(*references)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *resultClass, const char *role,
const char **properties, CMPIStatus * rc);
/** Enumerates the association ObjectPaths that refer to the instance defined by
<op>.
@param mb Pointer to the broker.
@param ctx Context object
@param op Source ObjectPath containing namespace, classname and key components.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param rc Output: Service return status (suppressed when NULL).
@return Enumeration of ObjectPaths.
*/
CMPIEnumeration *(*referenceNames)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *resultClass, const char *role,
CMPIStatus * rc);
/** Invoke a named, extrinsic method of an Instance
defined by the <op> parameter.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param method Method name
@param in Input parameters.
@param out Output parameters.
@param rc Output: Service return status (suppressed when NULL).
@return Method return value.
*/
CMPIData (*invokeMethod)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *method,
const CMPIArgs * in, CMPIArgs * out, CMPIStatus * rc);
/** Set the named property value of an Instance defined by the <op> parameter.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param name Property name
@param value Value.
@param type Value type.
@return Service return status.
*/
CMPIStatus (*setProperty)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *name, const CMPIValue * value,
CMPIType type);
/** Get the named property value of an Instance defined by the <op> parameter.
@param mb Pointer to the broker.
@param ctx Context object
@param op ObjectPath containing namespace, classname and key components.
@param name Property name
@param rc Output: Service return status (suppressed when NULL).
@return Property value.
*/
CMPIData (*getProperty)
(const CMPIBroker * mb, const CMPIContext * ctx,
const CMPIObjectPath * op, const char *name, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPIBrokerExtFT Function Table
//--
//---------------------------------------------------
struct timespec;
/** This structure is a table of pointers to extended broker CIMOM
services This table is made available by the Management Broker,
whenever a provider is loaded and initialized.
This is an extension used by Pegasus to support platform dependencies.
*/
struct _CMPIBrokerExtFT
{
/** Function table version
*/
int ftVersion;
/**
This function complements a generic dynamic library nameto its OS-dependent native format.
@param filename Pointer to the generic library name,
@return The returned char* pointer points to the complemented library name in native OS format.
Space for this string has been obtained using malloc() and must be released using free() by the caller.
In case no storage could be obtained for the complemented library name, NULL will be
returned.
*/
char *(*resolveFileName) (const char *filename);
/** Start a new thread using the POSIX threading semantics.
@param start Pointer to the function to be started as a thread.
@param param Pointer to the function to be started as a thread.
@param detached If not zero, defines that the thread should run in detached mode.
@return The return value is the thread ID.
*/
CMPI_THREAD_TYPE (*newThread)
(CMPI_THREAD_RETURN (CMPI_THREAD_CDECL * start) (void *), void *parm,
int detached);
/** Waits until the specified thread ends using the POSIX threading semantics.
@param thread The thread ID of the thread waiting for completion.
@param retval Pointer to the return value of the thread.
@return Completion code as defined by POSIX threading semantics (pthread_join)
*/
int (*joinThread) (CMPI_THREAD_TYPE thread, CMPI_THREAD_RETURN * retval);
/** Causes the current thread to exit with the passed in return code using POSIX threading semantics.
@param return_code Is the return code that should be used for the thread.
@return The function never exits.
*/
int (*exitThread) (CMPI_THREAD_RETURN return_code);
/** Cancel the thread using the POSIX threading semantics.
@param thread The thread to be canceled.
@return Completion code as defined by POSIX threading semantics (pthread_cancel)
*/
int (*cancelThread) (CMPI_THREAD_TYPE thread);
/** Suspends the execution of the current thread for the specified duration.
@param msec The suspend duration in milliseconds.
@return Completion code as defined by POSIX threading semantics (pthread_sleep)
*/
int (*threadSleep) (CMPIUint32 msec);
/** Executes the specified function procedure only once during the lifetime of the thread.
@param once The pointer to the counter.
@param The function to be called
@return Completion code as defined by POSIX threading semantics (pthread_once)
*/
int (*threadOnce) (int *once, void (*init) (void));
/* Create a POSIX threading conformant thread key. This key can be used as a key to access the thread local store.
@param key The address for the key to be returned.
@param cleanup Function to be invoked during thread local store cleanup.
@return Completion code as defined by POSIX threading semantics.
*/
int (*createThreadKey)
(CMPI_THREAD_KEY_TYPE * key, void (*cleanup) (void *));
/** Destroy a POSIX threading conformant thread key.
@param key The key to be destroyed.
@return Completion code as defined by POSIX threading semantics.
*/
int (*destroyThreadKey) (CMPI_THREAD_KEY_TYPE key);
/** Return data from the thread local store using a thread key.
@param key The key to be used to retrieve the data.
@return Completion code as defined by POSIX threading semantics.
*/
void *(*getThreadSpecific) (CMPI_THREAD_KEY_TYPE key);
/** Set a pointer to data in the therad local store using a thread key.
@param key The key to be used.
@param value The pointer to the data.
@return Completion code as defined by POSIX threading semantics.
*/
int (*setThreadSpecific) (CMPI_THREAD_KEY_TYPE key, void *value);
/** Create a POSIX threading conformant mutex.
@param opt The POSIX options. If not options are to be defined the 0 values must be used.
@return Handle of newly created mutex.
*/
CMPI_MUTEX_TYPE (*newMutex) (int opt);
/** Destroy a POSIX threading conformant mutex.
@param mutex The mutex to be destroyed.
*/
void (*destroyMutex) (CMPI_MUTEX_TYPE mutex);
/** Attempt to get control of the mutex and must wait until released when not available.
@param mutex The mutex to be locked.
*/
void (*lockMutex) (CMPI_MUTEX_TYPE mutex);
/** Release control of the mutex.
@param mutex The mutex to be unlocked.
*/
void (*unlockMutex) (CMPI_MUTEX_TYPE mutex);
/** Create a new POSIX threading-conformant condition variable.
@param opt The POSIX options. If not options are to be defined the 0 values must be used.
@return Handle of newly created condition variable.
*/
CMPI_COND_TYPE (*newCondition) (int opt);
/** Destroy a condition variable.
@param cond The condition variable to be destroyed.
*/
void (*destroyCondition) (CMPI_COND_TYPE cond);
/** Wait until condition is signalled. This function returns when condition has been
signalled already and otherwise must wait for the signal and then return.
@param cond The handle of the condition variable to be used.
@param mutex The handle of a locked mutex guarding this condition variable.
@return Return value As defined by POSIX threading specifications.
*/
int (*condWait) (CMPI_COND_TYPE cond, CMPI_MUTEX_TYPE mutex);
/** Wait until the condition is signalled using a timeout value. This
function shall return when condition has been signalled already and otherwise
must wait for the signal and then return. The function shall return when the
timeout specification elapses before the condition is signalled.
@param cond Specifies the handle of the condition variable to be used.
@param mutex Specifies the handle of a locked mutex guarding this condition variable.
@param wait Specifies the timeout value.
@return As defined by POSIX threading specifications.
*/
int (*timedCondWait)
(CMPI_COND_TYPE cond, CMPI_MUTEX_TYPE mutex, struct timespec * wait);
/** Sends a signal to a condition variable.
@param cond Specifies the handle of the condition variable to send the signal.
@return As defined by POSIX threading specifications.
*/
int (*signalCondition) (CMPI_COND_TYPE cond);
};
# if defined (CMPI_VER_200)
//---------------------------------------------------
//--
// _CMPIBroker Memory Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers to memory specific  CIMOM
services. This table is made available by the Management Broker,
whenever a provider is loaded and initialized.
This is an extension used by CIMOMs to support memory management
enhancements.
*/
struct _CMPIBrokerMemFT
{
const int ftVersion;
/** Returns a marker. Invoking this function marks subsequent newly
created CMPI objects to be released when release() function is invoked.
Note: mark() functions can be stacked.
@param mb The broker.
@param rc Output: Service return status (suppressed when NULL).
@return Handle to be provided to releae() function.
� */
CMPIGcStat *(*mark) (const CMPIBroker * mb, CMPIStatus * rc);
/** Release all CMPI objects created since last mark() operation
represented by the parameter. release() functions can be stacked.
@param mb The broker.
@param gc The handle returned from the mark() operation.
@return Service return status.
*/
CMPIStatus (*release) (const CMPIBroker * mb, const CMPIGcStat * gc);
/** Allocates uninitalized memory of the specified size.
@param mb Specifies the broker.
@param�size Specifies the amount of memory to allocate.
@return Returns a pointer to the allocated memory, or NULL if the memory
could not be allocated
*/
void *(*cmpiMalloc) (const CMPIBroker * mb, size_t size);
/** This function shall return a pointer to the allocated memory, the
memory will be initialized to zero.
@param mb The broker.
@param nElems The number of elements to allocate.
@param sizeElem The number of elements to allocate.
@return Returns a pointer to the allocated memory, or NULL if the memory
could not be allocated
*/
void *(*cmpiCalloc) (const CMPIBroker * mb, size_t, size_t);
/** This function changes the size of the memory block pointed to by
ptr which must have been returned by a previous call to cmpiMalloc or
cmpiCalloc. See the ANSI-C function realloc for more information
@param mb the broker.
@param ptr Pointer to previosuly allocated memory. Passing a pointer
to this function which was not allocated explicitly by cmpiMalloc or
cmpiCalloc is undefined.
@param size The new size of the memory block.
@return Returns a pointer to the newly allocated memory block, or NULL
if the new memory is not allcoated. If the function fals nothing is
done with the original ptr argument.
*/
void *(*cmpiRealloc) (const CMPIBroker * mb, void *, size_t);
/** This function returns a pointer to a new string which is a
duplicate of the string src.
@param mb The broker
@param src The string to duplicate
@return a pointer to the duplicated string, or NULL if insufficient
memory was available.
*/
char *(*cmpiStrDup) (const CMPIBroker * mb, const char *);
/** This function frees memory allocated via the cmpiMalloc, cmpiCalloc
or cmpiRealloc functions.
@param�mb The broker.
@param ptr The memory to free. This memory MUST have been allocated via
the cmpiMalloc, cmpiCalloc or cmpiRealloc functions.
@return None
*/
void (*cmpiFree) (const CMPIBroker * mb, void *);
/** Allows a MI to free memory associated to a CMPIinstance which was
allocated via CMPIBrokerEncFT.newInstance. this function should be
called when an instance is no longer being used by the MI. This
function will free all contained objects (e.g. properties).
@param mb the broker.
@parma inst The instance to free.
@return None
*/
void (*freeInstance) (const CMPIBroker * mb, CMPIInstance * inst);
/** Allows a MI to free memory associated to a CMPIArgs which was
allocated via CMPIBrokerEncFT.newArgs. this function should be called
when an instance is no longer being used by the MI. This function will
free all contained objects.
@param mb the broker.
@param obj The object path to free.
@return None
*/
void (*freeObjectPath) (const CMPIBroker * mb, CMPIObjectPath * obj);
/** Allows a MI to free memory associated to a CMPIArgs which was
allocated via CMPIBrokerEncFT.newArgs. this function should be called
when an instance is no longer being used by the MI. This function will
free all contained objects.
@param mb the broker.
@param args The argument to free.
@return None.
*/
void (*freeArgs) (const CMPIBroker * mb, CMPIArgs * args);
/** Allows a MI to free memory associated to a CMPIString which was
allocated via CMPIBrokerEncFT.newString. this function should be
called when an instance is no longer being used by the MI. This
function will free all contained objects.
@param mb the broker.
@param args The string to free.
@return None.
*/
void (*freeString) (const CMPIBroker * mb, CMPIString * str);
/** Allows a MI to free memory associated to a CMPIArray which was
allocated via CMPIBrokerEncFT.newArray. this function should be called
when an instance is no longer being used by the MI. This function will
free all contained objects (e.g. the array elements).
@param mb the broker.
@param args The string to free.
@return None.
*/
void (*freeArray) (const CMPIBroker * mb, CMPIArray * array);
/** Allows a MI to free memory associated to a CMPIDateTime which was
allocated via CMPIBrokerEncFT.newDateTime functions. this function
should be called when an instance is no longer being used by the MI.
This function will free all contained objects.
@param mb the broker.
@param args The string to free.
@return None.
*/
void (*freeDateTime) (const CMPIBroker * mb, CMPIDateTime * date);
/** Allows a MI to free memory associated to a CMPISelectExp which was
allocated via CMPIBrokerEncFT.newSelectExp functions. this function
should be called when an instance is no longer being used by the MI.
This function will free all contained objects.
@param mb the broker.
@param args The string to free.
@return None.
*/
void (*freeSelectExp) (const CMPIBroker * mb, CMPISelectExp * se);
};
# endif
//---------------------------------------------------
//--
// _CMPIBroker Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Management Broker (CIM Object Manager).
*/
struct _CMPIBroker
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to MB service routines function table.
*/
CMPIBrokerFT *bft;
/** Pointer to MB factory service routines function table.
*/
CMPIBrokerEncFT *eft;
/** Pointer to MB extended services function table.
*/
CMPIBrokerExtFT *xft;
# ifdef CMPI_VER_200
/** Pointer to MB memory enhancements function table.
*/
CMPIBrokerMemFT *mft;
# endif
};
//---------------------------------------------------
//--
// _CMPIContext Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Context
support sevices.
*/
struct _CMPIContextFT
{
/** Function table version
*/
int ftVersion;
/** The Context object will not be used any further and may be freed by
CMPI run time system.
@param ctx Context this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIContext * ctx);
/** Create an independent copy of the Context object.
@param ctx Context this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied Context object.
*/
CMPIContext *(*clone) (const CMPIContext * ctx, CMPIStatus * rc);
/** Gets a named Context entry value.
@param ctx Context this pointer.
@param name Context entry name.
@param rc Output: Service return status (suppressed when NULL).
@return Entry value.
*/
CMPIData (*getEntry)
(const CMPIContext * ctx, const char *name, CMPIStatus * rc);
/** Gets a Context entry value defined by its index.
@param ctx Context this pointer.
@param index Position in the internal Data array.
@param name Output: Returned Context entry name (suppressed when NULL).
@param rc Output: Service return status (suppressed when NULL).
@return Entry value.
*/
CMPIData (*getEntryAt)
(const CMPIContext * ctx, CMPICount index, CMPIString ** name,
CMPIStatus * rc);
/** Gets the number of entries contained in this Context.
@param ctx Context this pointer.
@return Number of entries.
*/
CMPICount (*getEntryCount) (const CMPIContext * ctx, CMPIStatus * rc);
/** Adds/replaces a named Context entry.
@param ctx Context this pointer.
@param name Entry name.
@param value Address of value structure.
@param type Value type.
@return Service return status.
*/
CMPIStatus (*addEntry)
(const CMPIContext * ctx, const char *name, const CMPIValue * value,
const CMPIType type);
};
//---------------------------------------------------
//--
// _CMPIContext Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated Context object.
*/
struct _CMPIContext
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the Context Function Table.
*/
CMPIContextFT *ft;
};
//---------------------------------------------------
//--
// _CMPIResult Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated Result object.
*/
struct _CMPIResult
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the Result Function Table.
*/
CMPIResultFT *ft;
};
//---------------------------------------------------
//--
// _CMPIResult Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Result
support sevices. Result support services are used to explicity return
data produced by provider functions.
*/
struct _CMPIResultFT
{
/** Function table version
*/
int ftVersion;
/** The Result object will not be used any further and may be freed by
CMPI run time system.
@param rslt Result this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIResult * rslt);
/** Create an independent copy of this Result object.
@param rslt Result this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied Result object.
*/
CMPIResult *(*clone) (const CMPIResult * rslt, CMPIStatus * rc);
/** Return a value/type pair.
@param rslt Result this pointer.
@param value Address of a Value object.
@param type Type of the Value object.
@return Service return status.
*/
CMPIStatus (*returnData)
(const CMPIResult * rslt, const CMPIValue * value, const CMPIType type);
/** Return a Instance object.
@param rslt Result this pointer.
@param inst Instance to be returned.
@return Service return status.
*/
CMPIStatus (*returnInstance)
(const CMPIResult * rslt, const CMPIInstance * inst);
/** Return a ObjectPath object.
@param rslt Result this pointer.
@param ref ObjectPath to be returned.
@return Service return status.
*/
CMPIStatus (*returnObjectPath)
(const CMPIResult * rslt, const CMPIObjectPath * ref);
/** Indicates no further data to be returned.
@param rslt Result this pointer.
@return Service return status.
*/
CMPIStatus (*returnDone) (const CMPIResult * rslt);
# ifdef CMPI_VER_200
/** Return a CMPIError object instance
@param rslt Result this pointer.
@param er Error to be returned.
@return Service return status.
*/
CMPIStatus (*returnError)(const CMPIResult* rslt,
const CMPIError* er);
# endif
};
# ifdef CMPI_VER_200
struct _CMPIError {
void *hdl;
CMPIErrorFT *ft;
};
//---------------------------------------------------
//--
// _CMPIErrorFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Error
support services.
*/
struct _CMPIErrorFT {
/** Function table version
*/
CMPISint32 ftVersion;
/** The Error object will not be used any further and may be freed by
CMPI run time system.
@param er Error this pointer.
@return Service return status.
*/
CMPIStatus (*release)(CMPIError*);
/** Create an independent copy of this Error object.
@param er Error this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied Error object.
*/
CMPIError* (*clone)(const CMPIError*, CMPIStatus*);
/** Gets the type of this Error
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return the error type this Error object conatins
*/
CMPIErrorType (*getErrorType)(const CMPIError*, CMPIStatus*);
/** Returns a string which describes the alternate error type.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A string, which can be NULL
*/
CMPIString* (*getOtherErrorType)(const CMPIError*, CMPIStatus*);
/** Returns a string which describes the owneing entity
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A string, which can be NULL
*/
CMPIString* (*getOwningEntity)(const CMPIError*, CMPIStatus*);
/** Returns a string which is the message ID.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A string, which can be NULL
*/
CMPIString* (*getMessageID)(const CMPIError*, CMPIStatus*);
/** Returns a string comnating an error message.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A string, which can be NULL
*/
CMPIString* (*getMessage)(const CMPIError*, CMPIStatus*);
/** Returns the perceieved severity of this error.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return the perceived severity
*/
CMPIErrorSeverity (*getPerceivedSeverity)(const CMPIError*, CMPIStatus*);
/** Returns the probable cause of this error.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A probable cause value
*/
CMPIErrorProbableCause (*getProbableCause)(const CMPIError*, CMPIStatus*);
/** Returns a string which describes the probable cause.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A string, which can be NULL
*/
CMPIString* (*getProbableCauseDescription)(const CMPIError*, CMPIStatus*);
/** Returns an array of strings which describes recomended actions.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A array of strings, which can be NULL
*/
CMPIArray* (*getRecommendedActions)(const CMPIError*, CMPIStatus*);
/** Returns a string which describes the Error source.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A string, which can be NULL
*/
CMPIString* (*getErrorSource)(const CMPIError*, CMPIStatus*);
/** Returns a the format that the error src is in.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A error source format code
*/
CMPIErrorSrcFormat (*getErrorSourceFormat)(const CMPIError*, CMPIStatus*);
/** Returns a string which describes the 'other' format, only available if the error source is OTHER.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A string, which can be NULL
*/
CMPIString* (*getOtherErrorSourceFormat)(const CMPIError*, CMPIStatus*);
/** Returns the status code of this error.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A CMPI Status code
*/
CMPIrc (*getCIMStatusCode)(const CMPIError*, CMPIStatus*);
/** Returns a string which describes the status code error.
@param er Error this pointer
@param rc Output: Service return status (suppressed when NULL).
@return A string, which can be NULL
*/
CMPIString* (*getCIMStatusCodeDescription)(const CMPIError*, CMPIStatus*);
/** Returns an array which contains the dynamic content of the message.
@param er The Error this pointer
@param rc Output: Serbice return status (surpressed when NULL)
@return An array of CMPIStrings which represents the dynamic values
*/
CMPIArray* (*getMessageArguments)(const CMPIError*, CMPIStatus*);
/** Sets the error type of this error object.
@param er Error this pointer
@param et The error type
@return Output: Service return status
*/
CMPIStatus (*setErrorType)(CMPIError*, const CMPIErrorType);
/** Sets the 'other' error type of this error object.
@param er Error this pointer
@param oet A string which describes the error type, it is only valis when error type is "OTHER"
@return Output: Service return status
*/
CMPIStatus (*setOtherErrorType)(CMPIError*, const char *);
/** Sets the description of the probable cause.
@param er Error this pointer
@param pc The probable cause string
@return Output: Service return status
*/
CMPIStatus (*setProbableCauseDescription)(CMPIError*, const char *);
/** Sets the recomended actions array.
@param er Error this pointer
@param ar An array of strings describing actions that shoudl be taken to deal with this error
@return Output: Service return status
*/
CMPIStatus (*setRecommendedActions)(CMPIError*, const CMPIArray*);
/** Specifies a string which specifes The identifying information of the entity (i.e., the instance) generating the error..
@param er Error this pointer
@param es the string which describes the source
@return Output: Service return status
*/
CMPIStatus (*setErrorSource)(CMPIError*, const char*);
/** Sets the source format of the error object
@param er Error this pointer
@param esf the string which describes the source format
@return Output: Service return status
*/
CMPIStatus (*setErrorSourceFormat)(CMPIError*, const CMPIErrorSrcFormat );
/** specifies A string defining "Other" values for ErrorSourceFormat
@param er Error this pointer
@param oef the string which describes the other source format
@return Output: Service return status
*/
CMPIStatus (*setOtherErrorSourceFormat)(CMPIError*, const char*);
/** Sets the description of the status code.
@param er Error this pointer
@param scd A string whcih describes the status code.
@return Output: Service return status
*/
CMPIStatus (*setCIMStatusCodeDescription)(CMPIError*, const char*);
/** Sets an array of strings for the dynamic content of the message
@param er Error this pointer
@param values Specifies an array of CMPIStrings containing the dynamic
content of the message.
@return Service return status
*/
CMPIStatus (*setMessageArguments)(CMPIError*, CMPIArray*);
};
# endif /* CMPI_VER_200 */
//---------------------------------------------------
//--
// _CMPIInstance Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated Instance object.
*/
struct _CMPIInstance
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the Instance Function Table.
*/
CMPIInstanceFT *ft;
};
//---------------------------------------------------
//--
// _CMPIInstance Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Instance
support sevices.
*/
struct _CMPIInstanceFT
{
/** Function table version
*/
int ftVersion;
/** The Instance object will not be used any further and may be freed by
CMPI run time system. This will also release the contained objects.
@param inst Instance this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIInstance * inst);
/** Create an independent copy of this Instance object. The resulting
object must be released explicitly.
@param inst Instance this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied Instance object.
*/
CMPIInstance *(*clone) (const CMPIInstance * inst, CMPIStatus * rc);
/** Gets a named property value.
@param inst Instance this pointer.
@param name Property name.
@param rc Output: Service return status (suppressed when NULL).
@return Property value.
*/
CMPIData (*getProperty)
(const CMPIInstance * inst, const char *name, CMPIStatus * rc);
/** Gets a Property value defined by its index.
@param inst Instance this pointer.
@param index Position in the internal Data array.
@param name Output: Returned property name (suppressed when NULL).
@param rc Output: Service return status (suppressed when NULL).
@return Property value.
*/
CMPIData (*getPropertyAt)
(const CMPIInstance * inst, CMPICount index, CMPIString ** name,
CMPIStatus * rc);
/** Gets the number of properties contained in this Instance.
@param inst Instance this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Number of properties.
*/
CMPICount (*getPropertyCount)
(const CMPIInstance * inst, CMPIStatus * rc);
/** Adds/replaces a named Property.
@param inst Instance this pointer.
@param name Entry name.
@param value Address of value structure.
@param type Value type.
@return Service return status.
*/
CMPIStatus (*setProperty)
(const CMPIInstance * inst, const char *name,
const CMPIValue * value, CMPIType type);
/** Generates an ObjectPath out of the namespace, classname and
key propeties of this Instance.
@param inst Instance this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return the generated ObjectPath.
*/
CMPIObjectPath *(*getObjectPath)
(const CMPIInstance * inst, CMPIStatus * rc);
/** Directs CMPI to ignore any setProperty operations for this
instance for any properties not in this list.
@param inst Instance this pointer.
@param propertyList If not NULL, the members of the array define one
or more Property names to be accepted by setProperty operations.
@param keys Deprecated, ignored by MB, maintained here for compatibility.
@return Service return status.
*/
CMPIStatus (*setPropertyFilter)
(CMPIInstance * inst, const char **propertyList, const char **keys);
/** Set/replace the ObjectPath component in an instance.
@param inst The CMPIInstance structure containing a
complete instance.
@parmm op The CMPIObjectPath structure. This objectpath
shall contain the namespace,classname, as well as all
keys for the specified instance.
@return Service return status.
*/
CMPIStatus (*setObjectPath) (CMPIInstance * inst,
const CMPIObjectPath * op);
#ifdef CMPI_VER_200
/** add/replace a named Property value and origin
@param inst is a pointer to the CMPIInstance structure.
@param name is a string containing the Property name.
@param value points to a CMPIValue structure containing the value
to be assigned to the Property.
@param type is a CMPIType structure defining the type of the value.
@param origin specifies the instance origin. If NULL, then
no origin is attached to the property
@return Service return status
*/
CMPIStatus (*setPropertyWithOrigin)(const CMPIInstance*, const char*,
const CMPIValue*, const CMPIType, const char*);
#endif /* CMPI_VER_200 */
};
//---------------------------------------------------
//--
// _CMPIObjectPath Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated Instance object.
*/
struct _CMPIObjectPath
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the ObjectPath Function Table.
*/
CMPIObjectPathFT *ft;
};
//---------------------------------------------------
//--
// _CMPIObjectPath Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to ObjectPath
support sevices.
*/
struct _CMPIObjectPathFT
{
/** Function table version
*/
int ftVersion;
/** The ObjectPath object will not be used any further and may be freed by
CMPI run time system.
@param op ObjectPath this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIObjectPath * op);
/** Create an independent copy of this ObjectPath object. The resulting
object must be released explicitly.
@param op ObjectPath this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied ObjectPath object.
*/
CMPIObjectPath *(*clone) (const CMPIObjectPath * op, CMPIStatus * rc);
/** Set/replace the namespace component.
@param op ObjectPath this pointer.
@param ns The namespace string
@return Service return status.
*/
CMPIStatus (*setNameSpace) (CMPIObjectPath * op, const char *ns);
/** Get the namespace component.
@param op ObjectPath this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return The namespace component.
*/
CMPIString *(*getNameSpace) (const CMPIObjectPath * op, CMPIStatus * rc);
/** Set/replace the hostname component.
@param op ObjectPath this pointer.
@param hn The hostname string
@return Service return status.
*/
CMPIStatus (*setHostname) (CMPIObjectPath * op, const char *hn);
/** Get the hostname component.
@param op ObjectPath this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return The hostname component.
*/
CMPIString *(*getHostname) (const CMPIObjectPath * op, CMPIStatus * rc);
/** Set/replace the classname component.
@param op ObjectPath this pointer.
@param cn The hostname string
@return Service return status.
*/
CMPIStatus (*setClassName) (CMPIObjectPath * op, const char *cn);
/** Get the classname component.
@param op ObjectPath this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return The classname component.
*/
CMPIString *(*getClassName) (const CMPIObjectPath * op, CMPIStatus * rc);
/** Adds/replaces a named key property.
@param op ObjectPath this pointer.
@param name Key property name.
@param value Address of value structure.
@param type Value type.
@return Service return status.
*/
CMPIStatus (*addKey)
(CMPIObjectPath * op, const char *name,
const CMPIValue * value, const CMPIType type);
/** Gets a named key property value.
@param op ObjectPath this pointer.
@param name Key property name.
@param rc Output: Service return status (suppressed when NULL).
@return Entry value.
*/
CMPIData (*getKey)
(const CMPIObjectPath * op, const char *name, CMPIStatus * rc);
/** Gets a key property value defined by its index.
@param op ObjectPath this pointer.
@param index Position in the internal Data array.
@param name Output: Returned property name (suppressed when NULL).
@param rc Output: Service return status (suppressed when NULL).
@return Data value.
*/
CMPIData (*getKeyAt)
(const CMPIObjectPath * op, CMPICount index, CMPIString ** name,
CMPIStatus * rc);
/** Gets the number of key properties contained in this ObjectPath.
@param op ObjectPath this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Number of properties.
*/
CMPICount (*getKeyCount) (const CMPIObjectPath * op, CMPIStatus * rc);
/** Set/replace namespace and classname components from <src>.
@param op ObjectPath this pointer.
@param src Source input.
@return Service return status.
*/
CMPIStatus (*setNameSpaceFromObjectPath)
(CMPIObjectPath * op, const CMPIObjectPath * src);
/** Set/replace hostname, namespace and classname components from <src>.
@param op ObjectPath this pointer.
@param src Source input.
@return Service return status.
*/
CMPIStatus (*setHostAndNameSpaceFromObjectPath)
(CMPIObjectPath * op, const CMPIObjectPath * src);
// optional qualifier support
/** Get class qualifier value.
@param op ObjectPath this pointer.
@param qName Qualifier name.
@param rc Output: Service return status (suppressed when NULL).
@return Qualifier value.
*/
CMPIData (*getClassQualifier)
(const CMPIObjectPath * op, const char *qName, CMPIStatus * rc);
/** Get property qualifier value.
@param op ObjectPath this pointer.
@param pName Property name.
@param qName Qualifier name.
@param rc Output: Service return status (suppressed when NULL).
@return Qualifier value.
*/
CMPIData (*getPropertyQualifier)
(const CMPIObjectPath * op,
const char *pName, const char *qName, CMPIStatus * rc);
/** Get method qualifier value.
@param op ObjectPath this pointer.
@param mName Method name.
@param qName Qualifier name.
@param rc Output: Service return status (suppressed when NULL).
@return Qualifier value.
*/
CMPIData (*getMethodQualifier)
(const CMPIObjectPath * op,
const char *methodName, const char *qName, CMPIStatus * rc);
/** Get method parameter quailifier value.
@param op ObjectPath this pointer.
@param mName Method name.
@param pName Parameter name.
@param qName Qualifier name.
@param rc Output: Service return status (suppressed when NULL).
@return Qualifier value.
*/
CMPIData (*getParameterQualifier)
(const CMPIObjectPath * op,
const char *mName,
const char *pName, const char *qName, CMPIStatus * rc);
/** Generates a well formed string representation of this ObjectPath
@param op ObjectPath this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return String representation.
*/
CMPIString *(*toString) (const CMPIObjectPath * op, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPISelectExp Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated SelectExp object.
*/
struct _CMPISelectExp
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the SelExp Function Table.
*/
CMPISelectExpFT *ft;
};
//---------------------------------------------------
//--
// _CMPISelectExpFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to SelectExp
support sevices.
*/
struct _CMPISelectExpFT
{
/** Function table version
*/
int ftVersion;
/** The SelectExp object will not be used any further and may be freed by
CMPI run time system.
@param se SelectExp this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPISelectExp * se);
/** Create an independent copy of this SelectExp object. The resulting
object must be released explicitly.
@param se SelectExp this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied SelectExp object.
*/
CMPISelectExp *(*clone) (const CMPISelectExp * se, CMPIStatus * rc);
/** Evaluate the instance using this select expression.
@param se SelectExp this pointer.
@param inst Instance to be evaluated.
@param rc Output: Service return status (suppressed when NULL).
@return True or false incicator.
*/
CMPIBoolean (*evaluate)
(const CMPISelectExp * se, const CMPIInstance * inst, CMPIStatus * rc);
/** Return the select expression in string format.
@param se SelectExp this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return The select expression.
*/
CMPIString *(*getString) (const CMPISelectExp * se, CMPIStatus * rc);
/** Return the select expression as disjunction of conjunctions.
@param se SelectExp this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return The disjunction.
*/
CMPISelectCond *(*getDOC) (const CMPISelectExp * se, CMPIStatus * rc);
/** Return the select expression as conjunction of disjunctions.
@param se SelectExp this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return The conjunction.
*/
CMPISelectCond *(*getCOD) (const CMPISelectExp * se, CMPIStatus * rc);
/** Evaluate this select expression by using a data value accessor routine.
@param se SelectExp this pointer.
@param accessor Address of data accessor routine.
@param parm Data accessor routine parameter.
@param rc Output: Service return status (suppressed when NULL).
@return True or false incicator.
*/
CMPIBoolean (*evaluateUsingAccessor)
(const CMPISelectExp * se, CMPIAccessor * accessor, void *parm,
CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPISelectCond Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated SelectCond object.
*/
struct _CMPISelectCond
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the SelCond Function Table.
*/
CMPISelectCondFT *ft;
};
//---------------------------------------------------
//--
// _CMPISelectCondFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to SelectCond
support sevices.
*/
struct _CMPISelectCondFT
{
/** Function table version
*/
const int ftVersion;
/** The SelectCond object will not be used any further and may be freed by
CMPI run time system.
@param sc SelectCond this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPISelectCond * sc);
/** Create an independent copy of this SelectCond object. The resulting
object must be released explicitly.
@param sc SelectCond this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied SelectExp object.
*/
CMPISelectCond *(*clone) (const CMPISelectCond * sc, CMPIStatus * rc);
/** Return the number of sub conditions that are part of this SelectCond.
Optionally, the SelectCond type (COD or DOC) will be returned.
@param sc SelectCond this pointer.
@param type Output: SelectCond type (suppressed when NULL).
@param rc Output: Service return status (suppressed when NULL).
@return Number of SubCond elements.
*/
CMPICount (*getCountAndType)
(const CMPISelectCond * sc, int* type, CMPIStatus * rc);
/** Return a SubCond element based on its index.
@param sc SelectCond this pointer.
@param index Position in the internal SubCoind array.
@param rc Output: Service return status (suppressed when NULL).
@return The indexed SubCond element.
*/
CMPISubCond *(*getSubCondAt)
(const CMPISelectCond * sc, CMPICount index, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPISubCond Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated SubCond object.
*/
struct _CMPISubCond
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the SubCond Function Table.
*/
CMPISubCondFT *ft;
};
//---------------------------------------------------
//--
// _CMPISubCondFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to SubCond
support sevices.
*/
struct _CMPISubCondFT
{
/** Function table version
*/
int ftVersion;
/** The SubCond object will not be used any further and may be freed by
CMPI run time system.
@param sc SubCond this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPISubCond * sc);
/** Create an independent copy of this SubCond object. The resulting
object must be released explicitly.
@param se SubCond this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied SelectExp object.
*/
CMPISubCond *(*clone) (const CMPISubCond * sc, CMPIStatus * rc);
/** Return the number of predicates that are part of sub condition.
@param sc SubCond this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Number of Predicate elements.
*/
CMPICount (*getCount) (const CMPISubCond * sc, CMPIStatus * rc);
/** Return a Predicate element based on its index.
@param sc SubCond this pointer.
@param index Position in the internal Predicate array.
@param rc Output: Service return status (suppressed when NULL).
@return The indexed Predicate element.
*/
CMPIPredicate *(*getPredicateAt)
(const CMPISubCond * sc, CMPICount index, CMPIStatus * rc);
/** Return a named Predicate element.
@param sc SubCond this pointer.
@param name Predicate name (property name).
@param rc Output: Service return status (suppressed when NULL).
@return The named Predicate element.
*/
CMPIPredicate *(*getPredicate)
(const CMPISubCond * sc, const char *name, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPIPredicate Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated Predicate object.
*/
struct _CMPIPredicate
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the Predicate Function Table.
*/
CMPIPredicateFT *ft;
};
//---------------------------------------------------
//--
// _CMPIPredicateFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to SubCond
support sevices.
*/
struct _CMPIPredicateFT
{
/** Function table version
*/
int ftVersion;
/** The Predicate object will not be used any further and may be freed by
CMPI run time system.
@param pr Predicate this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIPredicate * pr);
/** Create an independent copy of this Predicate object. The resulting
object must be released explicitly.
@param pr Predicate this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied Predicate object.
*/
CMPIPredicate *(*clone) (const CMPIPredicate * pr, CMPIStatus * rc);
/** Get the predicate components.
@param pr Predicate this pointer.
@param type Property type.
@param op Predicate operation.
@param lhs Left hand side of predicate.
@param rhs Right hand side of predicate.
@return Service return status.
*/
CMPIStatus (*getData)
(const CMPIPredicate * pr, CMPIType * type,
CMPIPredOp * op, CMPIString ** lhs, CMPIString ** rhs);
/** Evaluate the predicate using a property data accessor function.
@param pr Predicate this pointer.
@param accessorFnc Pointer to a property value accessor function. The evaluation
process will invoke this function to request a CMPIData structure for a particular
property. The signature of the accessor function is:
CMPIData CMPIAccessor(const char* propertyName, void* parm);
@param parm Parameter that will be passed to the accessor function and can be
used for providing context data to the accessor function.
@param rc Output: Service return status (suppressed when NULL).
@return Evaluation result.
*/
CMPIBoolean (*evaluateUsingAccessor)
(const CMPIPredicate * pr, CMPIAccessor * accessorFnc, void *parm,
CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPIArgs Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated Args object.
*/
struct _CMPIArgs
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the Args Function Table.
*/
CMPIArgsFT *ft;
};
//---------------------------------------------------
//--
// _CMPIArgsFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Args
support sevices.
*/
struct _CMPIArgsFT
{
/** Function table version
*/
int ftVersion;
/** The Args object will not be used any further and may be freed by
CMPI run time system.
@param as Args this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIArgs * as);
/** Create an independent copy of this Args object. The resulting
object must be released explicitly.
@param as Args this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied Args object.
*/
CMPIArgs *(*clone) (const CMPIArgs * as, CMPIStatus * rc);
/** Adds/replaces a named argument.
@param as Args this pointer.
@param name Argument name.
@param value Address of value structure.
@param type Value type.
@return Service return status.
*/
CMPIStatus (*addArg)
(const CMPIArgs * as, const char *name, const CMPIValue * value,
const CMPIType type);
/** Gets a named argument value.
@param as Args this pointer.
@param name Argument name.
@param rc Output: Service return status (suppressed when NULL).
@return Argument value.
*/
CMPIData (*getArg)
(const CMPIArgs * as, const char *name, CMPIStatus * rc);
/** Gets a Argument value defined by its index.
@param as Args this pointer.
@param index Position in the internal Data array.
@param name Output: Returned argument name (suppressed when NULL).
@param rc Output: Service return status (suppressed when NULL).
@return Argument value.
*/
CMPIData (*getArgAt)
(const CMPIArgs * as, CMPICount index, CMPIString ** name,
CMPIStatus * rc);
/** Gets the number of arguments contained in this Args.
@param as Args this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Number of properties.
*/
CMPICount (*getArgCount) (const CMPIArgs * as, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPIString Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated String object.
*/
struct _CMPIString
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the String Function Table.
*/
CMPIStringFT *ft;
};
//---------------------------------------------------
//--
// _CMPIStringFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to String
support sevices.
*/
struct _CMPIStringFT
{
/** Function table version
*/
int ftVersion;
/** The String object will not be used any further and may be freed by
CMPI run time system.
@param st String this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIString * st);
/** Create an independent copy of this String object. The resulting
object must be released explicitly.
@param st String this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied String object.
*/
CMPIString *(*clone) (const CMPIString * st, CMPIStatus * rc);
/** Get a pointer to a C char *representation of this String.
@param st String this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to char *representation.
*/
const char *(*getCharPtr) (const CMPIString * st, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPIArray Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated Array object.
*/
struct _CMPIArray
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the Array Function Table.
*/
CMPIArrayFT *ft;
};
//---------------------------------------------------
//--
// _CMPIArrayFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Array
support sevices.
*/
struct _CMPIArrayFT
{
/** Function table version
*/
int ftVersion;
/** The Array object will not be used any further and may be freed by
CMPI run time system.
@param ar Array this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIArray * ar);
/** Create an independent copy of this Array object. The resulting
object must be released explicitly.
@param ar Array this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied Array object.
*/
CMPIArray *(*clone) (const CMPIArray * ar, CMPIStatus * rc);
/** Gets the number of elements contained in this Array.
@param ar Array this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Number of elements.
*/
CMPICount (*getSize) (const CMPIArray * ar, CMPIStatus * rc);
/** Gets the element type.
@param ar Array this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Number of elements.
*/
CMPIType (*getSimpleType) (const CMPIArray * ar, CMPIStatus * rc);
/** Gets an element value defined by its index.
@param ar Array this pointer.
@param index Position in the internal Data array.
@param rc Output: Service return status (suppressed when NULL).
@return Element value.
*/
CMPIData (*getElementAt)
(const CMPIArray * ar, CMPICount index, CMPIStatus * rc);
/** Sets an element value defined by its index.
@param ar Array this pointer.
@param index Position in the internal Data array.
@param value Address of value structure.
@param type Value type.
@return Service return status.
*/
CMPIStatus (*setElementAt)
(CMPIArray * ar, CMPICount index, const CMPIValue * value,
CMPIType type);
};
//---------------------------------------------------
//--
// _CMPIEnumeration Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the Encapsulated Enumeration object.
*/
struct _CMPIEnumeration
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the Enumeration Function Table.
*/
CMPIEnumerationFT *ft;
};
//---------------------------------------------------
//--
// _CMPIEnumerationFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Enumeration
support sevices.
*/
struct _CMPIEnumerationFT
{
/** Function table version
*/
int ftVersion;
/** The Enumeration object will not be used any further and may be freed by
CMPI run time system.
@param en Enumeration this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIEnumeration * en);
/** Create an independent copy of this Enumeration object. The resulting
object must be released explicitly.
@param en Enumeration this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied Enumeration object.
*/
CMPIEnumeration *(*clone) (const CMPIEnumeration * en, CMPIStatus * rc);
/** Get the next element of this Enumeration.
@param en Enumeration this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Element value.
*/
CMPIData (*getNext) (const CMPIEnumeration * en, CMPIStatus * rc);
/** Test for any elements left in this Enumeration.
@param en Enumeration this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return True or false.
*/
CMPIBoolean (*hasNext) (const CMPIEnumeration * en, CMPIStatus * rc);
/** Convert this Enumeration into an Array.
@param en Enumeration this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return The Array.
*/
CMPIArray *(*toArray) (const CMPIEnumeration * en, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPIDateTime Encapsulated object
//--
//---------------------------------------------------
/** This structure represents the DateTime object.
*/
struct _CMPIDateTime
{
/** Opaque pointer to MB specific implementation data.
*/
void *hdl;
/** Pointer to the DateTime Function Table.
*/
CMPIDateTimeFT *ft;
};
//---------------------------------------------------
//--
// _CMPIDateTimeFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to DateTime
support sevices.
*/
struct _CMPIDateTimeFT
{
/** Function table version
*/
int ftVersion;
/** The DateTime object will not be used any further and may be freed by
CMPI run time system.
@param dt DateTime this pointer.
@return Service return status.
*/
CMPIStatus (*release) (CMPIDateTime * dt);
/** Create an independent copy of this DateTime object. The resulting
object must be released explicitly.
@param dt DateTime this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return Pointer to copied DateTime object.
*/
CMPIDateTime *(*clone) (const CMPIDateTime * dt, CMPIStatus * rc);
/** Get DateTime setting in binary format (in microsecods
starting since 00:00:00 GMT, Jan 1,1970).
@param dt DateTime this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return DateTime in binary.
*/
CMPIUint64 (*getBinaryFormat) (const CMPIDateTime * dt,
CMPIStatus * rc);
/** Get DateTime setting in UTC string format.
@param dt DateTime this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return DateTime as UTC string.
*/
CMPIString *(*getStringFormat) (const CMPIDateTime * dt, CMPIStatus * rc);
/** Tests whether DateTime is an interval value.
@param dt DateTime this pointer.
@param rc Output: Service return status (suppressed when NULL).
@return True if interval value.
*/
CMPIBoolean (*isInterval) (const CMPIDateTime * dt, CMPIStatus * rc);
};
//---------------------------------------------------
//--
// _CMPIInstanceMI Instance Provider object
//--
//---------------------------------------------------
/** This structure represents an Instance provider.
*/
typedef struct _CMPIInstanceMIFT CMPIInstanceMIFT;
typedef struct _CMPIInstanceMI
{
/** Opaque pointer to Provider specific implementation data.
*/
const void *hdl;
/** Pointer to the Instance Provider Function Table.
*/
CMPIInstanceMIFT *ft;
} CMPIInstanceMI;
//---------------------------------------------------
//--
// _CMPIInstanceMIFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Instance
provider functions. This table must be returend during initialization
by the provider.
*/
struct _CMPIInstanceMIFT
{
/** Function table version
*/
int ftVersion;
/** Provider version
*/
int miVersion;
/** Provider name
*/
const char *miName;
/** The CMPIInstanceMIFT.cleanup() function shall perform any necessary cleanup
operation prior to the unloading of the library of which this MI group is part.
This function is called prior to the unloading of the provider.
@param mi The mi argument is a pointer to a CMPIInstanceMI structure.
@param ctx The ctx argument is a pointer to a CMPIContext structure containing the Invocation
Context.
@param terminating When true, the terminating argument indicates that the MB is in the process of
terminating and that cleanup must be done. When set to false, the MI may respond with
CMPI_IRC_DO_NOT_UNLOAD, or CMPI_IRC_NEVER_UNLOAD, indicating that unload will
interfere with current MI processing.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_DO_NOT_UNLOAD Operation successful - do not unload now.
CMPI_RC_NEVER_UNLOAD Operation successful - never unload.o
*/
CMPIStatus (*cleanup)
(CMPIInstanceMI * mi, const CMPIContext * ctx, CMPIBoolean terminating);
/** Enumerate ObjectPaths of Instances serviced by this provider.
@param mi Provider this pointer.
@param ctx Invocation Context.
@param rslt Result data container.
@param op ObjectPath containing namespace and classname components.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
*/
CMPIStatus (*enumerateInstanceNames)
(CMPIInstanceMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op);
/** Enumerate the Instances serviced by this provider.
@param mi Provider this pointer.
@param ctx Invocation Context.
@param rslt Result data container.
@param op ObjectPath containing namespace and classname components.
@param properties If not NULL, the members of the array define one or
more Property names. Each returned Object MUST NOT include elements
for any Properties missing from this list.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
*/
CMPIStatus (*enumerateInstances)
(CMPIInstanceMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op, const char **properties);
/** Get the Instances defined by <op>.
@param mi Provider this pointer.
@param ctx Invocation Context.
@param rslt Result data container.
@param op ObjectPath containing namespace, classname and key components.
@param properties If not NULL, the members of the array define one or
more Property names. Each returned Object MUST NOT include elements
for any Properties missing from this list.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
*/
CMPIStatus (*getInstance)
(CMPIInstanceMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op, const char **properties);
/** Create Instance from <inst> using <op> as reference.
@param mi Provider this pointer.
@param ctx Invocation Context.
@param rslt Result data container.
@param op ObjectPath containing namespace, classname and key components.
@param inst The Instance.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ALREADY_EXISTS Instance already exists.
*/
CMPIStatus (*createInstance)
(CMPIInstanceMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op, const CMPIInstance * inst);
/** Replace an existing Instance from <inst> using <op> as reference.
@param mi Provider this pointer.
@param ctx Invocation Context.
@param rslt Result data container.
@param op ObjectPath containing namespace, classname and key components.
@param inst The Instance.
@param properties If not NULL, the members of the array define one or
more Property names. The process MUST NOT replace elements
for any Properties missing from this list. If NULL all properties
will be replaced.
@return Function return status.
*/
CMPIStatus (*modifyInstance)
(CMPIInstanceMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op, const CMPIInstance * inst,
const char **properties);
/** Delete an existing Instance defined by <op>.
@param mi Provider this pointer.
@param ctx Invocation Context.
@param rslt Result data container.
@param op ObjectPath containing namespace, classname and key components.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
*/
CMPIStatus (*deleteInstance)
(CMPIInstanceMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op);
/** Query the enumeration of instances of the class (and subclasses) defined
by <op> using <query> expression.
@param mi Provider this pointer.
@param ctx Context object
@param rslt Result data container.
@param op ObjectPath containing namespace and classname components.
@param query Query expression
@param lang Query language
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_QUERY_LANGUAGE_NOT_SUPPORTED Query language not supported.
CMPI_RC_ERR_INVALID_QUERY Invalid query.
*/
CMPIStatus (*execQuery)
(CMPIInstanceMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op, const char *query, const char *lang);
};
//---------------------------------------------------
//--
// _CMPIAssociationMI Association Provider object
//--
//---------------------------------------------------
/** This structure represents an Association provider.
*/
typedef struct _CMPIAssociationMIFT CMPIAssociationMIFT;
typedef struct _CMPIAssociationMI
{
/** Opaque pointer to Provider specific implementation data.
*/
void *hdl;
/** Pointer to the Association Provider Function Table.
*/
CMPIAssociationMIFT *ft;
} CMPIAssociationMI;
//---------------------------------------------------
//--
// _CMPIAssociationMIFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Association
provider functions. This table must be returend during initialization
by the provider.
*/
struct _CMPIAssociationMIFT
{
/** Function table version
*/
int ftVersion;
/** Provider version
*/
const CMPISint32 miVersion;
/** Provider name
*/
const char *miName;
/** Cleanup is called prior to unloading of the provider.
This function shall perform any necessary cleanup
operations prior to the unloading of the library of which this MI group is part.
@param mi This argument is a pointer to a CMPIAssociationMI structure.
@param ctx This argument is a pointer to a CMPIContext structure containing the Invocation Context.
@param terminating When true, the terminating argument indicates that the MB is in the process of
terminating and that cleanup must be done. When set to false, the MI may respond with
CMPI_IRC_DO_NOT_UNLOAD, or CMPI_IRC_NEVER_UNLOAD, indicating that unload will
interfere with current MI processing.
@return Function return status. The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_DO_NOT_UNLOAD Operation successful - do not unload now.
CMPI_RC_NEVER_UNLOAD Operation successful - never unload.
*/
CMPIStatus (*cleanup)
(CMPIAssociationMI * mi, const CMPIContext * ctx,
CMPIBoolean terminating);
/** Enumerate ObjectPaths associated with the Instance defined by <op>.
@param mi Provider this pointer.
@param ctx Invocation Context
@param rslt Result data container.
@param op Source ObjectPath containing namespace, classname and key components.
@param assocClass If not NULL, MUST be a valid Association Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be associated to the source Object via an
Instance of this Class or one of its subclasses.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param resultRole If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the returned Object plays the specified role
(i.e. the name of the Property in the Association Class that refers to
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list. If NULL all properties must be returned.
the returned Object MUST match the value of this parameter).
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
*/
CMPIStatus (*associators)
(CMPIAssociationMI * mi, const CMPIContext * ctx,
const CMPIResult * rslt, const CMPIObjectPath * op,
const char *asscClass, const char *resultClass, const char *role,
const char *resultRole, const char **properties);
/** Enumerate ObjectPaths associated with the Instance defined by <op>.
@param mi Provider this pointer.
@param ctx Invocation Context
@param rslt Result data container.
@param op Source ObjectPath containing namespace, classname and key components.
@param assocClass If not NULL, MUST be a valid Association Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be associated to the source Object via an
Instance of this Class or one of its subclasses.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param resultRole If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the returned Object plays the specified role
(i.e. the name of the Property in the Association Class that refers to
the returned Object MUST match the value of this parameter).
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
*/
CMPIStatus (*associatorNames)
(CMPIAssociationMI * mi, const CMPIContext * ctx,
const CMPIResult * rslt, const CMPIObjectPath * op,
const char *assocClass, const char *resultClass, const char *role,
const char *resultRole);
/** Enumerates the association instances that refer to the instance defined by
<op>.
@param mi Provider this pointer.
@param ctx Invocation Context
@param rslt Result data container.
@param op Source ObjectPath containing namespace, classname and key components.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@param properties If not NULL, the members of the array define one or more Property
names. Each returned Object MUST NOT include elements for any Properties
missing from this list
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
*/
CMPIStatus (*references)
(CMPIAssociationMI * mi, const CMPIContext * ctx,
const CMPIResult * rslt, const CMPIObjectPath * op,
const char *resultClass, const char *role, const char **properties);
/** Enumerates the association ObjectPaths that refer to the instance defined by
<op>.
@param mi Provider this pointer.
@param ctx Invocation Context
@param rslt Result data container.
@param op Source ObjectPath containing namespace, classname and key components.
@param resultClass If not NULL, MUST be a valid Class name.
It acts as a filter on the returned set of Objects by mandating that
each returned Object MUST be either an Instance of this Class (or one
of its subclasses).
@param role If not NULL, MUST be a valid Property name.
It acts as a filter on the returned set of Objects by mandating
that each returned Object MUST be associated to the source Object
via an Association in which the source Object plays the specified role
(i.e. the name of the Property in the Association Class that refers
to the source Object MUST match the value of this parameter).
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
*/
CMPIStatus (*referenceNames)
(CMPIAssociationMI * mi, const CMPIContext * ctx,
const CMPIResult * rslt, const CMPIObjectPath * op,
const char *resultClass, const char *role);
};
//---------------------------------------------------
//--
// _CMPIMethodMI Method Provider object
//--
//---------------------------------------------------
/** This structure represents an Method provider.
*/
typedef struct _CMPIMethodMIFT CMPIMethodMIFT;
typedef struct _CMPIMethodMI
{
/** Opaque pointer to Provider specific implementation data.
*/
void *hdl;
/** Pointer to the Method Provider Function Table.
*/
CMPIMethodMIFT *ft;
} CMPIMethodMI;
//---------------------------------------------------
//--
// _CMPIMethodMIFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Method
provider functions. This table must be returend during initialization
by the provider.
*/
struct _CMPIMethodMIFT
{
/** Function table version
*/
int ftVersion;
/** Provider version
*/
int miVersion;
/** Provider name
*/
const char *miName;
/** The CMPIMethodMIFT.cleanup() function shall perform any necessary cleanup operation
prior to the unloading of the library of which this MI group is part. This function is called
prior to the unloading of the provider.
@param mi The mi argument is a pointer to a CMPIMethodMI structure.
@param ctx The ctx argument is a pointer to a CMPIContext structure containing the Invocation
Context.
@param terminating When true, the terminating argument indicates that the MB is in the process of
terminating and that cleanup must be done. When set to false, the MI may respond with
CMPI_IRC_DO_NOT_UNLOAD, or CMPI_IRC_NEVER_UNLOAD, indicating that unload will
interfere with current MI processing.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_DO_NOT_UNLOAD Operation successful - do not unload now.
CMPI_RC_NEVER_UNLOAD Operation successful - never unload.
*/
CMPIStatus (*cleanup)
(CMPIMethodMI * mi, const CMPIContext * ctx, CMPIBoolean terminating);
/** Invoke a named, extrinsic method of an Instance
defined by the <op> parameter.
@param mi Provider this pointer.
@param ctx Invocation Context
@param rslt Result data container.
@param op ObjectPath containing namespace, classname and key components.
@param method Method name
@param in Input parameters.
@param out Output parameters.
@return Function return status. The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_NOT_FOUND Instance not found.
CMPI_RC_ERR_METHOD_NOT_AVAILABLE Method not available.
CMPI_RC_ERR_METHOD_NOT_FOUND Method not found.
*/
CMPIStatus (*invokeMethod)
(CMPIMethodMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op, const char *method, const CMPIArgs * in,
CMPIArgs * out);
};
//---------------------------------------------------
//--
// _CMPIPropertyMI Property Provider object
//--
//---------------------------------------------------
/** This structure represents an Property provider.
*/
typedef struct _CMPIPropertyMIFT CMPIPropertyMIFT;
typedef struct _CMPIPropertyMI
{
/** Opaque pointer to Provider specific implementation data.
*/
void *hdl;
/** Pointer to the Property Provider Function Table.
*/
CMPIPropertyMIFT *ft;
} CMPIPropertyMI;
//---------------------------------------------------
//--
// _CMPIPropertyMIFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Property
provider functions. This table must be returend during initialization
by the provider.
*/
struct _CMPIPropertyMIFT
{
/** Function table version
*/
int ftVersion;
/** Provider version
*/
int miVersion;
/** Provider name
*/
const char *miName;
/** Cleanup is called prior to unloading of the provider.
@param mi Provider this pointer.
@param ctx Invocation Context
@param terminating When true, the terminating argument indicates that the MB is in the process of
terminating and that cleanup must be done. When set to false, the MI may respond with
CMPI_IRC_DO_NOT_UNLOAD, or CMPI_IRC_NEVER_UNLOAD, indicating that unload will
interfere with current MI processing.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_DO_NOT_UNLOAD Operation successful - do not unload now.
CMPI_RC_NEVER_UNLOAD Operation successful - never unload.
*/
CMPIStatus (*cleanup)
(CMPIPropertyMI * mi, const CMPIContext * ctx, CMPIBoolean terminating);
/** Set the named property value of an Instance defined by the <op> parameter.
@param mi Provider this pointer.
@param ctx Invocation Context
@param rslt Result data container.
@param op ObjectPath containing namespace, classname and key components.
@param name Property name
@param data Property value.
@return Function return status. The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_TYPE_MISATCH type does not correspond to class-defined type.
CMPI_RC_ERR_INVALID_HANDLE The inst handle is invalid.
*/
CMPIStatus (*setProperty)
(CMPIPropertyMI * mi, const CMPIContext * ctx, const CMPIResult * rslt,
const CMPIObjectPath * op, const char *name, const CMPIData data);
/** Get the named property value of an Instance defined by the <op> parameter.
@param mi Provider this pointer.
@param ctx Invocation Context
@param rslt Result data container.
@param op ObjectPath containing namespace, classname and key components.
@param name Property name
@return Function return status. The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_INVALID_NAMESPACE The namespace is invalid.
CMPI_RC_ERR_INVALID_PARAMETER The parameter is invalid.
CMPI_RC_ERR_INVALID_CLASS The CIM class does not exist in the specified
namespace.
CMPI_RC_ERR_NOT_FOUND Instance not found.
CMPI_RC_ERR_NO_SUCH_PROPERTY Entry not found.
*/
CMPIStatus (*getProperty)
(CMPIPropertyMI *, const CMPIContext *, const CMPIResult *,
const CMPIObjectPath *, const char *name);
#ifdef CMPI_VER_200
/** add/replace a named Property value and origin
@param mi Provider this pointer.
@param ctx Invocation Context
@param rslt Result data container.
@param op ObjectPath containing namespace, classname and
key components
@param name Property name
@param data Property value.
@param origin specifies the instance origin. If NULL, then
no origin is attached to the property
@return Service return status
*/
CMPIStatus (*setPropertyWithOrigin)(CMPIPropertyMI*, const CMPIContext*,
const CMPIResult*, CMPIObjectPath * op,
const char *name, const CMPIData data, const char*);
#endif /* CMPI_VER_200 */
};
//---------------------------------------------------
//--
// _CMPIIndicationMI Indication Provider object
//--
//---------------------------------------------------
/** This structure represents an Indication provider.
*/
typedef struct _CMPIIndicationMIFT CMPIIndicationMIFT;
typedef struct _CMPIIndicationMI
{
/** Opaque pointer to Provider specific implementation data.
*/
void *hdl;
/** Pointer to the Property Provider Function Table.
*/
CMPIIndicationMIFT *ft;
} CMPIIndicationMI;
//---------------------------------------------------
//--
// _CMPIIndicationMIFT Function Table
//--
//---------------------------------------------------
/** This structure is a table of pointers providing access to Indication
provider functions. This table must be returend during initialization
by the provider.
*/
struct _CMPIIndicationMIFT
{
/** Function table version
*/
int ftVersion;
/** Provider version
*/
int miVersion;
/** Provider name
*/
const char *miName;
/** Cleanup is called prior to unloading of the provider.
This function shall perform any necessary cleanup
operation prior to the unloading of the library of which this MI group is part.
@param mi The mi argument is a pointer to a CMPIIndicationMI structure.
@param ctx The ctx argument is a pointer to a CMPIContext structure
containing the Invocation Context.
@param terminating When true, the terminating argument indicates that
the MB is in the process of terminating and that cleanup must be done.
When set to false, the MI may respond with
CMPI_RC_DO_NOT_UNLOAD, or CMPI_RC_NEVER_UNLOAD, indicating that
unload will interfere with current MI processing.
@return Function return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_DO_NOT_UNLOAD Operation successful do not unload now.
CMPI_RC_NEVER_UNLOAD Operation successful never unload
*/
CMPIStatus (*cleanup)
(CMPIIndicationMI * mi, const CMPIContext * ctx,
CMPIBoolean terminating);
/** Ask the provider to verify whether this filter is allowed.
@param mi The mi argument is a pointer to a CMPIIndicationMI structure.
@param ctx The ctx argument is a pointer to a CMPIContext structure
containing the Invocation Context.
@param filter Contains the filter that must be authorized.
@param className Contains the class name extracted from the filter FROM
clause.
@param op The name of the class for which monitoring is required. Only
the namespace part is set if className is a process indication.
@param owner The owner argument is the destination owner.
@return This function shall structure containing the service return
status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_INVALID_QUERY Invalid query or too complex.
*/
CMPIStatus (*authorizeFilter) (CMPIIndicationMI * mi,
const CMPIContext * ctx,
const CMPISelectExp * filter,
const char *className,
const CMPIObjectPath * op,
const char *owner);
/** Ask the MI whether polling mode should be used.
This function enables very simple MIs to support indications without
providing a complete indication support implementation. When true
is returned, the MB will enumerate the instances of this MI at
regular intervals and apply indication filters.
@param mi The mi argument is a pointer to a CMPIIndicationMI structure.
@param ctx The ctx argument is a pointer to a CMPIContext structure
containing the Invocation Context.
@param className The class name extracted from the filter FROM clause.
@param filter The name of the class for which monitoring is required.
Only the namespace part is set if eventType is a process indication.
@param classPath The name of the class for which polling would be used.
Only the namespace part is set if className is a process indication.
@return This function shall return a CMPIStatus structure containing
the service return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_INVALID_QUERY Invalid query or too complex.
*/
CMPIStatus (*mustPoll) (CMPIIndicationMI * mi, const CMPIContext * ctx,
const CMPISelectExp * filter,
const char *className,
const CMPIObjectPath * classPath);
/** Ask the provider to begin monitoring a resource.
The function shall begin monitoring the resource according to the
filter express only.
@param mi The mi argument is a pointer to a CMPIIndicationMI structure.
@param ctx The ctx argument is a pointer to a CMPIContext structure
containing the Invocation Context.
@param filter The filter argument contains the filter specification for
this subscription to become active.
@param className The class name extracted from the filter FROM clause.
@param classPath The name of the class for which monitoring is required.
Only the namespace part is set if eventType is a process indication.
@param firstActivation Set to true if this is the first filter for
className.
@return The function shall return a CMPIStatus structure containing
the service return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_INVALID_QUERY Invalid query or too complex.
*/
CMPIStatus (*activateFilter) (CMPIIndicationMI * mi,
const CMPIContext * ctx,
const CMPISelectExp * filter,
const char *className,
const CMPIObjectPath * classPath,
CMPIBoolean firstActivation);
/** Inform the MI that monitoring using this filter should stop.
The function invocation mandates the MI to stop monitoring the resource
using this filter.
@param mi The mi argument is a pointer to a CMPIIndicationMI structure.
@param ctx The ctx argument is a pointer to a CMPIContext structure
containing the Invocation Context.
@param filter The filter argument contains the filter specification for
this subscription to become active.
@param className The class name extracted from the filter FROM clause.
@param classPath The name of the class for which monitoring is required.
Only the namespace part is set if className is a process indication.
@param lastActiviation Set to true if this is the last filter for
className.
@return The function shall return a CMPIStatus structure containing the
service return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
CMPI_RC_ERR_ACCESS_DENIED Not authorized.
CMPI_RC_ERR_INVALID_QUERY Invalid query or too complex.
*/
CMPIStatus (*deActivateFilter) (CMPIIndicationMI * mi,
const CMPIContext * ctx,
const CMPISelectExp * filter,
const char *className,
const CMPIObjectPath * classPath,
CMPIBoolean lastActiviation);
/** Tell the MI that indications can now be generated. The MB is now
prepared
to process indications. The function is normally called by the MB
after having done its intialization and processing of persistent
subscription requests.
@param mi The mi argument is a pointer to a CMPIIndicationMI
structure.
@param ctx The ctx argument is a pointer to a CMPIContext
structure containing the Invocation Context.
@return The function shall return a CMPIStatus structure containing the
service return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
*/
CMPIStatus (*enableIndications) (CMPIIndicationMI * mi,
const CMPIContext *);
/** Tell the MI to stop generating indications. MB will not accept any
indications until enabled again. The function is normally called
when the MB is shutting down indication services either temporarily
or permanently.
@param mi The mi argument is a pointer to a CMPIIndicationMI structure.
@param ctx The ctx argument is a pointer to a CMPIContext structure
containing the Invocation Context.
@return The function shall return a CMPIStatus structure containing the
service return status.
The following CMPIrc codes shall be recognized:
CMPI_RC_OK Operation successful.
CMPI_RC_ERR_FAILED Unspecific error occurred.
CMPI_RC_ERR_NOT_SUPPORTED Operation not supported by this MI.
*/
CMPIStatus (*disableIndications) (CMPIIndicationMI * mi,
const CMPIContext *);
};
# include "cmpimacs.h"
# ifdef __cplusplus
};
# endif
#endif // _CMPIFT_H_
|