python-kiwi 1.9.22-4 / usr / share / doc / python-kiwi / api / kiwi.tasklet.WaitCondition.html

This file is indexed.

/usr/share/doc/python-kiwi/api/kiwi.tasklet.WaitCondition.html is in python-kiwi 1.9.22-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
          "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>kiwi.tasklet.WaitCondition : API documentation</title>

    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
    <link type="text/css" rel="stylesheet" href="bootstrap.min.css" />
    <link type="text/css" rel="stylesheet" href="apidocs.css" />
  </head>
  <body>

    <nav class="navbar navbar-default">
      <div class="container">
        <div class="navbar-header">
          <a class="navbar-brand" href="index.html">
            Kiwi API Documentation
          </a>
        </div>
      </div>
    </nav>

    <div id="showPrivate">
      <button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
    </div>

    <div class="container">

      <div class="page-header">
        <h1 class="class"><code>kiwi.tasklet.WaitCondition(<span title="object">object</span>)</code> <small>class documentation</small></h1>

        <span id="partOf">
          Part of <code><a href="kiwi.html" data-type="Package" class="code">kiwi</a>.<a href="kiwi.tasklet.html" data-type="Module" class="code">tasklet</a></code>
          
          <a href="classIndex.html#kiwi.tasklet.WaitCondition">(View In Hierarchy)</a>
        </span>
      </div>

      <div class="extrasDocstring">
        <p>Known subclasses: <a href="kiwi.tasklet.WaitForCall.html" data-type="Class" class="code">kiwi.tasklet.WaitForCall</a>, <a href="kiwi.tasklet.WaitForIdle.html" data-type="Class" class="code">kiwi.tasklet.WaitForIdle</a>, <a href="kiwi.tasklet.WaitForIO.html" data-type="Class" class="code">kiwi.tasklet.WaitForIO</a>, <a href="kiwi.tasklet.WaitForMessages.html" data-type="Class" class="code">kiwi.tasklet.WaitForMessages</a>, <a href="kiwi.tasklet.WaitForProcess.html" data-type="Class" class="code">kiwi.tasklet.WaitForProcess</a>, <a href="kiwi.tasklet.WaitForSignal.html" data-type="Class" class="code">kiwi.tasklet.WaitForSignal</a>, <a href="kiwi.tasklet.WaitForTasklet.html" data-type="Class" class="code">kiwi.tasklet.WaitForTasklet</a>, <a href="kiwi.tasklet.WaitForTimeout.html" data-type="Class" class="code">kiwi.tasklet.WaitForTimeout</a></p>
      </div>

      <div class="moduleDocstring">
        <div><p>Base class for all wait-able condition objects.</p>
<p>WaitConditions are used in a yield statement inside tasklets body for 
specifying what event(s) it should wait for in order to receive control 
once more.</p><table class="fieldTable"></table></div>
      </div>

      <div id="splitTables">
        <table class="children sortable" id="id21">
  
  <tr class="method">
    
    <td>Method</td>
    <td><a href="kiwi.tasklet.WaitCondition.html#__init__" data-type="Method" class="code">__init__</a></td>
    <td><span>Abstract base class, do not call directly</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="kiwi.tasklet.WaitCondition.html#arm" data-type="Method" class="code">arm</a></td>
    <td><span>Prepare the wait condition to receive events.</span></td>
  </tr><tr class="method">
    
    <td>Method</td>
    <td><a href="kiwi.tasklet.WaitCondition.html#disarm" data-type="Method" class="code">disarm</a></td>
    <td><span>Stop the wait condition from receiving events.</span></td>
  </tr>
</table>
        

          
      </div>

      <div id="childList">

        <div class="basemethod">
  
  <a name="kiwi.tasklet.WaitCondition.__init__">
    
  </a>
  <a name="__init__">
    
  </a>
  <div class="functionHeader">
    
    def
    __init__(self):
    
  </div>
  <div class="docstring functionBody">
    <div class="interfaceinfo">overridden in <a href="kiwi.tasklet.WaitForCall.html" data-type="Class" class="code">kiwi.tasklet.WaitForCall</a>, <a href="kiwi.tasklet.WaitForIdle.html" data-type="Class" class="code">kiwi.tasklet.WaitForIdle</a>, <a href="kiwi.tasklet.WaitForIO.html" data-type="Class" class="code">kiwi.tasklet.WaitForIO</a>, <a href="kiwi.tasklet.WaitForMessages.html" data-type="Class" class="code">kiwi.tasklet.WaitForMessages</a>, <a href="kiwi.tasklet.WaitForProcess.html" data-type="Class" class="code">kiwi.tasklet.WaitForProcess</a>, <a href="kiwi.tasklet.WaitForSignal.html" data-type="Class" class="code">kiwi.tasklet.WaitForSignal</a>, <a href="kiwi.tasklet.WaitForTasklet.html" data-type="Class" class="code">kiwi.tasklet.WaitForTasklet</a>, <a href="kiwi.tasklet.WaitForTimeout.html" data-type="Class" class="code">kiwi.tasklet.WaitForTimeout</a></div>
    <div><p>Abstract base class, do not call directly</p><table class="fieldTable"></table></div>
  </div>
