2013-06-18 03:08:37 +02:00
<?xml version="1.0" encoding="ascii"?>
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
< head >
< title > linspector.lib.tasks.task< / title >
< link rel = "stylesheet" href = "epydoc.css" type = "text/css" / >
< script type = "text/javascript" src = "epydoc.js" > < / script >
< / head >
< body bgcolor = "white" text = "black" link = "blue" vlink = "#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
< table class = "navbar" border = "0" width = "100%" cellpadding = "0"
bgcolor="#a0c0ff" cellspacing="0">
< tr valign = "middle" >
<!-- Home link -->
< th > < a
href="linspector-module.html">Home< / a > < / th >
<!-- Tree link -->
< th > < a
href="module-tree.html">Trees< / a > < / th >
<!-- Index link -->
< th > < a
href="identifier-index.html">Indices< / a > < / th >
<!-- Help link -->
< th > < a
href="help.html">Help< / a > < / th >
< th class = "navbar" width = "100%" > < / th >
< / tr >
< / table >
< table width = "100%" cellpadding = "0" cellspacing = "0" >
< tr valign = "top" >
< td width = "100%" >
< span class = "breadcrumbs" >
< a href = "linspector-module.html" > Package linspector< / a > ::
< a href = "linspector.lib-module.html" > Package lib< / a > ::
< a href = "linspector.lib.tasks-module.html" > Package tasks< / a > ::
Module task
< / span >
< / td >
< td >
< table cellpadding = "0" cellspacing = "0" >
<!-- hide/show private -->
< tr > < td align = "right" > < span class = "options" > [< a href = "javascript:void(0);" class = "privatelink"
onclick="toggle_private();">hide private< / a > ]< / span > < / td > < / tr >
< tr > < td align = "right" > < span class = "options"
>[< a href = "frames.html" target = "_top" > frames< /a
>] | < a href = "linspector.lib.tasks.task-pysrc.html"
target="_top">no frames< / a > ]< / span > < / td > < / tr >
< / table >
< / td >
< / tr >
< / table >
< h1 class = "epydoc" > Source Code for < a href = "linspector.lib.tasks.task-module.html" > Module linspector.lib.tasks.task< / a > < / h1 >
< pre class = "py-src" >
< a name = "L1" > < / a > < tt class = "py-lineno" > 1< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
2013-06-19 03:27:20 +02:00
< a name = "L2" > < / a > < tt class = "py-lineno" > 2< / tt > < tt class = "py-line" > < tt class = "py-docstring" > The task class.< / tt > < / tt >
< a name = "L3" > < / a > < tt class = "py-lineno" > 3< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L4" > < / a > < tt class = "py-lineno" > 4< / tt > < tt class = "py-line" > < / tt >
< a name = "L5" > < / a > < tt class = "py-lineno" > 5< / tt > < tt class = "py-line" > < / tt >
< a name = "Task" > < / a > < div id = "Task-def" > < a name = "L6" > < / a > < tt class = "py-lineno" > 6< / tt > < a class = "py-toggle" href = "#" id = "Task-toggle" onclick = "return toggle('Task');" > -< / a > < tt class = "py-line" > < tt class = "py-keyword" > class< / tt > < a class = "py-def-name" href = "linspector.lib.tasks.task.Task-class.html" > Task< / a > < tt class = "py-op" > :< / tt > < / tt >
< / div > < div id = "Task-collapsed" style = "display:none;" pad = "++" indent = "++++" > < / div > < div id = "Task-expanded" > < a name = "L7" > < / a > < tt class = "py-lineno" > 7< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L8" > < / a > < tt class = "py-lineno" > 8< / tt > < tt class = "py-line" > < tt class = "py-docstring" > Base class for all built-in Tasks.< / tt > < / tt >
< a name = "L9" > < / a > < tt class = "py-lineno" > 9< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L10" > < / a > < tt class = "py-lineno" > 10< / tt > < tt class = "py-line" > < / tt >
< a name = "Task.set_task_type" > < / a > < div id = "Task.set_task_type-def" > < a name = "L11" > < / a > < tt class = "py-lineno" > 11< / tt > < a class = "py-toggle" href = "#" id = "Task.set_task_type-toggle" onclick = "return toggle('Task.set_task_type');" > -< / a > < tt class = "py-line" > < tt class = "py-keyword" > def< / tt > < a class = "py-def-name" href = "linspector.lib.tasks.task.Task-class.html#set_task_type" > set_task_type< / a > < tt class = "py-op" > (< / tt > < tt class = "py-param" > self< / tt > < tt class = "py-op" > ,< / tt > < tt class = "py-param" > taskType< / tt > < tt class = "py-op" > )< / tt > < tt class = "py-op" > :< / tt > < / tt >
< / div > < div id = "Task.set_task_type-collapsed" style = "display:none;" pad = "++" indent = "++++++++" > < / div > < div id = "Task.set_task_type-expanded" > < a name = "L12" > < / a > < tt class = "py-lineno" > 12< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L13" > < / a > < tt class = "py-lineno" > 13< / tt > < tt class = "py-line" > < tt class = "py-docstring" > sets the type of this task.< / tt > < / tt >
< a name = "L14" > < / a > < tt class = "py-lineno" > 14< / tt > < tt class = "py-line" > < tt class = "py-docstring" > < / tt > < / tt >
< a name = "L15" > < / a > < tt class = "py-lineno" > 15< / tt > < tt class = "py-line" > < tt class = "py-docstring" > Be aware! this method can only get called once!< / tt > < / tt >
2013-06-18 03:08:37 +02:00
< a name = "L16" > < / a > < tt class = "py-lineno" > 16< / tt > < tt class = "py-line" > < tt class = "py-docstring" > < / tt > < / tt >
2013-06-19 03:27:20 +02:00
< a name = "L17" > < / a > < tt class = "py-lineno" > 17< / tt > < tt class = "py-line" > < tt class = "py-docstring" > :param taskType: the type of this task< / tt > < / tt >
< a name = "L18" > < / a > < tt class = "py-lineno" > 18< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L19" > < / a > < tt class = "py-lineno" > 19< / tt > < tt class = "py-line" > < tt class = "py-keyword" > if< / tt > < tt class = "py-name" > hasattr< / tt > < tt class = "py-op" > (< / tt > < tt class = "py-name" > self< / tt > < tt class = "py-op" > ,< / tt > < tt class = "py-string" > "_taskType"< / tt > < tt class = "py-op" > )< / tt > < tt class = "py-op" > :< / tt > < / tt >
< a name = "L20" > < / a > < tt class = "py-lineno" > 20< / tt > < tt class = "py-line" > < tt class = "py-keyword" > raise< / tt > < tt class = "py-name" > Exception< / tt > < tt class = "py-op" > (< / tt > < tt class = "py-string" > "taskType is only allowed to set once!"< / tt > < tt class = "py-op" > )< / tt > < / tt >
< a name = "L21" > < / a > < tt class = "py-lineno" > 21< / tt > < tt class = "py-line" > < tt class = "py-name" > self< / tt > < tt class = "py-op" > .< / tt > < tt class = "py-name" > taskType< / tt > < tt class = "py-op" > =< / tt > < tt class = "py-name" > taskType< / tt > < / tt >
< / div > < a name = "L22" > < / a > < tt class = "py-lineno" > 22< / tt > < tt class = "py-line" > < / tt >
< a name = "Task.get_task_type" > < / a > < div id = "Task.get_task_type-def" > < a name = "L23" > < / a > < tt class = "py-lineno" > 23< / tt > < a class = "py-toggle" href = "#" id = "Task.get_task_type-toggle" onclick = "return toggle('Task.get_task_type');" > -< / a > < tt class = "py-line" > < tt class = "py-keyword" > def< / tt > < a class = "py-def-name" href = "linspector.lib.tasks.task.Task-class.html#get_task_type" > get_task_type< / a > < tt class = "py-op" > (< / tt > < tt class = "py-param" > self< / tt > < tt class = "py-op" > )< / tt > < tt class = "py-op" > :< / tt > < / tt >
< / div > < div id = "Task.get_task_type-collapsed" style = "display:none;" pad = "++" indent = "++++++++" > < / div > < div id = "Task.get_task_type-expanded" > < a name = "L24" > < / a > < tt class = "py-lineno" > 24< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L25" > < / a > < tt class = "py-lineno" > 25< / tt > < tt class = "py-line" > < tt class = "py-docstring" > :return: the type set by set_type_task< / tt > < / tt >
< a name = "L26" > < / a > < tt class = "py-lineno" > 26< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L27" > < / a > < tt class = "py-lineno" > 27< / tt > < tt class = "py-line" > < tt class = "py-keyword" > return< / tt > < tt class = "py-name" > self< / tt > < tt class = "py-op" > .< / tt > < tt class = "py-name" > _taskType< / tt > < / tt >
< / div > < a name = "L28" > < / a > < tt class = "py-lineno" > 28< / tt > < tt class = "py-line" > < / tt >
< a name = "Task.execute_task" > < / a > < div id = "Task.execute_task-def" > < a name = "L29" > < / a > < tt class = "py-lineno" > 29< / tt > < a class = "py-toggle" href = "#" id = "Task.execute_task-toggle" onclick = "return toggle('Task.execute_task');" > -< / a > < tt class = "py-line" > < tt class = "py-keyword" > def< / tt > < a class = "py-def-name" href = "linspector.lib.tasks.task.Task-class.html#execute_task" > execute_task< / a > < tt class = "py-op" > (< / tt > < tt class = "py-param" > self< / tt > < tt class = "py-op" > ,< / tt > < tt class = "py-param" > msg< / tt > < tt class = "py-op" > )< / tt > < tt class = "py-op" > :< / tt > < / tt >
< / div > < div id = "Task.execute_task-collapsed" style = "display:none;" pad = "++" indent = "++++++++" > < / div > < div id = "Task.execute_task-expanded" > < a name = "L30" > < / a > < tt class = "py-lineno" > 30< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L31" > < / a > < tt class = "py-lineno" > 31< / tt > < tt class = "py-line" > < tt class = "py-docstring" > this is the method tasks usually override. < / tt > < / tt >
< a name = "L32" > < / a > < tt class = "py-lineno" > 32< / tt > < tt class = "py-line" > < tt class = "py-docstring" > It gets called anytime the task should get executed< / tt > < / tt >
< a name = "L33" > < / a > < tt class = "py-lineno" > 33< / tt > < tt class = "py-line" > < tt class = "py-docstring" > < / tt > < / tt >
< a name = "L34" > < / a > < tt class = "py-lineno" > 34< / tt > < tt class = "py-line" > < tt class = "py-docstring" > default does nothing< / tt > < / tt >
< a name = "L35" > < / a > < tt class = "py-lineno" > 35< / tt > < tt class = "py-line" > < tt class = "py-docstring" > < / tt > < / tt >
< a name = "L36" > < / a > < tt class = "py-lineno" > 36< / tt > < tt class = "py-line" > < tt class = "py-docstring" > :param msg: the msg for this task< / tt > < / tt >
< a name = "L37" > < / a > < tt class = "py-lineno" > 37< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L38" > < / a > < tt class = "py-lineno" > 38< / tt > < tt class = "py-line" > < tt class = "py-keyword" > pass< / tt > < / tt >
< / div > < a name = "L39" > < / a > < tt class = "py-lineno" > 39< / tt > < tt class = "py-line" > < / tt >
< a name = "Task._execute" > < / a > < div id = "Task._execute-def" > < a name = "L40" > < / a > < tt class = "py-lineno" > 40< / tt > < a class = "py-toggle" href = "#" id = "Task._execute-toggle" onclick = "return toggle('Task._execute');" > -< / a > < tt class = "py-line" > < tt class = "py-keyword" > def< / tt > < a class = "py-def-name" href = "linspector.lib.tasks.task.Task-class.html#_execute" > _execute< / a > < tt class = "py-op" > (< / tt > < tt class = "py-param" > self< / tt > < tt class = "py-op" > ,< / tt > < tt class = "py-param" > taskType< / tt > < tt class = "py-op" > ,< / tt > < tt class = "py-param" > msg< / tt > < tt class = "py-op" > )< / tt > < tt class = "py-op" > :< / tt > < / tt >
< / div > < div id = "Task._execute-collapsed" style = "display:none;" pad = "++" indent = "++++++++" > < / div > < div id = "Task._execute-expanded" > < a name = "L41" > < / a > < tt class = "py-lineno" > 41< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L42" > < / a > < tt class = "py-lineno" > 42< / tt > < tt class = "py-line" > < tt class = "py-docstring" > internal method which gets called for any member in a hostgroup.< / tt > < / tt >
< a name = "L43" > < / a > < tt class = "py-lineno" > 43< / tt > < tt class = "py-line" > < tt class = "py-docstring" > It determines if it has an appropriate type by comparing taskType with get_task_type().< / tt > < / tt >
< a name = "L44" > < / a > < tt class = "py-lineno" > 44< / tt > < tt class = "py-line" > < tt class = "py-docstring" > Calls execute_task() if the type matches< / tt > < / tt >
< a name = "L45" > < / a > < tt class = "py-lineno" > 45< / tt > < tt class = "py-line" > < tt class = "py-docstring" > < / tt > < / tt >
< a name = "L46" > < / a > < tt class = "py-lineno" > 46< / tt > < tt class = "py-line" > < tt class = "py-docstring" > :param taskType: the type of the fail which is compared with get_task_type()< / tt > < / tt >
< a name = "L47" > < / a > < tt class = "py-lineno" > 47< / tt > < tt class = "py-line" > < tt class = "py-docstring" > :param msg: the error message< / tt > < / tt >
< a name = "L48" > < / a > < tt class = "py-lineno" > 48< / tt > < tt class = "py-line" > < tt class = "py-docstring" > < / tt > < / tt >
< a name = "L49" > < / a > < tt class = "py-lineno" > 49< / tt > < tt class = "py-line" > < tt class = "py-docstring" > :return: True if execute_task() is called succesfully, else False< / tt > < / tt >
< a name = "L50" > < / a > < tt class = "py-lineno" > 50< / tt > < tt class = "py-line" > < tt class = "py-docstring" > """< / tt > < / tt >
< a name = "L51" > < / a > < tt class = "py-lineno" > 51< / tt > < tt class = "py-line" > < tt class = "py-keyword" > if< / tt > < tt class = "py-name" > self< / tt > < tt class = "py-op" > .< / tt > < tt id = "link-0" class = "py-name" targets = "Method linspector.lib.tasks.task.Task.get_task_type()=linspector.lib.tasks.task.Task-class.html#get_task_type" > < a title = "linspector.lib.tasks.task.Task.get_task_type" class = "py-name" href = "#" onclick = "return doclink('link-0', 'get_task_type', 'link-0');" > get_task_type< / a > < / tt > < tt class = "py-op" > (< / tt > < tt class = "py-op" > )< / tt > < tt class = "py-op" > ==< / tt > < tt class = "py-name" > taskType< / tt > < tt class = "py-op" > :< / tt > < / tt >
< a name = "L52" > < / a > < tt class = "py-lineno" > 52< / tt > < tt class = "py-line" > < tt class = "py-name" > self< / tt > < tt class = "py-op" > .< / tt > < tt id = "link-1" class = "py-name" targets = "Method linspector.lib.tasks.email.EmailTask.execute_task()=linspector.lib.tasks.email.EmailTask-class.html#execute_task,Method linspector.lib.tasks.sms.SmsTask.execute_task()=linspector.lib.tasks.sms.SmsTask-class.html#execute_task,Method linspector.lib.tasks.task.Task.execute_task()=linspector.lib.tasks.task.Task-class.html#execute_task,Method linspector.lib.tasks.xmpp.XmppTask.execute_task()=linspector.lib.tasks.xmpp.XmppTask-class.html#execute_task" > < a title = "linspector.lib.tasks.email.EmailTask.execute_task
2013-06-18 03:08:37 +02:00
linspector.lib.tasks.sms.SmsTask.execute_task
linspector.lib.tasks.task.Task.execute_task
linspector.lib.tasks.xmpp.XmppTask.execute_task" class="py-name" href="#" onclick="return doclink('link-1', 'execute_task', 'link-1');">execute_task< / a > < / tt > < tt class = "py-op" > (< / tt > < tt class = "py-name" > msg< / tt > < tt class = "py-op" > )< / tt > < / tt >
2013-06-19 03:27:20 +02:00
< a name = "L53" > < / a > < tt class = "py-lineno" > 53< / tt > < tt class = "py-line" > < tt class = "py-keyword" > return< / tt > < tt class = "py-name" > True< / tt > < / tt >
< a name = "L54" > < / a > < tt class = "py-lineno" > 54< / tt > < tt class = "py-line" > < tt class = "py-keyword" > return< / tt > < tt class = "py-name" > False< / tt > < / tt >
< / div > < / div > < a name = "L55" > < / a > < tt class = "py-lineno" > 55< / tt > < tt class = "py-line" > < / tt > < script type = "text/javascript" >
2013-06-18 03:08:37 +02:00
<!--
expandto(location.href);
// -->
< / script >
< / pre >
< br / >
<!-- ==================== NAVIGATION BAR ==================== -->
< table class = "navbar" border = "0" width = "100%" cellpadding = "0"
bgcolor="#a0c0ff" cellspacing="0">
< tr valign = "middle" >
<!-- Home link -->
< th > < a
href="linspector-module.html">Home< / a > < / th >
<!-- Tree link -->
< th > < a
href="module-tree.html">Trees< / a > < / th >
<!-- Index link -->
< th > < a
href="identifier-index.html">Indices< / a > < / th >
<!-- Help link -->
< th > < a
href="help.html">Help< / a > < / th >
< th class = "navbar" width = "100%" > < / th >
< / tr >
< / table >
< table border = "0" cellpadding = "0" cellspacing = "0" width = "100%%" >
< tr >
< td align = "left" class = "footer" >
2013-06-19 03:27:20 +02:00
Generated by Epydoc 3.0.1 on Wed Jun 19 03:26:57 2013
2013-06-18 03:08:37 +02:00
< / td >
< td align = "right" class = "footer" >
< a target = "mainFrame" href = "http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net< / a >
< / td >
< / tr >
< / table >
< script type = "text/javascript" >
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
< / script >
< / body >
< / html >
