Contents

Preface

1. Application Programming Interface

1.1 API Classes
1.2 Viewer API
1.3 ViewerApi Class

1.3.1 ViewerApi Member Functions
1.3.2 Communication Protocol
1.3.3 ViewerApi Actions
1.3.4 Event Handling
1.3.5 Network Views Messages
1.3.6 Sample Programs

1.4 Grapher API
1.5 EMdataset Class
1.6 EMdynamicDataset Class

1.6.1 Constructor
1.6.2 Destructor

1.7 EMstaticDataset Class

1.7.1 Constructor
1.7.2 Destructor

1.8 EMgraph Class

1.8.1 Constructor
1.8.2 Destructor
1.8.3 EMgraph Member Functions

1.9 Err Class

1.9.1 Member Functions

1.10 Application-to-Application API
1.11 AppInstComm Class

1.11.1 Constructors
1.11.2 Destructor
1.11.3 AppInstComm Member Functions

1.12 AppInstObj Class

1.12.1 Constructors
1.12.2 Destructor
1.12.3 AppInstObj Member Functions

1.13 AppRequest Class

1.13.1 Constructor
1.13.2 AppRequest Member Functions

1.14 Actions
1.15 Notifications
1.16 Example
1.17 AppTarget Class

1.17.1 Constructor
1.17.2 AppTarget Member Functions

2. Common API

2.1 Common API Classes
2.2 Class Categories
2.3 Variable Types
2.4 Class Descriptions
2.5 Address Class

2.5.1 Constructor
2.5.2 Operator
2.5.3 Address Member Functions

2.6 Arraydeclare Macro
2.7 Asn1ParsedValue Class

2.7.1 Constructors
2.7.2 Asn1ParsedValue Operator Overloading
2.7.3 Asn1ParsedValue Member Functions

2.8 Asn1Tag Class

2.8.1 Constructors
2.8.2 Asn1Tag Operator Overloading
2.8.3 Asn1Tag Member Functions

2.9 Asn1Type Class

2.9.1 Constructors
2.9.2 Destructor
2.9.3 Asn1Type Operator Overloading
2.9.4 Asn1Type Member Functions
2.9.5 Related Types

2.10 Asn1Value Class

2.10.1 Assignment and Data Sharing
2.10.2 Type Conversion
2.10.3 Encoding Functions
2.10.4 Encoding of a Distinguished Name
2.10.5 Decoding Simple and Constructed Asn1Values
2.10.6 Constructors
2.10.7 Destructor
2.10.8 Asn1Value Operator Overloading
2.10.9 Asn1Value Member Functions
2.10.10 Related Global Functions

2.11 Blockage Class

2.11.1 Constructor
2.11.2 Blockage Member Functions
2.11.3 Related Global Functions

2.12 Callback Class

2.12.1 Constructor
2.12.2 Callback Operator Overloading
2.12.3 Callback Member Functions

2.13 Command Class

2.13.1 Constructor
2.13.2 Operator

2.14 Config Class

2.14.1 Constructors
2.14.2 Config Member Functions

2.15 DataUnit Class

2.15.1 Constructors
2.15.2 Destructor
2.15.3 DataUnit Operator Overloading
2.15.4 DataUnit Member Functions

2.16 Dictionary Class

2.16.1 Constructor
2.16.2 Dictionary Operator Overloading
2.16.3 Dictionary Member Functions

2.17 GenInt Class

2.17.1 Constructors
2.17.2 Copy Constructor
2.17.3 GenInt Member Functions

2.18 Hash Class

2.18.1 Hash Member Functions

2.19 Hashdeclare Macro
2.20 HashImpl Class

2.20.1 Constructor
2.20.2 Destructor
2.20.3 HashImpl Member Functions

2.21 Hdict Class

2.21.1 Constructors
2.21.2 Hdict (K,T) Operator Overloading
2.21.3 Hdict Member Functions

2.22 Hrefdict Class

2.22.1 Constructors
2.22.2 Hrefdict (K, T) Operator Overloading
2.22.3 Hrefdict Member Functions

2.23 Oid Class

