git.maemo.org Git - urpo/blob - www/apidoc/html/class_urpo_job.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>Urpo: UrpoJob Class Reference</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
   8 </head>
   9 <body>
  10 <!-- Generated by Doxygen 1.6.3 -->
  11 <div class="navigation" id="top">
  12   <div class="tabs">
  13     <ul>
  14       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
  15       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  16       <li><a href="files.html"><span>Files</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="tabs">
  20     <ul>
  21       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  22       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  23       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  24     </ul>
  25   </div>
  26 </div>
  27 <div class="contents">
  28 <h1>UrpoJob Class Reference</h1><!-- doxytag: class="UrpoJob" -->
  29 <p>Base class for jobs (abstract).
  30 <a href="#_details">More...</a></p>
  31
  32 <p><code>#include &lt;<a class="el" href="urpojob_8h_source.html">urpojob.h</a>&gt;</code></p>
  33 <div class="dynheader">
  34 Inheritance diagram for UrpoJob:</div>
  35 <div class="dynsection">
  36  <div class="center">
  37   <img src="class_urpo_job.png" usemap="#UrpoJob_map" alt=""/>
  38   <map id="UrpoJob_map" name="UrpoJob_map">
  39 <area href="class_printer_list_job.html" alt="PrinterListJob" shape="rect" coords="0,56,90,80"/>
  40 <area href="class_print_job.html" alt="PrintJob" shape="rect" coords="100,56,190,80"/>
  41 </map>
  42  </div>
  43 </div>
  44
  45 <p><a href="class_urpo_job-members.html">List of all members.</a></p>
  46 <table border="0" cellpadding="0" cellspacing="0">
  47 <tr><td colspan="2"><h2>Public Types</h2></td></tr>
  48 <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>JobStatus</b> { <br/>
  49 &nbsp;&nbsp;<b>Ready</b>,
  50 <b>Running</b>,
  51 <b>Successed</b>,
  52 <b>Failed</b>,
  53 <br/>
  54 &nbsp;&nbsp;<b>Cancelled</b>
  55 <br/>
  56  }</td></tr>
  57 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4549ace1bc2331462d22281b8cbdf0f"></a><!-- doxytag: member="UrpoJob::start" ref="ae4549ace1bc2331462d22281b8cbdf0f" args="()" -->
  59 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#ae4549ace1bc2331462d22281b8cbdf0f">start</a> ()</td></tr>
  60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start job. <br/></td></tr>
  61 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a652109c42b7d8493a335d07ade7a0b0b"></a><!-- doxytag: member="UrpoJob::cancel" ref="a652109c42b7d8493a335d07ade7a0b0b" args="()" -->
  62 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a652109c42b7d8493a335d07ade7a0b0b">cancel</a> ()</td></tr>
  63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cancel job. <br/></td></tr>
  64 <tr><td colspan="2"><h2>Signals</h2></td></tr>
  65 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa1d96b9fac5621bd926289fe795ec371"></a><!-- doxytag: member="UrpoJob::debugMessage" ref="aa1d96b9fac5621bd926289fe795ec371" args="(QString message)" -->
  66 void&nbsp;</td><td class="memItemRight" valign="bottom"><b>debugMessage</b> (QString message)</td></tr>
  67 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#ab931a6a72a6f49c8919dcd695197288e">finished</a> (bool successed, QString errorStr=QString())</td></tr>
  68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Job finished (successed of failed).  <a href="#ab931a6a72a6f49c8919dcd695197288e"></a><br/></td></tr>
  69 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  70 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1baca70c87d4734d26da8b10bda0f80c"></a><!-- doxytag: member="UrpoJob::UrpoJob" ref="a1baca70c87d4734d26da8b10bda0f80c" args="(UrpoConnection *connection)" -->
  71 &nbsp;</td><td class="memItemRight" valign="bottom"><b>UrpoJob</b> (<a class="el" href="class_urpo_connection.html">UrpoConnection</a> *connection)</td></tr>
  72 <tr><td class="memItemLeft" align="right" valign="top">JobStatus&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#af07522b7d875bfc36a694f07d580fc8b">getStatus</a> () const </td></tr>
  73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Job status.  <a href="#af07522b7d875bfc36a694f07d580fc8b"></a><br/></td></tr>
  74 <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
  75 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08decf8e7432c1d627391a58aa7b790b"></a><!-- doxytag: member="UrpoJob::startJob" ref="a08decf8e7432c1d627391a58aa7b790b" args="()=0" -->
  76 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>startJob</b> ()=0</td></tr>
  77 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acec414a2b0d84c0bd29efa52d1e42481"></a><!-- doxytag: member="UrpoJob::cancelJob" ref="acec414a2b0d84c0bd29efa52d1e42481" args="()=0" -->
  78 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>cancelJob</b> ()=0</td></tr>
  79 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#adca3f19275978d0514229c26871e8a19">finish</a> (JobStatus status)</td></tr>
  80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish job.  <a href="#adca3f19275978d0514229c26871e8a19"></a><br/></td></tr>
  81 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a79d4688e55e26b373e103cb7238df9b6">fail</a> (QString errorString)</td></tr>
  82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finish failed job.  <a href="#a79d4688e55e26b373e103cb7238df9b6"></a><br/></td></tr>
  83 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c06ededd10c78ca736df20e1df1e269"></a><!-- doxytag: member="UrpoJob::getConnection" ref="a5c06ededd10c78ca736df20e1df1e269" args="()" -->
  84 <a class="el" href="class_urpo_connection.html">UrpoConnection</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a5c06ededd10c78ca736df20e1df1e269">getConnection</a> ()</td></tr>
  85 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get connection pointer. <br/></td></tr>
  86 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a6105276a7d9c7431aa5f24d374e33f84">sendDebugMessage</a> (QString message)</td></tr>
  87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send debug message.  <a href="#a6105276a7d9c7431aa5f24d374e33f84"></a><br/></td></tr>
  88 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab54ee3b2ba06bfc71c310c746a846c48"></a><!-- doxytag: member="UrpoJob::newProcess" ref="ab54ee3b2ba06bfc71c310c746a846c48" args="()" -->
  89 <a class="el" href="class_urpo_process.html">UrpoProcess</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#ab54ee3b2ba06bfc71c310c746a846c48">newProcess</a> ()</td></tr>
  90 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create new <a class="el" href="class_urpo_process.html" title="Process running ssh/scp command.">UrpoProcess</a>. <br/></td></tr>
  91 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89534d211decc6ab45de2b468045eef1"></a><!-- doxytag: member="UrpoJob::setStatus" ref="a89534d211decc6ab45de2b468045eef1" args="(JobStatus status)" -->
  92 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_job.html#a89534d211decc6ab45de2b468045eef1">setStatus</a> (JobStatus status)</td></tr>
  93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set job status. <br/></td></tr>
  94 </table>
  95 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  96 <p>Base class for jobs (abstract). </p>
  97 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
  98 <dl class="version"><dt><b>Version:</b></dt><dd>0 </dd></dl>
  99 <dl class="date"><dt><b>Date:</b></dt><dd>2010-06-11 </dd></dl>
 100
 101 <p>Definition at line <a class="el" href="urpojob_8h_source.html#l00040">40</a> of file <a class="el" href="urpojob_8h_source.html">urpojob.h</a>.</p>
 102 <hr/><h2>Member Function Documentation</h2>
 103 <a class="anchor" id="a79d4688e55e26b373e103cb7238df9b6"></a><!-- doxytag: member="UrpoJob::fail" ref="a79d4688e55e26b373e103cb7238df9b6" args="(QString errorString)" -->
 104 <div class="memitem">
 105 <div class="memproto">
 106       <table class="memname">
 107         <tr>
 108           <td class="memname">void UrpoJob::fail </td>
 109           <td>(</td>
 110           <td class="paramtype">QString&nbsp;</td>
 111           <td class="paramname"> <em>errorString</em></td>
 112           <td>&nbsp;)&nbsp;</td>
 113           <td><code> [protected]</code></td>
 114         </tr>
 115       </table>
 116 </div>
 117 <div class="memdoc">
 118
 119 <p>Finish failed job. </p>
 120 <p>emit <a class="el" href="class_urpo_job.html#ab931a6a72a6f49c8919dcd695197288e" title="Job finished (successed of failed).">finished()</a> with error status and message </p>
 121
 122 <p>Definition at line <a class="el" href="urpojob_8cpp_source.html#l00061">61</a> of file <a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</a>.</p>
 123
 124 </div>
 125 </div>
 126 <a class="anchor" id="adca3f19275978d0514229c26871e8a19"></a><!-- doxytag: member="UrpoJob::finish" ref="adca3f19275978d0514229c26871e8a19" args="(JobStatus status)" -->
 127 <div class="memitem">
 128 <div class="memproto">
 129       <table class="memname">
 130         <tr>
 131           <td class="memname">void UrpoJob::finish </td>
 132           <td>(</td>
 133           <td class="paramtype">JobStatus&nbsp;</td>
 134           <td class="paramname"> <em>status</em></td>
 135           <td>&nbsp;)&nbsp;</td>
 136           <td><code> [protected]</code></td>
 137         </tr>
 138       </table>
 139 </div>
 140 <div class="memdoc">
 141
 142 <p>Finish job. </p>
 143 <ul>
 144 <li>status Job status (Successed, Failed, Cancelled) </li>
 145 </ul>
 146
 147 <p>Definition at line <a class="el" href="urpojob_8cpp_source.html#l00052">52</a> of file <a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</a>.</p>
 148
 149 </div>
 150 </div>
 151 <a class="anchor" id="ab931a6a72a6f49c8919dcd695197288e"></a><!-- doxytag: member="UrpoJob::finished" ref="ab931a6a72a6f49c8919dcd695197288e" args="(bool successed, QString errorStr=QString())" -->
 152 <div class="memitem">
 153 <div class="memproto">
 154       <table class="memname">
 155         <tr>
 156           <td class="memname">void UrpoJob::finished </td>
 157           <td>(</td>
 158           <td class="paramtype">bool&nbsp;</td>
 159           <td class="paramname"> <em>successed</em>, </td>
 160         </tr>
 161         <tr>
 162           <td class="paramkey"></td>
 163           <td></td>
 164           <td class="paramtype">QString&nbsp;</td>
 165           <td class="paramname"> <em>errorStr</em> = <code>QString()</code></td><td>&nbsp;</td>
 166         </tr>
 167         <tr>
 168           <td></td>
 169           <td>)</td>
 170           <td></td><td></td><td><code> [signal]</code></td>
 171         </tr>
 172       </table>
 173 </div>
 174 <div class="memdoc">
 175
 176 <p>Job finished (successed of failed). </p>
 177 <dl><dt><b>Parameters:</b></dt><dd>
 178   <table border="0" cellspacing="2" cellpadding="0">
 179     <tr><td valign="top"></td><td valign="top"><em>successed</em>&nbsp;</td><td>True if job successed, false if failed </td></tr>
 180   </table>
 181   </dd>
 182 </dl>
 183
 184 </div>
 185 </div>
 186 <a class="anchor" id="af07522b7d875bfc36a694f07d580fc8b"></a><!-- doxytag: member="UrpoJob::getStatus" ref="af07522b7d875bfc36a694f07d580fc8b" args="() const " -->
 187 <div class="memitem">
 188 <div class="memproto">
 189       <table class="memname">
 190         <tr>
 191           <td class="memname">JobStatus UrpoJob::getStatus </td>
 192           <td>(</td>
 193           <td class="paramname"></td>
 194           <td>&nbsp;)&nbsp;</td>
 195           <td> const<code> [inline]</code></td>
 196         </tr>
 197       </table>
 198 </div>
 199 <div class="memdoc">
 200
 201 <p>Job status. </p>
 202 <dl class="return"><dt><b>Returns:</b></dt><dd>Job status (Ready, Running, Successed, Failed </dd></dl>
 203
 204 <p>Definition at line <a class="el" href="urpojob_8h_source.html#l00059">59</a> of file <a class="el" href="urpojob_8h_source.html">urpojob.h</a>.</p>
 205
 206 </div>
 207 </div>
 208 <a class="anchor" id="a6105276a7d9c7431aa5f24d374e33f84"></a><!-- doxytag: member="UrpoJob::sendDebugMessage" ref="a6105276a7d9c7431aa5f24d374e33f84" args="(QString message)" -->
 209 <div class="memitem">
 210 <div class="memproto">
 211       <table class="memname">
 212         <tr>
 213           <td class="memname">void UrpoJob::sendDebugMessage </td>
 214           <td>(</td>
 215           <td class="paramtype">QString&nbsp;</td>
 216           <td class="paramname"> <em>message</em></td>
 217           <td>&nbsp;)&nbsp;</td>
 218           <td><code> [protected]</code></td>
 219         </tr>
 220       </table>
 221 </div>
 222 <div class="memdoc">
 223
 224 <p>Send debug message. </p>
 225 <dl><dt><b>Parameters:</b></dt><dd>
 226   <table border="0" cellspacing="2" cellpadding="0">
 227     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>Message to debug monitor</td></tr>
 228   </table>
 229   </dd>
 230 </dl>
 231 <p>If debug monitor has been connected, send message to debug monitor </p>
 232
 233 <p>Definition at line <a class="el" href="urpojob_8cpp_source.html#l00039">39</a> of file <a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</a>.</p>
 234
 235 </div>
 236 </div>
 237 <hr/>The documentation for this class was generated from the following files:<ul>
 238 <li>src/<a class="el" href="urpojob_8h_source.html">urpojob.h</a></li>
 239 <li>src/<a class="el" href="urpojob_8cpp_source.html">urpojob.cpp</a></li>
 240 </ul>
 241 </div>
 242 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Sep 27 18:46:05 2010 for Urpo by&nbsp;
 243 <a href="http://www.doxygen.org/index.html">
 244 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 245 </body>
 246 </html>