(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.1 and 1.6

version 1.1, 2003/10/01 19:02:04 version 1.6, 2003/10/30 14:46:09
Line 1 
Line 1 
 /* 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
  
   
         $Author$         $Author$
 */ */
 /* do not change the following Name.  Used in the Frame definition. /* do not change the following Name.  Used in the Frame definition.
Line 12 
Line 11 
 <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</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.
  
 <B>This Document</B>  
   
 <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.  
  
 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.  <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>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>
  
 Within this manual you will find:  <p>Within this document, you will find the following:</p>
 <UL> <UL>
 <LI>Information on the installation and operation of the broker and additional components.  <LI>A definition of the public APIs defined for the current version of Pegasus including the client, CIMOM, and provider APIs.
 <LI> A basic defintion of the architecture and function of Pegasus.  <LI>Information on the status of these APIs (frozen, experimental, etc.).
 <LI>The current definition of the programming interfaces that Pegasus allows.  As these interfaces are stabilized they will be moved from this document to an Open Group specificaton.  <LI> Usage examples of the APIs with the defintions.
 <LI>A number of defintions of additional code that is  
 available to interface with Pegasus as providers, consumers, and services.  
 </UL> </UL>
  
 */  <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:
   CONNIE: We might get by with this experimental list but it will change for each
           version of the document.
  
  
 /* The following is the complete file hiearchy for this document.  <p>The following is the complete file hiearchy for this document.
    We have tried to keep all file references in only this one place    We have tried to keep all file references in only this one place
    to make modification easier.  In the future, please keep the    to make modification easier.  In the future, please keep the
    references here and text in the individual files.    references here and text in the individual files.
     </p>
  
 TBD: Pegasus API version information TBD: Pegasus API version information
 */ */
  
 /** @name Pegasus CIM OBjects and General 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++ Class that represent
           the CIM objects and the common functions used by Pegasus
 */ */
   
         //@{         //@{
           /// @name Classes for CIM Objects and Containers
            //@{            //@{
                 //@Include: ../../src/Pegasus/Common/Array.h                 //@Include: ../../src/Pegasus/Common/Array.h
                   //@Include: ../../src/Pegasus/Common/ArrayInter.h
                 //@Include: ../../src/Pegasus/Common/Boolean.h                 //@Include: ../../src/Pegasus/Common/Boolean.h
                 //@Include: ../../src/Pegasus/Common/CIMClass.h                 //@Include: ../../src/Pegasus/Common/CIMClass.h
                 //@Include: ../../src/Pegasus/Common/CIMClassRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMDateTime.h                 //@Include: ../../src/Pegasus/Common/CIMDateTime.h
                 //@Include: ../../src/Pegasus/Common/CIMExceptionRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMFlavor.h                 //@Include: ../../src/Pegasus/Common/CIMFlavor.h
                 //@Include: ../../src/Pegasus/Common/CIMIndication.h                 //@Include: ../../src/Pegasus/Common/CIMIndication.h
                 //@Include: ../../src/Pegasus/Common/CIMInstance.h                 //@Include: ../../src/Pegasus/Common/CIMInstance.h
                 //@Include: ../../src/Pegasus/Common/CIMInstanceRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMMessage.h  
                 //@Include: ../../src/Pegasus/Common/CIMMethod.h                 //@Include: ../../src/Pegasus/Common/CIMMethod.h
                 //@Include: ../../src/Pegasus/Common/CIMMethodRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMName.h                 //@Include: ../../src/Pegasus/Common/CIMName.h
                 //@Include: ../../src/Pegasus/Common/CIMOMPort.h  
                 //@Include: ../../src/Pegasus/Common/CIMObject.h                 //@Include: ../../src/Pegasus/Common/CIMObject.h
                 //@Include: ../../src/Pegasus/Common/CIMObjectPath.h                 //@Include: ../../src/Pegasus/Common/CIMObjectPath.h
                 //@Include: ../../src/Pegasus/Common/CIMObjectRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMParamValue.h                 //@Include: ../../src/Pegasus/Common/CIMParamValue.h
                 //@Include: ../../src/Pegasus/Common/CIMParamValueRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMParameter.h                 //@Include: ../../src/Pegasus/Common/CIMParameter.h
                 //@Include: ../../src/Pegasus/Common/CIMParameterRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMPredicate.h  
                 //@Include: ../../src/Pegasus/Common/CIMProperty.h                 //@Include: ../../src/Pegasus/Common/CIMProperty.h
                 //@Include: ../../src/Pegasus/Common/CIMPropertyList.h                 //@Include: ../../src/Pegasus/Common/CIMPropertyList.h
                 //@Include: ../../src/Pegasus/Common/CIMPropertyRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMQualifier.h                 //@Include: ../../src/Pegasus/Common/CIMQualifier.h
                 //@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h                 //@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
                 //@Include: ../../src/Pegasus/Common/CIMQualifierDeclRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMQualifierList.h                 //@Include: ../../src/Pegasus/Common/CIMQualifierList.h
                 //@Include: ../../src/Pegasus/Common/CIMQualifierNames.h  
                 //@Include: ../../src/Pegasus/Common/CIMQualifierRep.h  
                 //@Include: ../../src/Pegasus/Common/CIMRepositoryBase.h  
                 //@Include: ../../src/Pegasus/Common/CIMScope.h                 //@Include: ../../src/Pegasus/Common/CIMScope.h
                 //@Include: ../../src/Pegasus/Common/CIMStatusCode.h                 //@Include: ../../src/Pegasus/Common/CIMStatusCode.h
                 //@Include: ../../src/Pegasus/Common/CIMType.h                 //@Include: ../../src/Pegasus/Common/CIMType.h
                 //@Include: ../../src/Pegasus/Common/CIMValue.h                 //@Include: ../../src/Pegasus/Common/CIMValue.h
                 //@Include: ../../src/Pegasus/Common/Char16.h                 //@Include: ../../src/Pegasus/Common/Char16.h
                 //@Include: ../../src/Pegasus/Common/Formatter.h                  //@Include: ../../src/Pegasus/Common/Config.h
                 //@Include: ../../src/Pegasus/Common/OperationContext.h  
                 //@Include: ../../src/Pegasus/Common/Queue.h  
                 //@Include: ../../src/Pegasus/Common/Stopwatch.h  
                 //@Include: ../../src/Pegasus/Common/String.h                 //@Include: ../../src/Pegasus/Common/String.h
                   //@Include: ../../src/Pegasus/Common/CIMIndication.h
               //@}
           /// @name Classes General Functionality
                 //@{                 //@{
                 /// @name Exceptions                  //@Include: ../../src/Pegasus/Common/OperationContext.h
                 //@Include: ../../src/Pegasus/Common/Exception.h                  //@Include: ../../src/Pegasus/Common/ResponseHandler.h
                   //@Include: ../../src/Pegasus/Common/SSLContext.h
                 //@}                 //@}
          /// @name CIM Object Exceptions
               //@{
                   //@Include: ../../src/Pegasus/Common/Exception.h
             //@}             //@}
   
         //@}         //@}
     /// @name Client and Provider Interfaces      /// @name ClientInterfaces
        //@{        //@{
             /** @name Pegasus Operations             /** @name Pegasus Operations
             NOTE That this section should probably go away             NOTE That this section should probably go away
Line 106 
Line 109 
                 //@{                 //@{
                     //@Include: ../../doc/CIMOperations.h                     //@Include: ../../doc/CIMOperations.h
                 //@}                 //@}
             /// @name Pegasus Client 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
                   //@{
                       //@Include: ../../src/Pegasus/Client/CIMServerDiscovery.h
                       //@Include: ../../src/Pegasus/Client/CIMServerDescription.h
                       //@Include: ../../src/Pegasus/Client/Attribute.h
                   //@}
               /// @name Pegasus Listener Interfaces
                   //@{
                       //@Include: ../../src/Pegasus/Listener/CIMListener.h
                   //@}
                 //@}                 //@}
            /// @name Pegasus Provider Interfaces            /// @name Pegasus Provider 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/CIMClassProvider.h                          //@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h
                         //@Include: ../../src/Pegasus/Provider/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
                         //@Include: ../../src/Pegasus/Provider/CIMNullProvider.h                  //@}
               /// Pegasus CIM Provider  CIMOM Handle Callback
                   //@{
                         //@Include: ../../src/Pegasus/Provider/CIMOMHandle.h                         //@Include: ../../src/Pegasus/Provider/CIMOMHandle.h
                         //@Include: ../../src/Pegasus/Provider/CIMPropertyProvider.h                  //@}
                         //@Include: ../../src/Pegasus/Provider/CIMQueryProvider.h              /// Pegasus CIM Provider Exceptions
                   //@{
                         //@Include: ../../src/Pegasus/Provider/ProviderException.h                         //@Include: ../../src/Pegasus/Provider/ProviderException.h
                 //@}                 //@}
        //@}        //@}
     /// @name Pegasus Server Indication Consumer
           //@{
                   //@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h
           //@}
   
   /** @name References and Glossary
   This section contains common definitions, glossary information, etc.
   */
        //@{
           //@Include: ../DevManual/references.dxx
        //@}
   
 /** @name Document References /** @name Document References
  
 This section will contain references to external documents. This section will contain references to external documents.
Line 137 
Line 167 
         <LI>DMTF Specifications         <LI>DMTF Specifications
         <LI>         <LI>
 </UL/ </UL/
 */    //@Include: references.dxx  */
  
  

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