Return to apidoc.dxx CVS log

Up to [Pegasus] / pegasus / doc / apidoc

add new html version of the readme per PEP 103, the review version of this document. Note that this is still in review within the AG

/// @name Pegasus API Documentation
/* api.dxx - Top Level file for Developer api Documentation.
This file defines the document strucuture and provides the introduction

	$Author: karl $
*/
/* do not change the following Name.  Used in the Frame definition.
If you change it, the HTML Frame must also be changed.
*/
/** @name Introduction

<CENTER><FONT Size=+4>PEGASUS Public APIs</FONT></CENTER>

<P><B><CENTER>STATUS: DRAFT FOR REVIEW</CENTER></B>
<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.


<P>This is a working document that contains the interfaces for the Pegasus 
CIM Server implementation.  This is 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> 

<p>Within this document, you will find the following:</p>
<UL>
<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> Usage examples of the APIs with the defintions.
</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.


<p>The following is the complete file hiearchy for this document.
   We have tried to keep all file references in only this one place
   to make modification easier.  In the future, please keep the
   references here and text in the individual files.
  </p>
   
TBD: Pegasus API version information
*/

/** @name Pegasus CIM Objects and Common Function 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
           //@{ 
		//@Include: ../../src/Pegasus/Common/Array.h
		//@Include: ../../src/Pegasus/Common/ArrayInter.h
		//@Include: ../../src/Pegasus/Common/Boolean.h
		//@Include: ../../src/Pegasus/Common/CIMClass.h
		//@Include: ../../src/Pegasus/Common/CIMDateTime.h
		//@Include: ../../src/Pegasus/Common/CIMFlavor.h
		//@Include: ../../src/Pegasus/Common/CIMIndication.h
		//@Include: ../../src/Pegasus/Common/CIMInstance.h
		//@Include: ../../src/Pegasus/Common/CIMMethod.h
		//@Include: ../../src/Pegasus/Common/CIMName.h
		//@Include: ../../src/Pegasus/Common/CIMObject.h
		//@Include: ../../src/Pegasus/Common/CIMObjectPath.h
		//@Include: ../../src/Pegasus/Common/CIMParamValue.h
		//@Include: ../../src/Pegasus/Common/CIMParameter.h
		//@Include: ../../src/Pegasus/Common/CIMProperty.h
		//@Include: ../../src/Pegasus/Common/CIMPropertyList.h
		//@Include: ../../src/Pegasus/Common/CIMQualifier.h
		//@Include: ../../src/Pegasus/Common/CIMQualifierDecl.h
		//@Include: ../../src/Pegasus/Common/CIMQualifierList.h
		//@Include: ../../src/Pegasus/Common/CIMScope.h
		//@Include: ../../src/Pegasus/Common/CIMStatusCode.h
		//@Include: ../../src/Pegasus/Common/CIMType.h
		//@Include: ../../src/Pegasus/Common/CIMValue.h
		//@Include: ../../src/Pegasus/Common/Char16.h
		//@Include: ../../src/Pegasus/Common/Config.h
		//@Include: ../../src/Pegasus/Common/String.h
		//@Include: ../../src/Pegasus/Common/CIMIndication.h
	    //@}
        /// @name General Server Functionality Classes
           //@{ 
		//@Include: ../../src/Pegasus/Common/OperationContext.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 Interfaces
       //@{
	    /** @name Pegasus Operations
	    NOTE That this section should probably go away
	    */
	        //@{
		    //@Include: ../../doc/CIMOperations.h
		//@}
	    /// @name Pegasus Client CIM Operation and Connection Interfaces   
		//@{    
		    //@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 C++ Provider Interfaces
	//@{
	    /// Pegasus CIM Provider Types and Interfaces
	        //@{
			//@Include: ../../src/Pegasus/Provider/CIMProvider.h
			//@Include: ../../src/Pegasus/Provider/CIMAssociationProvider.h
			//@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h
			//@Include: ../../src/Pegasus/Provider/CIMIndicationProvider.h
			//@Include: ../../src/Pegasus/Provider/CIMInstanceProvider.h
			//@Include: ../../src/Pegasus/Provider/CIMMethodProvider.h
	        //@}  	 
	    /// Pegasus CIM Provider  CIMOM Handle Callback
	        //@{ 
		    //@Include: ../../src/Pegasus/Provider/CIMOMHandle.h
	        //@}  	 
	    /// Pegasus CIM Provider Exceptions
	        //@{ 
		    //@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

This section will contain references to external documents.

NOTE: Documents we must reference include:
	<UL>
	<LI>CIM Operations Spec.
	<LI>CIM Spec.
	</UL>
*/