(file) Return to apidoc.dxx CVS log (file) (dir) Up to [Pegasus] / pegasus / doc / apidoc / Attic

Diff for /pegasus/doc/apidoc/Attic/apidoc.dxx between version 1.4 and 1.7

version 1.4, 2003/10/27 19:44:53 version 1.7, 2003/11/13 16:02:37
Line 1 
Line 1 
   /// @name Pegasus API Documentation
 /* api.dxx - Top Level file for Developer api Documentation. /* api.dxx - Top Level file for Developer api Documentation.
 This file defines the document strucuture and provides the introduction This file defines the document strucuture and provides the introduction
  
Line 11 
Line 12 
 <CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER> <CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER>
  
 <P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B> <P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B>
 <SMALL><CENTER>version 1.01 13 September 2003, Pegasus 2.3</CENTER></SMALL>  <SMALL><CENTER>version 1.01 30 October 2003, Pegasus 2.3</CENTER></SMALL>
  
 Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards. Pegasus is an open source implementation of the manageability environment defined by the DMTF WBEM standards.
  
  
 <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.  <P>This is a working document that contains the interfaces for the Pegasus
   CIM Server implementation.  This is created by the OpenGroup
 <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>  Enterprise Management Program Group.
   
   <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>
  
 <p>Within this document, you will find the following:</p> <p>Within this document, you will find the following:</p>
 <UL> <UL>
 <LI>A definition of the public APIs defined for the current version of Pegasus including the client, CIMOM, and provider APIs.  <LI>A definition of the public APIs defined for the current version of Pegasus including
   the client, CIMOM, and provider APIs.
 <LI>Information on the status of these APIs (frozen, experimental, etc.). <LI>Information on the status of these APIs (frozen, experimental, etc.).
 <LI> Usage examples of the APIs with the defintions. <LI> Usage examples of the APIs with the defintions.
 </UL> </UL>
  
 <p>The following are interfaces that are frozen with the 2.3 release of Pegasus: <p>The following are interfaces that are frozen with the 2.3 release of Pegasus:
   CONNIE: we will go nuts if we try to do the lists this way.  We need to mark them
           in the classes and methods themselves, not in this list.  In reality
           all interfaces that are not explicitly marked experimental are frozen.
           We should state that.
           Need to reference PEP 57 as the authority for this release.
  
  
 <p>The following are interfaces that are experimental: <p>The following are interfaces that are experimental:
   CONNIE: We might get by with this experimental list but it will change for each
           version of the document.
  
  
 <p>The following is the complete file hiearchy for this document. <p>The following is the complete file hiearchy for this document.
Line 42 
Line 56 
 TBD: Pegasus API version information TBD: Pegasus API version information
 */ */
  
 /** @name Pegasus CIM Objects and Common Function APIs  /** @name Pegasus CIM Objects and Common Function APIs.
         NOTE: This needs to be reorganized to take into account a structure for these APIs          This section defines the Pegasus C++ Classes that represent
           the CIM objects and the common functions used by Pegasus
 */ */
   
         //@{         //@{
         /// @name Classes for CIM Objects and Containers         /// @name Classes for CIM Objects and Containers
            //@{            //@{
Line 76 
Line 92 
                 //@Include: ../../src/Pegasus/Common/String.h                 //@Include: ../../src/Pegasus/Common/String.h
                 //@Include: ../../src/Pegasus/Common/CIMIndication.h                 //@Include: ../../src/Pegasus/Common/CIMIndication.h
             //@}             //@}
         /// @name Classes General Functionality          /// @name General Server Functionality Classes
            //@{            //@{
                 //@Include: ../../src/Pegasus/Common/OperationContext.h                 //@Include: ../../src/Pegasus/Common/OperationContext.h
                 //@Include: ../../src/Pegasus/Common/ResponseHandler.h                 //@Include: ../../src/Pegasus/Common/ResponseHandler.h
                 //@Include: ../../src/Pegasus/Common/SSLContext.h                 //@Include: ../../src/Pegasus/Common/SSLContext.h
             //@}             //@}
        /// @name Exceptions         /// @name CIM Object Exceptions
             //@{             //@{
                 //@Include: ../../src/Pegasus/Common/Exception.h                 //@Include: ../../src/Pegasus/Common/Exception.h
             //@}             //@}
Line 98 
Line 114 
             /// @name Pegasus Client CIM Operation and Connection Interfaces             /// @name Pegasus Client CIM Operation and Connection Interfaces
                 //@{                 //@{
                     //@Include: ../../src/Pegasus/Client/CIMClient.h                     //@Include: ../../src/Pegasus/Client/CIMClient.h
                       //@Include: ../../src/Pegasus/Client/CIMClientException.h
                 //@}                 //@}
             /// @name Pegasus Client SLP interfaces             /// @name Pegasus Client SLP interfaces
                 //@{                 //@{
Line 110 
Line 127 
                     //@Include: ../../src/Pegasus/Listener/CIMListener.h                     //@Include: ../../src/Pegasus/Listener/CIMListener.h
                 //@}                 //@}
        //@}        //@}
    /// @name Pegasus Provider Interfaces     /// @name C++ Provider Interfaces
         //@{         //@{
             /// Pegasus CIM Provider Types and Interfaces             /// Pegasus CIM Provider Types and Interfaces
                 //@{                 //@{
                         //@Include: ../../src/Pegasus/Provider/CIMProvider.h                         //@Include: ../../src/Pegasus/Provider/CIMProvider.h
                         //@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h                         //@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
                         //@Include: ../../src/Pegasus/Provider/CIMIndicationConsumer.h                          //@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h
                         //@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h                         //@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
                         //@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h                         //@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
                         //@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h                         //@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
Line 130 
Line 147 
                 //@Include: ../../src/Pegasus/Provider/ProviderException.h                 //@Include: ../../src/Pegasus/Provider/ProviderException.h
               //@}               //@}
         //@}         //@}
     /// @name Pegasus Server Indication Consumer
           //@{
                   //@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h
           //@}
   
   /// @name General Information on the APIs
           //@{
                   //@Include: Commondefinitions.dxx
           //@}
   //@Include: definitions.dxx
   
 /** @name Document References /** @name Document References
  
 This section will contain references to external documents. This section will contain references to external documents.
  
 NOTE: documents we must reference include:  NOTE: Documents we must reference include:
   
 <UL> <UL>
         <LI>DMTF Specifications          <LI>CIM Operations Spec.
         <LI>          <LI>CIM Spec.
 </UL/          </UL>
 */    //@Include: references.dxx  */
   
  
  

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.7
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2