</div><div class="basemethod">
  
  <a name="kiwi.tasklet.WaitCondition.arm">
    
  </a>
  <a name="arm">
    
  </a>
  <div class="functionHeader">
    
    def
    arm(self, tasklet):
    
  </div>
  <div class="docstring functionBody">
    <div class="interfaceinfo">overridden in <a href="kiwi.tasklet.WaitForCall.html" data-type="Class" class="code">kiwi.tasklet.WaitForCall</a>, <a href="kiwi.tasklet.WaitForIdle.html" data-type="Class" class="code">kiwi.tasklet.WaitForIdle</a>, <a href="kiwi.tasklet.WaitForIO.html" data-type="Class" class="code">kiwi.tasklet.WaitForIO</a>, <a href="kiwi.tasklet.WaitForMessages.html" data-type="Class" class="code">kiwi.tasklet.WaitForMessages</a>, <a href="kiwi.tasklet.WaitForProcess.html" data-type="Class" class="code">kiwi.tasklet.WaitForProcess</a>, <a href="kiwi.tasklet.WaitForSignal.html" data-type="Class" class="code">kiwi.tasklet.WaitForSignal</a>, <a href="kiwi.tasklet.WaitForTasklet.html" data-type="Class" class="code">kiwi.tasklet.WaitForTasklet</a>, <a href="kiwi.tasklet.WaitForTimeout.html" data-type="Class" class="code">kiwi.tasklet.WaitForTimeout</a></div>
    <div><p>Prepare the wait condition to receive events.</p>
<p>When a wait condition receives the event it is waiting for, it should 
call the method <a href="kiwi.tasklet.Tasklet.html#wait_condition_fired"><code>wait_condition_fired</code></a>
of the tasklet with the wait condition as argument.  The method returns 
True or False; if it returns True, it means the WaitCondition object must 
"rearm" itself (continue to monitor events), otherwise it should 
disarm.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">tasklet</td><td>the tasklet instance the wait condition is to be associated with.</td></tr><tr class="fieldStart"><td class="fieldName">Note</td><td colspan="2">this method normally should not be called directly by the programmer.</td></tr></table></div>
  </div>
</div><div class="basemethod">
  
  <a name="kiwi.tasklet.WaitCondition.disarm">
    
  </a>
  <a name="disarm">
    
  </a>
  <div class="functionHeader">
    
    def
    disarm(self):
    
  </div>
  <div class="docstring functionBody">
    <div class="interfaceinfo">overridden in <a href="kiwi.tasklet.WaitForCall.html" data-type="Class" class="code">kiwi.tasklet.WaitForCall</a>, <a href="kiwi.tasklet.WaitForIdle.html" data-type="Class" class="code">kiwi.tasklet.WaitForIdle</a>, <a href="kiwi.tasklet.WaitForIO.html" data-type="Class" class="code">kiwi.tasklet.WaitForIO</a>, <a href="kiwi.tasklet.WaitForMessages.html" data-type="Class" class="code">kiwi.tasklet.WaitForMessages</a>, <a href="kiwi.tasklet.WaitForProcess.html" data-type="Class" class="code">kiwi.tasklet.WaitForProcess</a>, <a href="kiwi.tasklet.WaitForSignal.html" data-type="Class" class="code">kiwi.tasklet.WaitForSignal</a>, <a href="kiwi.tasklet.WaitForTasklet.html" data-type="Class" class="code">kiwi.tasklet.WaitForTasklet</a>, <a href="kiwi.tasklet.WaitForTimeout.html" data-type="Class" class="code">kiwi.tasklet.WaitForTimeout</a></div>
    <div><p>Stop the wait condition from receiving events.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Note</td><td colspan="2">this method normally should not be called by the programmer.</td></tr></table></div>
  </div>
</div>

      </div>
      <address>
        <a href="index.html">API Documentation</a> for Kiwi, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> at 2015-12-15 11:23:22.
      </address>

    </div>

    <script type="text/javascript" src="pydoctor.js"></script>

  </body>
</html>

APT Browse - Built by Thomas Orozco.