2.23.1 Constructors
2.23.2 Oid Operator Overloading
2.23.3 Oid Member Functions

2.24 Asn1TypeDefinedType Declarations

2.24.1 Asn1SubTypeKind
2.24.2 Asn1SubTypeSize
2.24.3 Asn1Kind
2.24.4 Asn1TypeE
2.24.5 Asn1TypeEL
2.24.6 Asn1TypeNN
2.24.7 Asn1TagClass
2.24.8 Asn1Tagging

2.25 Queue Class

2.25.1 Queue Member Functions

2.26 Queuedeclare Macro
2.27 Timer Class

2.27.1 Default Constructor
2.27.2 Constructor
2.27.3 Operator
2.27.4 Related Global Functions

3. High-Level PMI

3.1 Design Objectives
3.2 Object Management Model

3.2.1 Naming Objects
3.2.2 Relationships Between Objects
3.2.3 Managing Notifications
3.2.4 Managing Data Types
3.2.5 Object Schema Management
3.2.6 Filtering as an Aspect of Album Derivation

3.3 Meta Data Repository

3.3.1 getAttribute Action
3.3.2 getAllDocuments Action
3.3.3 getAsn1Module Action
3.3.4 getObjectClass Action
3.3.5 getDocument Action
3.3.6 getPackage Action
3.3.7 getPackagesByOC Action
3.3.8 getOidName Action
3.3.9 Sample MDR Action Program

3.4 Symbolic Constants
3.5 Defined Types

3.5.1 Asn1Int
3.5.2 CCB
3.5.3 CDU
3.5.4 DU
3.5.5 FBits

3.6 Error Handling and Event Dispatching

3.6.1 Event Dispatching Functions

3.7 pmi_sched_get_fds Function
3.8 High-Level PMI Classes
3.9 Album Class

3.9.1 Constructors
3.9.2 Album Operator Overloading
3.9.3 Album Member Functions

3.10 AlbumImage Class

3.10.1 Constructors
3.10.2 Destructors
3.10.3 AlbumImage Operator Overloading
3.10.4 AlbumImage Member Functions

3.11 AppTarget Class

3.11.1 Constructors
3.11.2 AppTarget Operator Overloading

3.12 AuthApps Class

3.12.1 Constructors
3.12.2 AuthApps Operator Overloading
3.12.3 AuthApps Member Functions

3.13 AuthFeatures Class

3.13.1 Constructor
3.13.2 AuthFeatures Operator Overloading
3.13.3 AuthFeatures Member Functions

3.14 Coder Class

3.14.1 Constructors
3.14.2 Coder Operator Overloading
3.14.3 Coder Member Functions

3.15 CurrentEvent Class

3.15.1 Constructors
3.15.2 CurrentEvent Operator Overloading
3.15.3 CurrentEvent Member Functions

3.16 Error Class

3.16.1 Constructor
3.16.2 Error Operator Overloading
3.16.3 Error Public Data Member
3.16.4 Error Member Functions
3.16.5 Error Types and Strings

3.17 Image Class

3.17.1 Image Constructor
3.17.2 Image Operator Overloading
3.17.3 Image Member Functions
3.17.4 Related Global Functions

3.18 Morf Class

3.18.1 Constructors
3.18.2 Destructor
3.18.3 Morf Operator Overloading
3.18.4 Morf Member Functions

3.19 MorfBuilder Class

3.19.1 Constructors
3.19.2 Destructor
3.19.3 MorfBuilder Operator Overloading
3.19.4 MorfBuilder Member Functions

3.20 PasswordTty Class

3.20.1 Constructors
3.20.2 PasswordTty Operator Overloading
3.20.3 PasswordTty Member function

3.21 Platform Class

3.21.1 Constructors
3.21.2 Destructor
3.21.3 Platform Operator Overloading
3.21.4 Platform Member Functions
3.21.5 GETENV Macro

3.22 Syntax Class

3.22.1 Constructors
3.22.2 Syntax Operator Overloading
3.22.3 Syntax Member Functions

3.23 Waiter Class

