aspAmfEntity.AmfComponent Class Reference
Class that models a SAF component; essentially a process. More...
Inheritance diagram for aspAmfEntity.AmfComponent:
Collaboration diagram for aspAmfEntity.AmfComponent:
Public Member Functions | |
| def | __init__ |
| def | isRunning |
| Return true if it is running. More... | |
| def | isIdle |
| Return if it is running but has not assigned work. More... | |
| def | isActive |
| Return true if this CSIs assigned 'active' to it. More... | |
| def | isStandby |
| Return true if this CSIs assigned 'standby' to it. More... | |
| def | haRole |
| Return 'none', 'active', 'standby', or 'active/standby' depending on the roles of SUs on this node. More... | |
| def | adminState |
| Return the administrative status of this entity. More... | |
| def | failureCount |
| Return the number of failures that have occurred on this component since the last failover. More... | |
| def | command |
| What command was run to start this up. More... | |
 Public Member Functions inherited from aspAmfEntity.AmfEntity | |
| def | __init__ |
| Constructor Parameters: typee: The AMF type of this entity. More... | |
| def | __cmp__ |
| The comparison operator simply compares entity names since the AMF mandates that entity names are unique. More... | |
| def | __hash__ |
| def | __str__ |
| def | setInitialState |
| Set the initial state of this entity (call before you pass the object to aspAmf) More... | |
| def | copyLocalState |
| Copy the locally kept state in this entity from one entity to another of the same type. More... | |
| def | setConfig |
| def | setState |
| def | setStatus |
| def | isRunning |
| Return true if this entity is running. More... | |
| def | isProtected |
| Return true if this service instance has at least 1 running standby assignment, None if not applicable. More... | |
| def | isIdle |
| Return True if the entity is running but has no assigned work, or None if the concept of 'idle' is not applicable. More... | |
| def | isOk |
| Return True if the entity is 100%. More... | |
| def | adminState |
| Return the administrative status of this entity. More... | |
| def | enabled |
| Return True if this entity is enabled, False if not enabled, or none if not applicable (for example the entity has not been applied into the AMF). More... | |
Public Attributes | |
| su | |
| The service unit that "owns" this component. More... | |
| supportedCsis | |
| The set of CSI types that can be assigned to this component. More... | |
| timeouts | |
| The component health timeouts – this variable should be used for assignment only for current state, use self.cconfig. More... | |
| Public Attributes inherited from aspAmfEntity.AmfEntity | |
| type | |
| SAF AMF type of the entity (see module-global variable that define available types) More... | |
| name | |
| Name of this entity as known by the AMF. More... | |
| associatedData | |
| initialState | |
| cconfig | |
| SAF AMF configuration of the entity. More... | |
| cstatus | |
Detailed Description
Class that models a SAF component; essentially a process.
Constructor & Destructor Documentation
| def aspAmfEntity.AmfComponent.__init__ | ( | self, | |
| name, | |||
compType = None |
|||
| ) |
Member Function Documentation
| def aspAmfEntity.AmfComponent.adminState | ( | self | ) |
Return the administrative status of this entity.
| def aspAmfEntity.AmfComponent.command | ( | self | ) |
What command was run to start this up.
| def aspAmfEntity.AmfComponent.failureCount | ( | self | ) |
Return the number of failures that have occurred on this component since the last failover.
| def aspAmfEntity.AmfComponent.haRole | ( | self | ) |
Return 'none', 'active', 'standby', or 'active/standby' depending on the roles of SUs on this node.
| def aspAmfEntity.AmfComponent.isActive | ( | self | ) |
Return true if this CSIs assigned 'active' to it.
| def aspAmfEntity.AmfComponent.isIdle | ( | self | ) |
Return if it is running but has not assigned work.
| def aspAmfEntity.AmfComponent.isRunning | ( | self | ) |
Return true if it is running.
| def aspAmfEntity.AmfComponent.isStandby | ( | self | ) |
Return true if this CSIs assigned 'standby' to it.
Member Data Documentation
| aspAmfEntity.AmfComponent.su |
The service unit that "owns" this component.
| aspAmfEntity.AmfComponent.supportedCsis |
The set of CSI types that can be assigned to this component.
| aspAmfEntity.AmfComponent.timeouts |
The component health timeouts – this variable should be used for assignment only for current state, use self.cconfig.
