SAFplus Runtime Director API  3.0.5
aspAmfEntity.AmfServiceInstance Class Reference

Class that models a SAF Service Instance; essentially this is a work assignment. More...

Inheritance diagram for aspAmfEntity.AmfServiceInstance:
Collaboration diagram for aspAmfEntity.AmfServiceInstance:

Public Member Functions

def __init__
 
def isRunning
 Return true if this service instance is assigned. More...
 
def isIdle
 Return true if this service instance is not assigned. More...
 
def isProtected
 Return true if this service instance has at least 1 running standby assignment. More...
 
def redundancyModel
 Return the redundancy model (integer enum). More...
 
def ActiveNode
 Return what node (AmfNode object) this SI is assigned active on, or None if it is not active anywhere. More...
 
def StandbyNode
 Return what node (AmfNode object) this SI is assigned standby on, or None if it is not standby anywhere. 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

 numStandbyAssignments
 
 sg
 The SAF AMF service group that owns by this service instance. More...
 
 csi
 List of the SAF component service instances (CSI) that are owned by this SI. More...
 
 rank
 This service instance's rank. More...
 
 activeSu
 Which Service Unit is configured "Active" for this SI (or None if there is no active) More...
 
 standbySu
 Which Service Unit is configured "Standby" for this SI (or None if there is no standby) 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 Service Instance; essentially this is a work assignment.

Constructor & Destructor Documentation

def aspAmfEntity.AmfServiceInstance.__init__ (   self,
  name 
)

Member Function Documentation

def aspAmfEntity.AmfServiceInstance.ActiveNode (   self)

Return what node (AmfNode object) this SI is assigned active on, or None if it is not active anywhere.

def aspAmfEntity.AmfServiceInstance.isIdle (   self)

Return true if this service instance is not assigned.

def aspAmfEntity.AmfServiceInstance.isProtected (   self)

Return true if this service instance has at least 1 running standby assignment.

def aspAmfEntity.AmfServiceInstance.isRunning (   self)

Return true if this service instance is assigned.

def aspAmfEntity.AmfServiceInstance.redundancyModel (   self)

Return the redundancy model (integer enum).

The redundancy model of the work is that of the parent SG

def aspAmfEntity.AmfServiceInstance.StandbyNode (   self)

Return what node (AmfNode object) this SI is assigned standby on, or None if it is not standby anywhere.

Member Data Documentation

aspAmfEntity.AmfServiceInstance.activeSu

Which Service Unit is configured "Active" for this SI (or None if there is no active)

aspAmfEntity.AmfServiceInstance.csi

List of the SAF component service instances (CSI) that are owned by this SI.

aspAmfEntity.AmfServiceInstance.numStandbyAssignments
aspAmfEntity.AmfServiceInstance.rank

This service instance's rank.

For information about rank ordering, see the SAF AMF spec (www.saforum.org)

aspAmfEntity.AmfServiceInstance.sg

The SAF AMF service group that owns by this service instance.

aspAmfEntity.AmfServiceInstance.standbySu

Which Service Unit is configured "Standby" for this SI (or None if there is no standby)