3.23.1 Constructors
3.23.2 Waiter Operator Overloading
3.23.3 Waiter Member Functions

4. Low-Level PMI

4.1 Communication Path
4.2 Root Classes for the Low-Level PMI
4.3 Low-Level PMI Classes

4.3.1 Class Inheritance
4.3.2 Class Summary

4.4 AccessDenied Class

4.4.1 Constructor

4.5 ActionReq Class

4.5.1 Constructor

4.6 ActionRes Class

4.6.1 Constructor

4.7 AssocReleased Class

4.7.1 Constructor

4.8 CancelGetReq Class

4.8.1 Constructor

4.9 CancelGetRes Class

4.9.1 Constructor

4.10 ClassInstConfl Class

4.10.1 Constructor

4.11 CreateReq Class

4.11.1 Constructor

4.12 CreateRes Class

4.12.1 Constructor

4.13 DeleteReq Class

4.13.1 Constructor

4.14 DeleteRes Class

4.14.1 Constructor

4.15 DuplicateOI Class

4.15.1 Constructor

4.16 DupMessageId Class

4.16.1 Constructor

4.17 ErrorResUnexp Class

4.17.1 Constructor

4.18 EventReq Class

4.18.1 Constructor

4.19 GetListErr Class

4.19.1 Constructor

4.20 GetReq Class

4.20.1 Constructor

4.21 GetRes Class

4.21.1 Constructor

4.22 InvalidActionArg Class

4.22.1 Constructor

4.23 InvalidAttrVal Class

4.23.1 Constructor

4.24 InvalidEventArg Class

4.24.1 Constructor

4.25 InvalidFilter Class

4.25.1 Constructor

4.26 InvalidOI Class

4.26.1 Constructor

4.27 InvalidOperation Class

4.27.1 Constructor

4.28 InvalidOperator Class

4.28.1 Constructor

4.29 InvalidScope Class

4.29.1 Constructor

4.30 LinkedResUnexp Class

4.30.1 Constructor

4.31 Message Class

4.31.1 Constructor
4.31.2 Message Member Functions

4.32 MessageSAP Class

4.32.1 Constructor
4.32.2 MessageSAP Member Functions
4.32.3 MessageSAP Initialization

4.33 MessQOS Class
4.34 MessScope Class

4.34.1 Constructors

4.35 MissingAttrVal Class

4.35.1 Constructor

4.36 MistypedArg Class

4.36.1 Constructor

4.37 MistypedError Class

4.37.1 Constructor

4.38 MistypedOp Class

4.38.1 Constructor

4.39 MistypedRes Class

4.39.1 Constructor

4.40 NoSuchAction Class

4.40.1 Constructor

4.41 NoSuchActionArg Class

4.41.1 Constructor

4.42 NoSuchAttr Class

4.42.1 Constructor

4.43 NoSuchEvent Class

4.43.1 Constructor

4.44 NoSuchEventArg Class

4.44.1 Constructor

4.45 NoSuchMessageId Class

4.45.1 Constructor

4.46 NoSuchOC Class

4.46.1 Constructor

4.47 NoSuchOI Class

4.47.1 Constructor

4.48 NoSuchRefOI Class

4.48.1 Constructor

4.49 ObjReqMess Class

4.49.1 Constructor

4.50 ObjResMess Class

4.50.1 Constructor

4.51 OpCancelled Class

4.51.1 Constructor

4.52 ProcessFailure Class

4.52.1 Constructor

4.53 ReqMess Class

4.53.1 Constructor

4.54 ResMess Class

4.54.1 Constructor

4.55 ResourceLimit Class

4.55.1 Constructor

4.56 ScopedReqMess Class

4.56.1 Constructor

4.57 SetListErr Class

4.57.1 Constructor

4.58 SetReq Class

4.58.1 Constructor

4.59 SetRes Class

4.59.1 Constructor

4.60 SyncNotSupp Class

4.60.1 Constructor

4.61 TimedOut Class

4.61.1 Constructor

4.62 UnexpChildOp Class

4.62.1 Constructor

4.63 UnexpError Class

