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           <B>This Document</B>
 19           
 20           <P>This is a working document that is the temporary user and developers manual for the Pegasus CIM Server implementation which is being created by the OpenGroup Enterprise Management Program Group.
 21           
 22           This manual serves as both a manual for installation and operation of the prototype version of Pegasus and a manual for developing components to attach to Pegasus. In addition to the manual, we keep current working information in a set of README files within the Pegasus distributions. Please consult these files also.
 23           

 24 karl  1.2 Within this document you will find:

 25 karl  1.1 <UL>

 26 karl  1.2 <LI>definition of the public APIs defined for the current version of Pegasus including the client, CIMOM, and provider APIs
 27           <LI> Information on the status of these APIs (frozen, experimental, etc.)
 28           <LI> Usage examples of the APIs with the defintions.

 29 karl  1.1 </UL>
 30           */
 31           
 32           /* The following is the complete file hiearchy for this document.
 33              We have tried to keep all file references in only this one place
 34              to make modification easier.  In the future, please keep the
 35              references here and text in the individual files.
 36              
 37           TBD: Pegasus API version information
 38           */
 39           

 40 karl  1.2 /** @name Pegasus CIM Objects and Common Function APIs

 41 karl  1.1 	NOTE: This needs to be reorganized to take into account a structure for these APIs 
 42           */    
 43                   //@{

 44 karl  1.3         /// @name Classes for CIM Objects and Containers

 45 karl  1.1            //@{ 
 46           		//@Include: ../../src/Pegasus/Common/Array.h

 47 karl  1.2 		//@Include: ../../src/Pegasus/Common/ArrayInter.h

 48 karl  1.1 		//@Include: ../../src/Pegasus/Common/Boolean.h
 49           		//@Include: ../../src/Pegasus/Common/CIMClass.h
 50           		//@Include: ../../src/Pegasus/Common/CIMDateTime.h
 51           		//@Include: ../../src/Pegasus/Common/CIMFlavor.h
 52           		//@Include: ../../src/Pegasus/Common/CIMIndication.h
 53           		//@Include: ../../src/Pegasus/Common/CIMInstance.h
 54           		//@Include: ../../src/Pegasus/Common/CIMMethod.h
 55           		//@Include: ../../src/Pegasus/Common/CIMName.h
 56           		//@Include: ../../src/Pegasus/Common/CIMObject.h
 57           		//@Include: ../../src/Pegasus/Common/CIMObjectPath.h
 58           		//@Include: ../../src/Pegasus/Common/CIMParamValue.h
 59           		//@Include: ../../src/Pegasus/Common/CIMParameter.h
 60           		//@Include: ../../src/Pegasus/Common/CIMProperty.h
 61           		//@Include: ../../src/Pegasus/Common/CIMPropertyList.h
 62           		//@Include: ../../src/Pegasus/Common/CIMQualifier.h
 63           		//@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
 64           		//@Include: ../../src/Pegasus/Common/CIMQualifierList.h
 65           		//@Include: ../../src/Pegasus/Common/CIMScope.h
 66           		//@Include: ../../src/Pegasus/Common/CIMStatusCode.h
 67           		//@Include: ../../src/Pegasus/Common/CIMType.h
 68           		//@Include: ../../src/Pegasus/Common/CIMValue.h
 69 karl  1.1 		//@Include: ../../src/Pegasus/Common/Char16.h

 70 karl  1.2 		//@Include: ../../src/Pegasus/Common/Config.h
 71           		//@Include: ../../src/Pegasus/Common/String.h

 72 karl  1.3 		//@Include: ../../src/Pegasus/Common/CIMIndication.h
 73           	    //@}
 74                   /// @name Classes General Functionality
 75                      //@{ 

 76 karl  1.1 		//@Include: ../../src/Pegasus/Common/OperationContext.h

 77 karl  1.2 		//@Include: ../../src/Pegasus/Common/ResponseHandler.h
 78           		//@Include: ../../src/Pegasus/Common/SSLContext.h

 79 karl  1.3             //@}
 80                  /// @name Exceptions
 81                       //@{

 82 karl  1.1         	//@Include: ../../src/Pegasus/Common/Exception.h
 83                       //@}

 84 karl  1.3        //@}

 85 karl  1.2     /// @name ClientInterfaces

 86 karl  1.1        //@{
 87           	    /** @name Pegasus Operations
 88           	    NOTE That this section should probably go away
 89           	    */
 90           	        //@{
 91           		    //@Include: ../../doc/CIMOperations.h
 92           		//@}

 93 karl  1.3 	    /// @name Pegasus Client CIM Operation and Connection Interfaces   

 94 karl  1.1 		//@{    
 95           		    //@Include: ../../src/Pegasus/Client/CIMClient.h
 96           		//@}

 97 karl  1.3 	    /// @name Pegasus Client SLP interfaces   
 98           		//@{    
 99           		    //@Include: ../../src/Pegasus/Client/CIMServerDiscovery.h
100           		    //@Include: ../../src/Pegasus/Client/CIMServerDescription.h
101           		    //@Include: ../../src/Pegasus/Client/Attribute.h
102           		//@}
103           	    /// @name Pegasus Listener Interfaces   
104           		//@{    
105           		    //@Include: ../../src/Pegasus/Listener/CIMListener.h
106           		//@}

107 karl  1.2        //@}
108              /// @name Pegasus Provider Interfaces
109           	//@{

110 karl  1.3 	    /// Pegasus CIM Provider Types and Interfaces
111           	        //@{
112           			//@Include: ../../src/Pegasus/Provider/CIMProvider.h
113           			//@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
114           			//@Include: ../../src/Pegasus/Provider/CIMIndicationConsumer.h
115           			//@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
116           			//@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
117           			//@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
118           	        //@}  	 
119           	    /// Pegasus CIM Provider  CIMOM Handle Callback
120           	      //@{ 

121 karl  1.2 		//@Include: ../../src/Pegasus/Provider/CIMOMHandle.h

122 karl  1.3 	        //@}  	 
123           	    /// Pegasus CIM Provider Exceptions
124           	      //@{ 

125 karl  1.2 		//@Include: ../../src/Pegasus/Provider/ProviderException.h

126 karl  1.3 	      //@}  	 

127 karl  1.2 	//@}  	 

128 karl  1.1 /** @name Document References
129           
130           This section will contain references to external documents.
131           
132           NOTE: documents we must reference include:
133           
134           <UL>
135           	<LI>DMTF Specifications
136           	<LI>
137           </UL/
138           */    //@Include: references.dxx
139            
140