vcs.maemo.org Git - urpo/blob - www/apidoc/html/class_urpo_process.html

   1 <!-- This comment will put IE 6, 7 and 8 in quirks mode -->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <title>Urpo: UrpoProcess Class Reference</title>
   7 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   8 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javaScript" src="search/search.js"></script>
  10 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  11 </head>
  12 <body onload='searchBox.OnSelectItem(0);'>
  13 <!-- Generated by Doxygen 1.6.3 -->
  14 <script type="text/javascript"><!--
  15 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  16 --></script>
  17 <div class="navigation" id="top">
  18   <div class="tabs">
  19     <ul>
  20       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  21       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li>
  24         <div id="MSearchBox" class="MSearchBoxInactive">
  25         <img id="MSearchSelect" src="search/search.png"
  26              onmouseover="return searchBox.OnSearchSelectShow()"
  27              onmouseout="return searchBox.OnSearchSelectHide()"
  28              alt=""/>
  29         <input type="text" id="MSearchField" value="Search" accesskey="S"
  30              onfocus="searchBox.OnSearchFieldFocus(true)"
  31              onblur="searchBox.OnSearchFieldFocus(false)"
  32              onkeyup="searchBox.OnSearchFieldChange(event)"/>
  33         <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  34         </div>
  35       </li>
  36     </ul>
  37   </div>
  38   <div class="tabs">
  39     <ul>
  40       <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  41       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  42       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  43     </ul>
  44   </div>
  45 </div>
  46 <div class="contents">
  47 <h1>UrpoProcess Class Reference</h1><!-- doxytag: class="UrpoProcess" -->
  48 <p>Process running ssh/scp command.
  49 <a href="#_details">More...</a></p>
  50
  51 <p><code>#include &lt;<a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>&gt;</code></p>
  52
  53 <p><a href="class_urpo_process-members.html">List of all members.</a></p>
  54 <table border="0" cellpadding="0" cellspacing="0">
  55 <tr><td colspan="2"><h2>Public Types</h2></td></tr>
  56 <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2">UrpoStatus</a> { <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2ac5894b205772be5c5d2cab467dc4c90d">Ready</a> =  0,
  57 <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d">Running</a> =  1,
  58 <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2acaff40cc10b23085fd28e0b757de08b9">Successed</a> =  2,
  59 <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a5e0b84210eb20245a9f3a925297088e2">Failed</a> =  3
  60  }</td></tr>
  61 <tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9">UrpoError</a> { <br/>
  62 &nbsp;&nbsp;<a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f">NoError</a> =  0,
  63 <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6">ProcessError</a> =  1,
  64 <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa">ConnectionError</a> =  2,
  65 <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a2de1e6756c01a0fe2f56e3f324f7845f">AuthError</a> =  3,
  66 <br/>
  67 &nbsp;&nbsp;<a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce">Timeout</a> =  4,
  68 <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff">Cancelled</a> =  5
  69 <br/>
  70  }</td></tr>
  71 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
  72 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#ac4381636ee9e977dfac4d8fe53ddfeaa">terminate</a> ()</td></tr>
  73 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cancel process.  <a href="#ac4381636ee9e977dfac4d8fe53ddfeaa"></a><br/></td></tr>
  74 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba6e812efd10c7b466563c171baf7284"></a><!-- doxytag: member="UrpoProcess::processFinished" ref="aba6e812efd10c7b466563c171baf7284" args="(int exitCode, QProcess::ExitStatus exitStatus)" -->
  75 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#aba6e812efd10c7b466563c171baf7284">processFinished</a> (int exitCode, QProcess::ExitStatus exitStatus)</td></tr>
  76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">SSH client has finished. <br/></td></tr>
  77 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8865ef6fcb92b3fa9228474654065da"></a><!-- doxytag: member="UrpoProcess::timeout" ref="ab8865ef6fcb92b3fa9228474654065da" args="()" -->
  78 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#ab8865ef6fcb92b3fa9228474654065da">timeout</a> ()</td></tr>
  79 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Timeout during connecting. <br/></td></tr>
  80 <tr><td colspan="2"><h2>Signals</h2></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_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad">finished</a> (bool success)</td></tr>
  82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process finished (successed of failed).  <a href="#ab1c5d2e4c2bda8d34700b478fd5af1ad"></a><br/></td></tr>
  83 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#adc31070a303b210a9244213fda1f9939">debugMessage</a> (QString message)</td></tr>
  84 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  85 <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#ace05eb4301a27d8c20edfc85d28ebdcf">UrpoProcess</a> (QObject *parent=0)</td></tr>
  86 <tr><td class="memItemLeft" align="right" valign="top">QStringList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#af1d8cbb3465d62ab7541aac2fef7f963">getOutput</a> ()</td></tr>
  87 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get output of command.  <a href="#af1d8cbb3465d62ab7541aac2fef7f963"></a><br/></td></tr>
  88 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#a1bf2519b81fe6d5074db04f9acd38cb0">start</a> (const QString &amp;command)</td></tr>
  89 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Run command.  <a href="#a1bf2519b81fe6d5074db04f9acd38cb0"></a><br/></td></tr>
  90 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9">UrpoError</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#af71059723175a0ee9324a9794eff4cb1">getError</a> () const </td></tr>
  91 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error of process.  <a href="#af71059723175a0ee9324a9794eff4cb1"></a><br/></td></tr>
  92 <tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#a5a400d2abb550076c778a6030293e764">getErrorString</a> () const </td></tr>
  93 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error of process (in string).  <a href="#a5a400d2abb550076c778a6030293e764"></a><br/></td></tr>
  94 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2">UrpoStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#a81ca2705b2b20d46a26f19d4a413cbdb">getStatus</a> () const </td></tr>
  95 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process status.  <a href="#a81ca2705b2b20d46a26f19d4a413cbdb"></a><br/></td></tr>
  96 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#a0d75a2951e7add2e70c02cd8bf56de3e">sendDebugMessage</a> (QString message)</td></tr>
  97 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send debug message.  <a href="#a0d75a2951e7add2e70c02cd8bf56de3e"></a><br/></td></tr>
  98 <tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#af3cd19eb0af2b51d6740471a344cbb69">setTimeout</a> (int msecs)</td></tr>
  99 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set timeout.  <a href="#af3cd19eb0af2b51d6740471a344cbb69"></a><br/></td></tr>
 100 <tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#aaa8de6c9a6635cf2433958a60e4cf87f">getTimeout</a> ()</td></tr>
 101 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return timeout.  <a href="#aaa8de6c9a6635cf2433958a60e4cf87f"></a><br/></td></tr>
 102 </table>
 103 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 104 <p>Process running ssh/scp command. </p>
 105 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
 106 <dl class="version"><dt><b>Version:</b></dt><dd>0 </dd></dl>
 107 <dl class="date"><dt><b>Date:</b></dt><dd>2010-06-11 - 2010-06-12</dd></dl>
 108 <p>Run ssh/scp etc. command.</p>
 109 <p>Read setting using UrpoConnect settings information object. Support debug monitoring using debugMessage-signals, monitor defined in settings object</p>
 110 <p>First, connect <a class="el" href="class_urpo_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad" title="Process finished (successed of failed).">finished()</a>-signal. Then, run command. Command is run asynchronosly.</p>
 111 <div class="fragment"><pre class="fragment">  ...
 112   <span class="comment">// Get list of available printers</span>
 113
 114     QString command = <span class="stringliteral">&quot;ssh &quot;</span>;
 115     command.append(getConnection()-&gt;getKeyOption());
 116     command.append(getConnection()-&gt;getHostString());
 117     command.append(<span class="stringliteral">&quot; env LANG=en lpstat -p&quot;</span>);
 118
 119     process = <span class="keyword">new</span> <a class="code" href="class_urpo_process.html#ace05eb4301a27d8c20edfc85d28ebdcf">UrpoProcess</a>( connect );
 120
 121   connect( process, SIGNAL(<a class="code" href="class_urpo_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad" title="Process finished (successed of failed).">finished</a>(<span class="keywordtype">bool</span>)), <span class="keyword">this</span>, SLOT( readOutput(<span class="keywordtype">bool</span>) ) );
 122   process.start(command);
 123
 124   ...
 125   ::readOutput(<span class="keywordtype">bool</span> success)
 126   {
 127     <span class="keywordflow">if</span>( success )
 128     {
 129         <span class="keywordflow">foreach</span>(QString line, process-&gt;getOutput() )
 130         cout &lt;&lt; line &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>;
 131     }
 132     <span class="keywordflow">else</span>
 133         cout &lt;&lt; <span class="stringliteral">&quot;Error &quot;</span> &lt;&lt; process-&gt;getError();
 134   }
 135 </pre></div><dl class="see"><dt><b>See also:</b></dt><dd>UrpoConnect </dd></dl>
 136
 137 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00075">75</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
 138 <hr/><h2>Member Enumeration Documentation</h2>
 139 <a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9"></a><!-- doxytag: member="UrpoProcess::UrpoError" ref="a5b17cbee3ba24de244bd011aabac21c9" args="" -->
 140 <div class="memitem">
 141 <div class="memproto">
 142       <table class="memname">
 143         <tr>
 144           <td class="memname">enum <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9">UrpoProcess::UrpoError</a></td>
 145         </tr>
 146       </table>
 147 </div>
 148 <div class="memdoc">
 149 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
 150 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f"></a><!-- doxytag: member="NoError" ref="a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f" args="" -->NoError</em>&nbsp;</td><td>
 151 <p>No errors happends. </p>
 152 </td></tr>
 153 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6"></a><!-- doxytag: member="ProcessError" ref="a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6" args="" -->ProcessError</em>&nbsp;</td><td>
 154 <p>Error running process. </p>
 155 </td></tr>
 156 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa"></a><!-- doxytag: member="ConnectionError" ref="a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa" args="" -->ConnectionError</em>&nbsp;</td><td>
 157 <p>Error connecting host. </p>
 158 </td></tr>
 159 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a2de1e6756c01a0fe2f56e3f324f7845f"></a><!-- doxytag: member="AuthError" ref="a5b17cbee3ba24de244bd011aabac21c9a2de1e6756c01a0fe2f56e3f324f7845f" args="" -->AuthError</em>&nbsp;</td><td>
 160 <p>Authentication failed. </p>
 161 </td></tr>
 162 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce"></a><!-- doxytag: member="Timeout" ref="a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce" args="" -->Timeout</em>&nbsp;</td><td>
 163 <p>Timed out. </p>
 164 </td></tr>
 165 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff"></a><!-- doxytag: member="Cancelled" ref="a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff" args="" -->Cancelled</em>&nbsp;</td><td>
 166 <p>User cancelled operation. </p>
 167 </td></tr>
 168 </table>
 169 </dd>
 170 </dl>
 171
 172 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00092">92</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
 173
 174 </div>
 175 </div>
 176 <a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2"></a><!-- doxytag: member="UrpoProcess::UrpoStatus" ref="a1be26b6dc5a227f88d8fa7be477578a2" args="" -->
 177 <div class="memitem">
 178 <div class="memproto">
 179       <table class="memname">
 180         <tr>
 181           <td class="memname">enum <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2">UrpoProcess::UrpoStatus</a></td>
 182         </tr>
 183       </table>
 184 </div>
 185 <div class="memdoc">
 186 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
 187 <tr><td valign="top"><em><a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2ac5894b205772be5c5d2cab467dc4c90d"></a><!-- doxytag: member="Ready" ref="a1be26b6dc5a227f88d8fa7be477578a2ac5894b205772be5c5d2cab467dc4c90d" args="" -->Ready</em>&nbsp;</td><td>
 188 <p>Ready for connecting. </p>
 189 </td></tr>
 190 <tr><td valign="top"><em><a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d"></a><!-- doxytag: member="Running" ref="a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d" args="" -->Running</em>&nbsp;</td><td>
 191 <p>Command running. </p>
 192 </td></tr>
 193 <tr><td valign="top"><em><a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2acaff40cc10b23085fd28e0b757de08b9"></a><!-- doxytag: member="Successed" ref="a1be26b6dc5a227f88d8fa7be477578a2acaff40cc10b23085fd28e0b757de08b9" args="" -->Successed</em>&nbsp;</td><td>
 194 <p>Command successed. </p>
 195 </td></tr>
 196 <tr><td valign="top"><em><a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2a5e0b84210eb20245a9f3a925297088e2"></a><!-- doxytag: member="Failed" ref="a1be26b6dc5a227f88d8fa7be477578a2a5e0b84210eb20245a9f3a925297088e2" args="" -->Failed</em>&nbsp;</td><td>
 197 <p>Command failed. </p>
 198 </td></tr>
 199 </table>
 200 </dd>
 201 </dl>
 202
 203 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00085">85</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
 204
 205 </div>
 206 </div>
 207 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
 208 <a class="anchor" id="ace05eb4301a27d8c20edfc85d28ebdcf"></a><!-- doxytag: member="UrpoProcess::UrpoProcess" ref="ace05eb4301a27d8c20edfc85d28ebdcf" args="(QObject *parent=0)" -->
 209 <div class="memitem">
 210 <div class="memproto">
 211       <table class="memname">
 212         <tr>
 213           <td class="memname">UrpoProcess::UrpoProcess </td>
 214           <td>(</td>
 215           <td class="paramtype">QObject *&nbsp;</td>
 216           <td class="paramname"> <em>parent</em> = <code>0</code></td>
 217           <td>&nbsp;)&nbsp;</td>
 218           <td><code> [explicit]</code></td>
 219         </tr>
 220       </table>
 221 </div>
 222 <div class="memdoc">
 223 <dl><dt><b>Parameters:</b></dt><dd>
 224   <table border="0" cellspacing="2" cellpadding="0">
 225     <tr><td valign="top"></td><td valign="top"><em>connection</em>&nbsp;</td><td>Pointer to connection settings information </td></tr>
 226   </table>
 227   </dd>
 228 </dl>
 229
 230 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00030">30</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
 231
 232 </div>
 233 </div>
 234 <hr/><h2>Member Function Documentation</h2>
 235 <a class="anchor" id="adc31070a303b210a9244213fda1f9939"></a><!-- doxytag: member="UrpoProcess::debugMessage" ref="adc31070a303b210a9244213fda1f9939" args="(QString message)" -->
 236 <div class="memitem">
 237 <div class="memproto">
 238       <table class="memname">
 239         <tr>
 240           <td class="memname">void UrpoProcess::debugMessage </td>
 241           <td>(</td>
 242           <td class="paramtype">QString&nbsp;</td>
 243           <td class="paramname"> <em>message</em></td>
 244           <td>&nbsp;)&nbsp;</td>
 245           <td><code> [signal]</code></td>
 246         </tr>
 247       </table>
 248 </div>
 249 <div class="memdoc">
 250 <p>Send debug messages</p>
 251 <p><a class="el" href="class_urpo_connection.html" title="Information about ssh connection (abstract).">UrpoConnection</a> can set up a debug monitor, a QObject receiving debugMsg signals. Debug messages contains information about process output, errors etc.</p>
 252 <dl><dt><b>Parameters:</b></dt><dd>
 253   <table border="0" cellspacing="2" cellpadding="0">
 254     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>Message send to debug monitor </td></tr>
 255   </table>
 256   </dd>
 257 </dl>
 258
 259 </div>
 260 </div>
 261 <a class="anchor" id="ab1c5d2e4c2bda8d34700b478fd5af1ad"></a><!-- doxytag: member="UrpoProcess::finished" ref="ab1c5d2e4c2bda8d34700b478fd5af1ad" args="(bool success)" -->
 262 <div class="memitem">
 263 <div class="memproto">
 264       <table class="memname">
 265         <tr>
 266           <td class="memname">void UrpoProcess::finished </td>
 267           <td>(</td>
 268           <td class="paramtype">bool&nbsp;</td>
 269           <td class="paramname"> <em>success</em></td>
 270           <td>&nbsp;)&nbsp;</td>
 271           <td><code> [signal]</code></td>
 272         </tr>
 273       </table>
 274 </div>
 275 <div class="memdoc">
 276
 277 <p>Process finished (successed of failed). </p>
 278 <dl><dt><b>Parameters:</b></dt><dd>
 279   <table border="0" cellspacing="2" cellpadding="0">
 280     <tr><td valign="top"></td><td valign="top"><em>success</em>&nbsp;</td><td>True if process successed, false if failed</td></tr>
 281   </table>
 282   </dd>
 283 </dl>
 284 <p>Emitted when process finished. Output of process can be reader throught <a class="el" href="class_urpo_process.html#af1d8cbb3465d62ab7541aac2fef7f963" title="Get output of command.">getOutput()</a> </p>
 285
 286 </div>
 287 </div>
 288 <a class="anchor" id="af71059723175a0ee9324a9794eff4cb1"></a><!-- doxytag: member="UrpoProcess::getError" ref="af71059723175a0ee9324a9794eff4cb1" args="() const " -->
 289 <div class="memitem">
 290 <div class="memproto">
 291       <table class="memname">
 292         <tr>
 293           <td class="memname"><a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9">UrpoError</a> UrpoProcess::getError </td>
 294           <td>(</td>
 295           <td class="paramname"></td>
 296           <td>&nbsp;)&nbsp;</td>
 297           <td> const<code> [inline]</code></td>
 298         </tr>
 299       </table>
 300 </div>
 301 <div class="memdoc">
 302
 303 <p>Error of process. </p>
 304 <p>If process failed, get error code </p>
 305 <dl class="return"><dt><b>Returns:</b></dt><dd>Error code </dd></dl>
 306
 307 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00120">120</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
 308
 309 </div>
 310 </div>
 311 <a class="anchor" id="a5a400d2abb550076c778a6030293e764"></a><!-- doxytag: member="UrpoProcess::getErrorString" ref="a5a400d2abb550076c778a6030293e764" args="() const " -->
 312 <div class="memitem">
 313 <div class="memproto">
 314       <table class="memname">
 315         <tr>
 316           <td class="memname">QString UrpoProcess::getErrorString </td>
 317           <td>(</td>
 318           <td class="paramname"></td>
 319           <td>&nbsp;)&nbsp;</td>
 320           <td> const</td>
 321         </tr>
 322       </table>
 323 </div>
 324 <div class="memdoc">
 325
 326 <p>Error of process (in string). </p>
 327 <p>If process failed, return error string readable by user</p>
 328 <dl class="return"><dt><b>Returns:</b></dt><dd>Error string </dd></dl>
 329
 330 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00110">110</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
 331
 332 </div>
 333 </div>
 334 <a class="anchor" id="af1d8cbb3465d62ab7541aac2fef7f963"></a><!-- doxytag: member="UrpoProcess::getOutput" ref="af1d8cbb3465d62ab7541aac2fef7f963" args="()" -->
 335 <div class="memitem">
 336 <div class="memproto">
 337       <table class="memname">
 338         <tr>
 339           <td class="memname">QStringList UrpoProcess::getOutput </td>
 340           <td>(</td>
 341           <td class="paramname"></td>
 342           <td>&nbsp;)&nbsp;</td>
 343           <td></td>
 344         </tr>
 345       </table>
 346 </div>
 347 <div class="memdoc">
 348
 349 <p>Get output of command. </p>
 350 <dl class="return"><dt><b>Returns:</b></dt><dd>Output of command, list of QStrings </dd></dl>
 351
 352 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00043">43</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
 353
 354 </div>
 355 </div>
 356 <a class="anchor" id="a81ca2705b2b20d46a26f19d4a413cbdb"></a><!-- doxytag: member="UrpoProcess::getStatus" ref="a81ca2705b2b20d46a26f19d4a413cbdb" args="() const " -->
 357 <div class="memitem">
 358 <div class="memproto">
 359       <table class="memname">
 360         <tr>
 361           <td class="memname"><a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2">UrpoStatus</a> UrpoProcess::getStatus </td>
 362           <td>(</td>
 363           <td class="paramname"></td>
 364           <td>&nbsp;)&nbsp;</td>
 365           <td> const<code> [inline]</code></td>
 366         </tr>
 367       </table>
 368 </div>
 369 <div class="memdoc">
 370
 371 <p>Process status. </p>
 372 <dl class="return"><dt><b>Returns:</b></dt><dd>Status (Ready, Running, Successed, Failed) </dd></dl>
 373
 374 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00134">134</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
 375
 376 </div>
 377 </div>
 378 <a class="anchor" id="aaa8de6c9a6635cf2433958a60e4cf87f"></a><!-- doxytag: member="UrpoProcess::getTimeout" ref="aaa8de6c9a6635cf2433958a60e4cf87f" args="()" -->
 379 <div class="memitem">
 380 <div class="memproto">
 381       <table class="memname">
 382         <tr>
 383           <td class="memname">int UrpoProcess::getTimeout </td>
 384           <td>(</td>
 385           <td class="paramname"></td>
 386           <td>&nbsp;)&nbsp;</td>
 387           <td><code> [inline]</code></td>
 388         </tr>
 389       </table>
 390 </div>
 391 <div class="memdoc">
 392
 393 <p>Return timeout. </p>
 394 <dl class="return"><dt><b>Returns:</b></dt><dd>Timeout in msecs </dd></dl>
 395
 396 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00158">158</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
 397
 398 </div>
 399 </div>
 400 <a class="anchor" id="a0d75a2951e7add2e70c02cd8bf56de3e"></a><!-- doxytag: member="UrpoProcess::sendDebugMessage" ref="a0d75a2951e7add2e70c02cd8bf56de3e" args="(QString message)" -->
 401 <div class="memitem">
 402 <div class="memproto">
 403       <table class="memname">
 404         <tr>
 405           <td class="memname">void UrpoProcess::sendDebugMessage </td>
 406           <td>(</td>
 407           <td class="paramtype">QString&nbsp;</td>
 408           <td class="paramname"> <em>message</em></td>
 409           <td>&nbsp;)&nbsp;</td>
 410           <td><code> [inline]</code></td>
 411         </tr>
 412       </table>
 413 </div>
 414 <div class="memdoc">
 415
 416 <p>Send debug message. </p>
 417 <dl><dt><b>Parameters:</b></dt><dd>
 418   <table border="0" cellspacing="2" cellpadding="0">
 419     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>Message to debug monitor</td></tr>
 420   </table>
 421   </dd>
 422 </dl>
 423 <p>If debug monitor has been connected, send message to debug monitor </p>
 424
 425 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00144">144</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
 426
 427 </div>
 428 </div>
 429 <a class="anchor" id="af3cd19eb0af2b51d6740471a344cbb69"></a><!-- doxytag: member="UrpoProcess::setTimeout" ref="af3cd19eb0af2b51d6740471a344cbb69" args="(int msecs)" -->
 430 <div class="memitem">
 431 <div class="memproto">
 432       <table class="memname">
 433         <tr>
 434           <td class="memname">void UrpoProcess::setTimeout </td>
 435           <td>(</td>
 436           <td class="paramtype">int&nbsp;</td>
 437           <td class="paramname"> <em>msecs</em></td>
 438           <td>&nbsp;)&nbsp;</td>
 439           <td><code> [inline]</code></td>
 440         </tr>
 441       </table>
 442 </div>
 443 <div class="memdoc">
 444
 445 <p>Set timeout. </p>
 446 <p>Process time out, if running command last more than timeout</p>
 447 <dl><dt><b>Parameters:</b></dt><dd>
 448   <table border="0" cellspacing="2" cellpadding="0">
 449     <tr><td valign="top"></td><td valign="top"><em>msecs</em>&nbsp;</td><td>Timeout in msecs </td></tr>
 450   </table>
 451   </dd>
 452 </dl>
 453
 454 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00153">153</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
 455
 456 </div>
 457 </div>
 458 <a class="anchor" id="a1bf2519b81fe6d5074db04f9acd38cb0"></a><!-- doxytag: member="UrpoProcess::start" ref="a1bf2519b81fe6d5074db04f9acd38cb0" args="(const QString &amp;command)" -->
 459 <div class="memitem">
 460 <div class="memproto">
 461       <table class="memname">
 462         <tr>
 463           <td class="memname">void UrpoProcess::start </td>
 464           <td>(</td>
 465           <td class="paramtype">const QString &amp;&nbsp;</td>
 466           <td class="paramname"> <em>command</em></td>
 467           <td>&nbsp;)&nbsp;</td>
 468           <td></td>
 469         </tr>
 470       </table>
 471 </div>
 472 <div class="memdoc">
 473
 474 <p>Run command. </p>
 475 <p>Start process running command. When process finish (successed/failed), <a class="el" href="class_urpo_process.html#ab1c5d2e4c2bda8d34700b478fd5af1ad" title="Process finished (successed of failed).">finished()</a> signal will be emitted</p>
 476 <dl><dt><b>Parameters:</b></dt><dd>
 477   <table border="0" cellspacing="2" cellpadding="0">
 478     <tr><td valign="top"></td><td valign="top"><em>command</em>&nbsp;</td><td>Command to execute </td></tr>
 479   </table>
 480   </dd>
 481 </dl>
 482
 483 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00065">65</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
 484
 485 </div>
 486 </div>
 487 <a class="anchor" id="ac4381636ee9e977dfac4d8fe53ddfeaa"></a><!-- doxytag: member="UrpoProcess::terminate" ref="ac4381636ee9e977dfac4d8fe53ddfeaa" args="()" -->
 488 <div class="memitem">
 489 <div class="memproto">
 490       <table class="memname">
 491         <tr>
 492           <td class="memname">void UrpoProcess::terminate </td>
 493           <td>(</td>
 494           <td class="paramname"></td>
 495           <td>&nbsp;)&nbsp;</td>
 496           <td><code> [slot]</code></td>
 497         </tr>
 498       </table>
 499 </div>
 500 <div class="memdoc">
 501
 502 <p>Cancel process. </p>
 503 <p>Terminate process. Emit finished(false) signal and set Cancelled error </p>
 504
 505 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00038">38</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
 506
 507 </div>
 508 </div>
 509 <hr/>The documentation for this class was generated from the following files:<ul>
 510 <li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a></li>
 511 <li>/holvi/arto/ohjelmointi/urpo-0.0/urpo/<a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a></li>
 512 </ul>
 513 </div>
 514 <!--- window showing the filter options -->
 515 <div id="MSearchSelectWindow"
 516      onmouseover="return searchBox.OnSearchSelectShow()"
 517      onmouseout="return searchBox.OnSearchSelectHide()"
 518      onkeydown="return searchBox.OnSearchSelectKey(event)">
 519 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Enumerator</a></div>
 520
 521 <!-- iframe showing the search results (closed by default) -->
 522 <div id="MSearchResultsWindow">
 523 <iframe src="" frameborder="0"
 524         name="MSearchResults" id="MSearchResults">
 525 </iframe>
 526 </div>
 527
 528 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jun 21 21:38:16 2010 for Urpo by&nbsp;
 529 <a href="http://www.doxygen.org/index.html">
 530 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 531 </body>
 532 </html>