4.63.1 Constructor

4.64 UnexpRes Class

4.64.1 Constructor

4.65 UnrecError Class

4.65.1 Constructor

4.66 UnrecLinkedId Class

4.66.1 Constructor

4.67 UnrecMessageId Class

4.67.1 Constructor

4.68 UnrecOp Class

4.68.1 Constructor

4.69 Constants and Defined Types

4.69.1 MessId
4.69.2 MessMode
4.69.3 MessagePtr
4.69.4 MessScopeType
4.69.5 MessSync
4.69.6 MessBaseType
4.69.7 MessType
4.69.8 MESSTYPE_MAX
4.69.9 ResponseHandle
4.69.10 SendResult

5. Access Control API

5.1 Design Objectives
5.2 Access Control Types
5.3 Class Hierarchy
5.4 Symbolic Constants and Defined Types

5.4.1 Constants
5.4.2 Defined Types

5.5 Access Control API Classes
5.6 ACAccessControlRules Class

5.6.1 Constructor
5.6.2 Destructor
5.6.3 ACAccessControlRules Member Functions

5.7 ACAccessUserList Class

5.7.1 Constructor
5.7.2 Destructor
5.7.3 ACAccessUserList Member Functions

5.8 ACAppFeatureContainer Class

5.8.1 Constructor
5.8.2 Destructor
5.8.3 ACAppFeatureContainer Member Functions

5.9 ACApplication Class

5.9.1 Constructor
5.9.2 Destructor
5.9.3 ACApplication Member Functions

5.10 ACApplicationContainer Class

5.10.1 Constructor
5.10.2 Destructor
5.10.3 ACApplicationContainer Member Functions

5.11 ACApplicationFeature Class

5.11.1 Constructor
5.11.2 Destructor
5.11.3 ACApplicationFeature Member Functions

5.12 ACCallback Class

5.12.1 Constructors
5.12.2 Destructor
5.12.3 ACCallback Operator Overloading
5.12.4 ACCallback Member Functions

5.13 ACContainer Class

5.13.1 Constructor
5.13.2 Destructor
5.13.3 ACContainer Operator Overloading
5.13.4 ACContainer Member Functions

5.14 ACDbObject Class

5.14.1 Constructor
5.14.2 Destructor
5.14.3 ACDbObject Member Functions
5.14.4 Notes About the ACDbObject Class

5.15 ACDbObjectContainer Class

5.15.1 Constructor
5.15.2 Destructor
5.15.3 ACDbObjectContainer Member Functions

5.16 ACEMNotificationEmitter Class

5.16.1 Constructor
5.16.2 Destructor
5.16.3 ACEMNotificationEmitter Member Functions

5.17 ACEMTargets Class

5.17.1 Constructor
5.17.2 Destructor
5.17.3 ACEMTargets Member Functions

5.18 ACGroup Class

5.18.1 Constructor
5.18.2 Destructor
5.18.3 ACGroup Member Functions

5.19 ACGroupContainer Class

5.19.1 Constructor
5.19.2 Destructor
5.19.3 ACGroupContainer Member Functions

5.20 ACInterface Class

5.20.1 Constructor
5.20.2 Destructor
5.20.3 ACInterface Member Functions

5.21 ACObject Class

5.21.1 Constructor
5.21.2 Destructor
5.21.3 ACObject Operator Overloading
5.21.4 ACObject Member Functions

5.22 ACRule Class

5.22.1 Constructor
5.22.2 Destructor
5.22.3 ACRule Member Functions

5.23 ACRuleContainer Class

5.23.1 Constructor
5.23.2 Destructor
5.23.3 ACRuleContainer Member Functions

5.24 ACScope Class

5.24.1 Constructors

5.25 ACTargets Class

5.25.1 Constructor
5.25.2 Destructor
5.25.3 ACTargets Member Functions

5.26 ACTargetsContainer Class

5.26.1 Constructor
5.26.2 Destructor
5.26.3 ACTargetsContainer Member Functions

5.27 ACUser Class

5.27.1 Constructors
5.27.2 ACUser Operator Overloading
5.27.3 ACUser Member Functions

