version 1.6, 2003/10/30 14:46:09
|
version 1.7, 2003/11/13 16:02:37
|
|
|
|
/// @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 |
| |
|
|
| |
| |
<P>This is a working document that contains the interfaces for the Pegasus | <P>This is a working document that contains the interfaces for the Pegasus |
CIM Server implementation. This is being created by the OpenGroup |
CIM Server implementation. This is created by the OpenGroup |
Enterprise Management Program Group. | Enterprise Management Program Group. |
| |
<p>In addition to this documentation, Pegasus has a Users' Guide that | <p>In addition to this documentation, Pegasus has a Users' Guide that |
|
|
| |
<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> |
|
|
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. |
This section defines the Pegasus C++ Class that represent |
This section defines the Pegasus C++ Classes that represent |
the CIM objects and the common functions used by Pegasus | the CIM objects and the common functions used by Pegasus |
*/ | */ |
| |
|
|
//@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/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/Consumer/CIMIndicationConsumer.h | //@Include: ../../src/Pegasus/Consumer/CIMIndicationConsumer.h |
//@} | //@} |
| |
/** @name References and Glossary |
/// @name General Information on the APIs |
This section contains common definitions, glossary information, etc. |
|
*/ |
|
//@{ | //@{ |
//@Include: ../DevManual/references.dxx |
//@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> |
*/ | */ |
| |
| |
|
|