Python Api  IE10.1
Classes | Namespaces | Functions | Variables
pluginfw.py File Reference

Classes

class  pluginfw.PluginError
 plugin error code More...
 
class  pluginfw.Thread
 Wrapper class of threading.Thread for pluginfw If we need use multi-threads in plugin, we need copy the context to new thread. More...
 

Namespaces

 pluginfw
 

Functions

def pluginfw.GetOpUserId ()
 get the operation user id. More...
 
def pluginfw.GetOpUserName ()
 get the operation user name. More...
 
def pluginfw.GetTaskId ()
 get the worker task id. More...
 
def pluginfw.GetAPIContext ()
 Get Context Object Pointer in FW Worker, this Context Object is local in thread. More...
 
def pluginfw.SetAPIContext (contextAddr)
 This method will clone one Context Object in new thread. More...
 
def pluginfw.ReleaseAPIContext ()
 set the plugin API context to null. More...
 
def pluginfw.AddLog (content, logType=INFO)
 Add logs to plugin exction. More...
 
def pluginfw.GetExcutionLogs ()
 get excution log in current task. More...
 
def pluginfw.IsUserStopped ()
 Test if the task has canceled by user. More...
 
def pluginfw.SetError (errorCode, errorMsg)
 Set the error message and error code. More...
 
def pluginfw.GetRunParam ()
 Get the plugin running params. More...
 
def pluginfw.GetXfTaskId ()
 Get the xf task id of plugin schedluler(benchmrak task id,discover task id,schedule plugin task id) More...
 
def pluginfw.GetTaskSourceType ()
 Get the xf task source type. More...
 
def pluginfw.GetTaskSourceId ()
 get the task source id,it is the Id of benchmarkdefine or shceduleplugin More...
 
def pluginfw.GetTaskTargetDevices ()
 Get target devices of current task,work only if current task type is Benchmark,otherwise return empty list. More...
 
def pluginfw.GetTaskAPIServerIDList ()
 Get sdn scope range of current task,work only if current task type is Benchmark,otherwise return empty list. More...
 
def pluginfw.GetQualifyDeviceIds ()
 

Variables

int pluginfw.DEBUG = 0
 debug log level More...
 
int pluginfw.INFO = 1
 info log level More...
 
int pluginfw.WARNING = 2
 waring log level More...
 
int pluginfw.ERROR = 3
 error log level More...