6. Access Control Engine API

6.1 Symbolic Constants

6.1.1 ACEOperationType
6.1.2 ACEEnforcementAction

6.2 ACE API Classes
6.3 ACE Class

6.3.1 Constructor
6.3.2 Destructor
6.3.3 ACE Member Functions

6.4 ACEContext Class

6.4.1 Constructor
6.4.2 Destructor
6.4.3 ACEContext Operator Overloading
6.4.4 ACEContext Member Functions

6.5 ACEDecision Class

6.5.1 Constructor
6.5.2 Destructor
6.5.3 ACEDecision Member Functions

6.6 ACEDomain Class

6.6.1 Constructor
6.6.2 Destructor
6.6.3 ACEDomain Member Function

6.7 ACEReqData Class

6.7.1 Constructor
6.7.2 Destructor

6.8 AuxServerUtils Class

6.8.1 Constructor
6.8.2 Destructor
6.8.3 AuxServerUtils Virtual Functions

7. Nerve Center Interface

7.1 Requests
7.2 Class and Function Summary
7.3 NC Requests

7.3.1 Synchronous Launches
7.3.2 Asynchronous Launches

7.4 NCI Library Classes
7.5 NCAsyncResIterator Class

7.5.1 Constructor
7.5.2 Destructor
7.5.3 Operator Overloading for Prefix Operator++
7.5.4 Member Functions

7.6 NCParsedReqHandle Class

7.6.1 Constructors
7.6.2 Default Destructor
7.6.3 Member Functions

7.7 NCTopoInfoList Class

7.7.1 Default Constructor
7.7.2 Copy Constructor
7.7.3 Destructor
7.7.4 Operator Overloading for Operator=
7.7.5 Member Functions

7.8 NCI Library Functions
7.9 NCI Global Variables

7.9.1 nci_error_reason
7.9.2 topoNodeId Argument

7.10 NCI Functions

7.10.1 nci_action_add
7.10.2 nci_action_delete
7.10.3 nci_async_request_start
7.10.4 nci_condition_add
7.10.5 nci_condition_delete
7.10.6 nci_condition_get
7.10.7 nci_init
7.10.8 nci_parse_handle
7.10.9 nci_pollrate_add
7.10.10 nci_pollrate_delete
7.10.11 nci_request_delete
7.10.12 nci_request_dump
7.10.13 nci_request_info
7.10.14 nci_request_list
7.10.15 nci_request_start
7.10.16 nci_severity_add
7.10.17 nci_severity_delete
7.10.18 nci_state_add
7.10.19 nci_state_delete
7.10.20 nci_state_get
7.10.21 nci_template_add
7.10.22 nci_template_copy
7.10.23 nci_template_create
7.10.24 nci_templete_delete
7.10.25 nci_template_find
7.10.26 nci_template_revert
7.10.27 nci_template_store
7.10.28 nci_transition_add
7.10.29 nci_transition_delete
7.10.30 nci_transition_find
7.10.31 nci_transition_get

8. Topology API

8.1 Topology Classes

8.1.1 General Comments
8.1.2 General Description

8.2 Class Overview

8.2.1 Relationship to the GDMO
8.2.2 Relationship to PMI

8.3 EMTopoPlatform Class

8.3.1 get_attributes_by_mo()
8.3.2 set_attributes_by_mo()

8.4 Persistent Object Classes

8.4.1 EMObject Class
8.4.2 EMObject Member Functions
8.4.3 EMTopoType Class
8.4.4 EMTopoNode Class
8.4.5 EMSnmpAgent Class
8.4.6 EMCmipAgent Class
8.4.7 EMRpcAgent Class

8.5 Utility Classes

8.5.1 EMIntegerSet Class
8.5.2 EMStatus Class

8.6 Topology API Concepts

8.6.1 Element Naming
8.6.2 Duplicate Topology Node Names
8.6.3 MIS-MIS Awareness
8.6.4 Performance Considerations

8.7 Examples

