1 karl 1.1 /* api.dxx - Top Level file for Developer api Documentation.
2 This file defines the document strucuture and provides the introduction
3
4 $Author: karl $
5 */
6 /* do not change the following Name. Used in the Frame definition.
7 If you change it, the HTML Frame must also be changed.
8 */
9 /** @name Introduction
10
11 <CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER>
12
13 <P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B>
|
14 karl 1.2 <SMALL><CENTER>version 1.01 13 September 2003, Pegasus 2.3</CENTER></SMALL>
|
15 karl 1.1
16 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
17
18
|
19 karl 1.4 <P>This is a working document that contains the interfaces for the Pegasus CIM Server implementation. This is being created by the OpenGroup Enterprise Management Program Group.
|
20 karl 1.1
|
21 karl 1.4 <p>In addition to this documentation, Pegasus has a Users' Guide that specifies overview information and how to set up and install Pegasus. In addition to the manual, the README files contain specific information to aide you in when working with Pegasus and its documentation.</p>
|
22 karl 1.1
|
23 karl 1.4 <p>Within this document, you will find the following:</p>
|
24 karl 1.1 <UL>
|
25 karl 1.4 <LI>A definition of the public APIs defined for the current version of Pegasus including the client, CIMOM, and provider APIs.
26 <LI>Information on the status of these APIs (frozen, experimental, etc.).
|
27 karl 1.2 <LI> Usage examples of the APIs with the defintions.
|
28 karl 1.1 </UL>
29
|
30 karl 1.4 <p>The following are interfaces that are frozen with the 2.3 release of Pegasus:
31
32
33 <p>The following are interfaces that are experimental:
34
35
36 <p>The following is the complete file hiearchy for this document.
|
37 karl 1.1 We have tried to keep all file references in only this one place
38 to make modification easier. In the future, please keep the
39 references here and text in the individual files.
|
40 karl 1.4 </p>
|
41 karl 1.1
42 TBD: Pegasus API version information
43 */
44
|
45 karl 1.2 /** @name Pegasus CIM Objects and Common Function APIs
|
46 karl 1.1 NOTE: This needs to be reorganized to take into account a structure for these APIs
47 */
48 //@{
|
49 karl 1.3 /// @name Classes for CIM Objects and Containers
|
50 karl 1.1 //@{
51 //@Include: ../../src/Pegasus/Common/Array.h
|
52 karl 1.2 //@Include: ../../src/Pegasus/Common/ArrayInter.h
|
53 karl 1.1 //@Include: ../../src/Pegasus/Common/Boolean.h
54 //@Include: ../../src/Pegasus/Common/CIMClass.h
55 //@Include: ../../src/Pegasus/Common/CIMDateTime.h
56 //@Include: ../../src/Pegasus/Common/CIMFlavor.h
57 //@Include: ../../src/Pegasus/Common/CIMIndication.h
58 //@Include: ../../src/Pegasus/Common/CIMInstance.h
59 //@Include: ../../src/Pegasus/Common/CIMMethod.h
60 //@Include: ../../src/Pegasus/Common/CIMName.h
61 //@Include: ../../src/Pegasus/Common/CIMObject.h
62 //@Include: ../../src/Pegasus/Common/CIMObjectPath.h
63 //@Include: ../../src/Pegasus/Common/CIMParamValue.h
64 //@Include: ../../src/Pegasus/Common/CIMParameter.h
65 //@Include: ../../src/Pegasus/Common/CIMProperty.h
66 //@Include: ../../src/Pegasus/Common/CIMPropertyList.h
67 //@Include: ../../src/Pegasus/Common/CIMQualifier.h
68 //@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
69 //@Include: ../../src/Pegasus/Common/CIMQualifierList.h
70 //@Include: ../../src/Pegasus/Common/CIMScope.h
71 //@Include: ../../src/Pegasus/Common/CIMStatusCode.h
72 //@Include: ../../src/Pegasus/Common/CIMType.h
73 //@Include: ../../src/Pegasus/Common/CIMValue.h
74 karl 1.1 //@Include: ../../src/Pegasus/Common/Char16.h
|
75 karl 1.2 //@Include: ../../src/Pegasus/Common/Config.h
76 //@Include: ../../src/Pegasus/Common/String.h
|
77 karl 1.3 //@Include: ../../src/Pegasus/Common/CIMIndication.h
78 //@}
79 /// @name Classes General Functionality
80 //@{
|
81 karl 1.1 //@Include: ../../src/Pegasus/Common/OperationContext.h
|
82 karl 1.2 //@Include: ../../src/Pegasus/Common/ResponseHandler.h
83 //@Include: ../../src/Pegasus/Common/SSLContext.h
|
84 karl 1.3 //@}
85 /// @name Exceptions
86 //@{
|
87 karl 1.1 //@Include: ../../src/Pegasus/Common/Exception.h
88 //@}
|
89 karl 1.3 //@}
|
90 karl 1.2 /// @name ClientInterfaces
|
91 karl 1.1 //@{
92 /** @name Pegasus Operations
93 NOTE That this section should probably go away
94 */
95 //@{
96 //@Include: ../../doc/CIMOperations.h
97 //@}
|
98 karl 1.3 /// @name Pegasus Client CIM Operation and Connection Interfaces
|
99 karl 1.1 //@{
100 //@Include: ../../src/Pegasus/Client/CIMClient.h
101 //@}
|
102 karl 1.3 /// @name Pegasus Client SLP interfaces
103 //@{
104 //@Include: ../../src/Pegasus/Client/CIMServerDiscovery.h
105 //@Include: ../../src/Pegasus/Client/CIMServerDescription.h
106 //@Include: ../../src/Pegasus/Client/Attribute.h
107 //@}
108 /// @name Pegasus Listener Interfaces
109 //@{
110 //@Include: ../../src/Pegasus/Listener/CIMListener.h
111 //@}
|
112 karl 1.2 //@}
113 /// @name Pegasus Provider Interfaces
114 //@{
|
115 karl 1.3 /// Pegasus CIM Provider Types and Interfaces
116 //@{
117 //@Include: ../../src/Pegasus/Provider/CIMProvider.h
118 //@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
119 //@Include: ../../src/Pegasus/Provider/CIMIndicationConsumer.h
120 //@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
121 //@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
122 //@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
123 //@}
124 /// Pegasus CIM Provider CIMOM Handle Callback
125 //@{
|
126 karl 1.2 //@Include: ../../src/Pegasus/Provider/CIMOMHandle.h
|
127 karl 1.3 //@}
128 /// Pegasus CIM Provider Exceptions
129 //@{
|
130 karl 1.2 //@Include: ../../src/Pegasus/Provider/ProviderException.h
|
131 karl 1.3 //@}
|
132 karl 1.2 //@}
|
133 karl 1.1 /** @name Document References
134
135 This section will contain references to external documents.
136
137 NOTE: documents we must reference include:
138
139 <UL>
140 <LI>DMTF Specifications
141 <LI>
142 </UL/
143 */ //@Include: references.dxx
144
145
|