8.7.1 Makefile
8.7.2 Finding Topology Nodes
8.7.3 Registering Events for EMTopoNode
8.7.4 Printing the Topology Hierarchy

8.8 Class Reference
8.9 EMStatus Class

8.9.1 Constructors and Destructor
8.9.2 Operators
8.9.3 Global Operators

8.10 EMIntegerSet Class

8.10.1 Example
8.10.2 Constructors and Destructor
8.10.3 Operators
8.10.4 Member Functions
8.10.5 Global Operators

8.11 EMIntegerSetIterator Class

8.11.1 Example
8.11.2 Constructors and Destructor
8.11.3 Member Functions

8.12 EMTopoPlatform Class

8.12.1 Example
8.12.2 Static Member Functions
8.12.3 Access Member Functions
8.12.4 General Member Functions

8.13 EMObject Class

8.13.1 Constructors and Destructor
8.13.2 EMObject Member Functions Supported By POC Classes
8.13.3 Operators Supported by all POC classes
8.13.4 Other Member Functions Supported by POC Classes.
8.13.5 Static Member Functions Supported by POC Classes

8.14 EMTopoNodeDn Class

8.14.1 Constructors and Destructor
8.14.2 Operators
8.14.3 Access Member Functions
8.14.4 General Member Functions
8.14.5 Related Global Operators

8.15 EMTopoNode Class

8.15.1 Example
8.15.2 Constructors and Destructor
8.15.3 Access Member Functions
8.15.4 Static Member Functions for Event Subscription
8.15.5 Related Global Operators

8.16 EMTopoTypeDn Class

8.16.1 Constants
8.16.2 Constructors and Destructor
8.16.3 Operators
8.16.4 Access Member Functions
8.16.5 General Member Functions

8.17 EMTopoType Class

8.17.1 Example
8.17.2 Constructors and Destructor
8.17.3 Operators
8.17.4 Access Member Functions
8.17.5 Static Member Functions
8.17.6 Static Member Functions for Event Subscription
8.17.7 Global Operators

8.18 EMAgent Class

8.18.1 Access Member Functions

8.19 EMCmipAgentDn Class

8.19.1 Constructors and Destructor
8.19.2 Operators
8.19.3 Access Member Functions
8.19.4 General Member Functions
8.19.5 Related Global Operators

8.20 EMCmipAgent Class

8.20.1 Example
8.20.2 Access Member Functions
8.20.3 Global Operators

8.21 EMRpcAgentDn Class

8.21.1 Constructors and Destructor
8.21.2 Operators
8.21.3 Access Member Functions
8.21.4 General Member Functions
8.21.5 Global Operators

8.22 EMRpcAgent Class

8.22.1 Example
8.22.2 Constructors and Destructor
8.22.3 Access Member Functions
8.22.4 Global Operators

8.23 EMSnmpAgentDn Class

8.23.1 Constructors, and Destructor
8.23.2 Operators
8.23.3 Access Member Functions
8.23.4 General Member Functions
8.23.5 Global Operators

8.24 EMSnmpAgent Class

8.24.1 Example
8.24.2 Constructors and Destructor
8.24.3 Access Member Functions
8.24.4 Related Global Operators

9. Object Services API

9.1 Operational Flow
9.2 Service Request Function Parameters
9.3 Service Response Callback Function Parameters
9.4 Services Interface Descriptions and Examples

9.4.1 Get Request Service
9.4.2 Get Response Callback
9.4.3 Set Request Service
9.4.4 Set Response Callback
9.4.5 Action Request Service
9.4.6 Action Response Callback
9.4.7 Create Request Service
9.4.8 Create Response Callback
9.4.9 Delete Request Service
9.4.10 Delete Response Callback
9.4.11 Delete Response Callback Parameter Description
9.4.12 Event Report Request Service (Unconfirmed)
9.4.13 Event Report Response Callback

9.5 Supporting Functions for Example Code

9.5.1 Debugging Flags
9.5.2 get_sys_dn Function
9.5.3 get_graphstr_rdn Function

Sun Microsystems, Inc.
Copyright information. All rights reserved.

Doc Set | Next | Index