415ad700b52c02ec88c173f1c14a8b88554f352a
[urpo] / www / apidoc / html / class_urpo_process.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: UrpoProcess 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>UrpoProcess Class Reference</h1><!-- doxytag: class="UrpoProcess" -->
29 <p>Process running ssh/scp command.  
30 <a href="#_details">More...</a></p>
31
32 <p><code>#include &lt;<a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>&gt;</code></p>
33
34 <p><a href="class_urpo_process-members.html">List of all members.</a></p>
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><td colspan="2"><h2>Public Types</h2></td></tr>
37 <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, 
38 <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d">Running</a> =  1, 
39 <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2acaff40cc10b23085fd28e0b757de08b9">Successed</a> =  2, 
40 <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2a5e0b84210eb20245a9f3a925297088e2">Failed</a> =  3
41  }</td></tr>
42 <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/>
43 &nbsp;&nbsp;<a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f">NoError</a> =  0, 
44 <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6">ProcessError</a> =  1, 
45 <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa">ConnectionError</a> =  2, 
46 <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a2de1e6756c01a0fe2f56e3f324f7845f">AuthError</a> =  3, 
47 <br/>
48 &nbsp;&nbsp;<a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce">Timeout</a> =  4, 
49 <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff">Cancelled</a> =  5
50 <br/>
51  }</td></tr>
52 <tr><td colspan="2"><h2>Public Slots</h2></td></tr>
53 <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>
54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cancel process.  <a href="#ac4381636ee9e977dfac4d8fe53ddfeaa"></a><br/></td></tr>
55 <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)" -->
56 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>
57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">SSH client has finished. <br/></td></tr>
58 <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab8865ef6fcb92b3fa9228474654065da"></a><!-- doxytag: member="UrpoProcess::timeout" ref="ab8865ef6fcb92b3fa9228474654065da" args="()" -->
59 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_process.html#ab8865ef6fcb92b3fa9228474654065da">timeout</a> ()</td></tr>
60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Timeout during connecting. <br/></td></tr>
61 <tr><td colspan="2"><h2>Signals</h2></td></tr>
62 <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>
63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process finished (successed of failed).  <a href="#ab1c5d2e4c2bda8d34700b478fd5af1ad"></a><br/></td></tr>
64 <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>
65 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
66 <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>
67 <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>
68 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get output of command.  <a href="#af1d8cbb3465d62ab7541aac2fef7f963"></a><br/></td></tr>
69 <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>
70 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Run command.  <a href="#a1bf2519b81fe6d5074db04f9acd38cb0"></a><br/></td></tr>
71 <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>
72 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error of process.  <a href="#af71059723175a0ee9324a9794eff4cb1"></a><br/></td></tr>
73 <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>
74 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Error of process (in string).  <a href="#a5a400d2abb550076c778a6030293e764"></a><br/></td></tr>
75 <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>
76 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Process status.  <a href="#a81ca2705b2b20d46a26f19d4a413cbdb"></a><br/></td></tr>
77 <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>
78 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send debug message.  <a href="#a0d75a2951e7add2e70c02cd8bf56de3e"></a><br/></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_process.html#af3cd19eb0af2b51d6740471a344cbb69">setTimeout</a> (int msecs)</td></tr>
80 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set timeout.  <a href="#af3cd19eb0af2b51d6740471a344cbb69"></a><br/></td></tr>
81 <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>
82 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return timeout.  <a href="#aaa8de6c9a6635cf2433958a60e4cf87f"></a><br/></td></tr>
83 </table>
84 <hr/><a name="_details"></a><h2>Detailed Description</h2>
85 <p>Process running ssh/scp command. </p>
86 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
87 <dl class="version"><dt><b>Version:</b></dt><dd>0 </dd></dl>
88 <dl class="date"><dt><b>Date:</b></dt><dd>2010-06-11 - 2010-06-12</dd></dl>
89 <p>Run ssh/scp etc. command.</p>
90 <p>Read setting using UrpoConnect settings information object. Support debug monitoring using debugMessage-signals, monitor defined in settings object</p>
91 <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>
92 <div class="fragment"><pre class="fragment">  ...
93   <span class="comment">// Get list of available printers</span>
94
95     QString command = <span class="stringliteral">&quot;ssh &quot;</span>;
96     command.append(getConnection()-&gt;getKeyOption());
97     command.append(getConnection()-&gt;getHostString());
98     command.append(<span class="stringliteral">&quot; env LANG=en lpstat -p&quot;</span>);
99
100     process = <span class="keyword">new</span> <a class="code" href="class_urpo_process.html#ace05eb4301a27d8c20edfc85d28ebdcf">UrpoProcess</a>( connect );
101
102   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>) ) );
103   process.start(command);
104
105   ...
106   ::readOutput(<span class="keywordtype">bool</span> success)
107   {
108     <span class="keywordflow">if</span>( success )
109     {
110         <span class="keywordflow">foreach</span>(QString line, process-&gt;getOutput() )
111         cout &lt;&lt; line &lt;&lt; <span class="stringliteral">&quot;\n&quot;</span>;
112     }
113     <span class="keywordflow">else</span>
114         cout &lt;&lt; <span class="stringliteral">&quot;Error &quot;</span> &lt;&lt; process-&gt;getError();
115   }
116 </pre></div><dl class="see"><dt><b>See also:</b></dt><dd>UrpoConnect </dd></dl>
117
118 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00076">76</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
119 <hr/><h2>Member Enumeration Documentation</h2>
120 <a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9"></a><!-- doxytag: member="UrpoProcess::UrpoError" ref="a5b17cbee3ba24de244bd011aabac21c9" args="" -->
121 <div class="memitem">
122 <div class="memproto">
123       <table class="memname">
124         <tr>
125           <td class="memname">enum <a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9">UrpoProcess::UrpoError</a></td>
126         </tr>
127       </table>
128 </div>
129 <div class="memdoc">
130 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
131 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f"></a><!-- doxytag: member="NoError" ref="a5b17cbee3ba24de244bd011aabac21c9a26e2a92c998579ae82dad85a3d848a7f" args="" -->NoError</em>&nbsp;</td><td>
132 <p>No errors happends. </p>
133 </td></tr>
134 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6"></a><!-- doxytag: member="ProcessError" ref="a5b17cbee3ba24de244bd011aabac21c9a891ce4a53adb16a45fff88029c8739b6" args="" -->ProcessError</em>&nbsp;</td><td>
135 <p>Error running process. </p>
136 </td></tr>
137 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa"></a><!-- doxytag: member="ConnectionError" ref="a5b17cbee3ba24de244bd011aabac21c9a07e7216198891523a8929af6b852e7aa" args="" -->ConnectionError</em>&nbsp;</td><td>
138 <p>Error connecting host. </p>
139 </td></tr>
140 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a2de1e6756c01a0fe2f56e3f324f7845f"></a><!-- doxytag: member="AuthError" ref="a5b17cbee3ba24de244bd011aabac21c9a2de1e6756c01a0fe2f56e3f324f7845f" args="" -->AuthError</em>&nbsp;</td><td>
141 <p>Authentication failed. </p>
142 </td></tr>
143 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce"></a><!-- doxytag: member="Timeout" ref="a5b17cbee3ba24de244bd011aabac21c9afba71edd7db677a460890436a85e56ce" args="" -->Timeout</em>&nbsp;</td><td>
144 <p>Timed out. </p>
145 </td></tr>
146 <tr><td valign="top"><em><a class="anchor" id="a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff"></a><!-- doxytag: member="Cancelled" ref="a5b17cbee3ba24de244bd011aabac21c9a6284f1526b7edf5014aabba519d584ff" args="" -->Cancelled</em>&nbsp;</td><td>
147 <p>User cancelled operation. </p>
148 </td></tr>
149 </table>
150 </dd>
151 </dl>
152
153 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00093">93</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
154
155 </div>
156 </div>
157 <a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2"></a><!-- doxytag: member="UrpoProcess::UrpoStatus" ref="a1be26b6dc5a227f88d8fa7be477578a2" args="" -->
158 <div class="memitem">
159 <div class="memproto">
160       <table class="memname">
161         <tr>
162           <td class="memname">enum <a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2">UrpoProcess::UrpoStatus</a></td>
163         </tr>
164       </table>
165 </div>
166 <div class="memdoc">
167 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
168 <tr><td valign="top"><em><a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2ac5894b205772be5c5d2cab467dc4c90d"></a><!-- doxytag: member="Ready" ref="a1be26b6dc5a227f88d8fa7be477578a2ac5894b205772be5c5d2cab467dc4c90d" args="" -->Ready</em>&nbsp;</td><td>
169 <p>Ready for connecting. </p>
170 </td></tr>
171 <tr><td valign="top"><em><a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d"></a><!-- doxytag: member="Running" ref="a1be26b6dc5a227f88d8fa7be477578a2a82cb6930485e0c3b85e341346b2c924d" args="" -->Running</em>&nbsp;</td><td>
172 <p>Command running. </p>
173 </td></tr>
174 <tr><td valign="top"><em><a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2acaff40cc10b23085fd28e0b757de08b9"></a><!-- doxytag: member="Successed" ref="a1be26b6dc5a227f88d8fa7be477578a2acaff40cc10b23085fd28e0b757de08b9" args="" -->Successed</em>&nbsp;</td><td>
175 <p>Command successed. </p>
176 </td></tr>
177 <tr><td valign="top"><em><a class="anchor" id="a1be26b6dc5a227f88d8fa7be477578a2a5e0b84210eb20245a9f3a925297088e2"></a><!-- doxytag: member="Failed" ref="a1be26b6dc5a227f88d8fa7be477578a2a5e0b84210eb20245a9f3a925297088e2" args="" -->Failed</em>&nbsp;</td><td>
178 <p>Command failed. </p>
179 </td></tr>
180 </table>
181 </dd>
182 </dl>
183
184 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00086">86</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
185
186 </div>
187 </div>
188 <hr/><h2>Constructor &amp; Destructor Documentation</h2>
189 <a class="anchor" id="ace05eb4301a27d8c20edfc85d28ebdcf"></a><!-- doxytag: member="UrpoProcess::UrpoProcess" ref="ace05eb4301a27d8c20edfc85d28ebdcf" args="(QObject *parent=0)" -->
190 <div class="memitem">
191 <div class="memproto">
192       <table class="memname">
193         <tr>
194           <td class="memname">UrpoProcess::UrpoProcess </td>
195           <td>(</td>
196           <td class="paramtype">QObject *&nbsp;</td>
197           <td class="paramname"> <em>parent</em> = <code>0</code></td>
198           <td>&nbsp;)&nbsp;</td>
199           <td><code> [explicit]</code></td>
200         </tr>
201       </table>
202 </div>
203 <div class="memdoc">
204 <dl><dt><b>Parameters:</b></dt><dd>
205   <table border="0" cellspacing="2" cellpadding="0">
206     <tr><td valign="top"></td><td valign="top"><em>connection</em>&nbsp;</td><td>Pointer to connection settings information </td></tr>
207   </table>
208   </dd>
209 </dl>
210
211 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00032">32</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
212
213 </div>
214 </div>
215 <hr/><h2>Member Function Documentation</h2>
216 <a class="anchor" id="adc31070a303b210a9244213fda1f9939"></a><!-- doxytag: member="UrpoProcess::debugMessage" ref="adc31070a303b210a9244213fda1f9939" args="(QString message)" -->
217 <div class="memitem">
218 <div class="memproto">
219       <table class="memname">
220         <tr>
221           <td class="memname">void UrpoProcess::debugMessage </td>
222           <td>(</td>
223           <td class="paramtype">QString&nbsp;</td>
224           <td class="paramname"> <em>message</em></td>
225           <td>&nbsp;)&nbsp;</td>
226           <td><code> [signal]</code></td>
227         </tr>
228       </table>
229 </div>
230 <div class="memdoc">
231 <p>Send debug messages</p>
232 <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>
233 <dl><dt><b>Parameters:</b></dt><dd>
234   <table border="0" cellspacing="2" cellpadding="0">
235     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>Message send to debug monitor </td></tr>
236   </table>
237   </dd>
238 </dl>
239
240 </div>
241 </div>
242 <a class="anchor" id="ab1c5d2e4c2bda8d34700b478fd5af1ad"></a><!-- doxytag: member="UrpoProcess::finished" ref="ab1c5d2e4c2bda8d34700b478fd5af1ad" args="(bool success)" -->
243 <div class="memitem">
244 <div class="memproto">
245       <table class="memname">
246         <tr>
247           <td class="memname">void UrpoProcess::finished </td>
248           <td>(</td>
249           <td class="paramtype">bool&nbsp;</td>
250           <td class="paramname"> <em>success</em></td>
251           <td>&nbsp;)&nbsp;</td>
252           <td><code> [signal]</code></td>
253         </tr>
254       </table>
255 </div>
256 <div class="memdoc">
257
258 <p>Process finished (successed of failed). </p>
259 <dl><dt><b>Parameters:</b></dt><dd>
260   <table border="0" cellspacing="2" cellpadding="0">
261     <tr><td valign="top"></td><td valign="top"><em>success</em>&nbsp;</td><td>True if process successed, false if failed</td></tr>
262   </table>
263   </dd>
264 </dl>
265 <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>
266
267 </div>
268 </div>
269 <a class="anchor" id="af71059723175a0ee9324a9794eff4cb1"></a><!-- doxytag: member="UrpoProcess::getError" ref="af71059723175a0ee9324a9794eff4cb1" args="() const " -->
270 <div class="memitem">
271 <div class="memproto">
272       <table class="memname">
273         <tr>
274           <td class="memname"><a class="el" href="class_urpo_process.html#a5b17cbee3ba24de244bd011aabac21c9">UrpoError</a> UrpoProcess::getError </td>
275           <td>(</td>
276           <td class="paramname"></td>
277           <td>&nbsp;)&nbsp;</td>
278           <td> const<code> [inline]</code></td>
279         </tr>
280       </table>
281 </div>
282 <div class="memdoc">
283
284 <p>Error of process. </p>
285 <p>If process failed, get error code </p>
286 <dl class="return"><dt><b>Returns:</b></dt><dd>Error code </dd></dl>
287
288 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00121">121</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
289
290 </div>
291 </div>
292 <a class="anchor" id="a5a400d2abb550076c778a6030293e764"></a><!-- doxytag: member="UrpoProcess::getErrorString" ref="a5a400d2abb550076c778a6030293e764" args="() const " -->
293 <div class="memitem">
294 <div class="memproto">
295       <table class="memname">
296         <tr>
297           <td class="memname">QString UrpoProcess::getErrorString </td>
298           <td>(</td>
299           <td class="paramname"></td>
300           <td>&nbsp;)&nbsp;</td>
301           <td> const</td>
302         </tr>
303       </table>
304 </div>
305 <div class="memdoc">
306
307 <p>Error of process (in string). </p>
308 <p>If process failed, return error string readable by user</p>
309 <dl class="return"><dt><b>Returns:</b></dt><dd>Error string </dd></dl>
310
311 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00114">114</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
312
313 </div>
314 </div>
315 <a class="anchor" id="af1d8cbb3465d62ab7541aac2fef7f963"></a><!-- doxytag: member="UrpoProcess::getOutput" ref="af1d8cbb3465d62ab7541aac2fef7f963" args="()" -->
316 <div class="memitem">
317 <div class="memproto">
318       <table class="memname">
319         <tr>
320           <td class="memname">QStringList UrpoProcess::getOutput </td>
321           <td>(</td>
322           <td class="paramname"></td>
323           <td>&nbsp;)&nbsp;</td>
324           <td></td>
325         </tr>
326       </table>
327 </div>
328 <div class="memdoc">
329
330 <p>Get output of command. </p>
331 <dl class="return"><dt><b>Returns:</b></dt><dd>Output of command, list of QStrings </dd></dl>
332
333 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00045">45</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
334
335 </div>
336 </div>
337 <a class="anchor" id="a81ca2705b2b20d46a26f19d4a413cbdb"></a><!-- doxytag: member="UrpoProcess::getStatus" ref="a81ca2705b2b20d46a26f19d4a413cbdb" args="() const " -->
338 <div class="memitem">
339 <div class="memproto">
340       <table class="memname">
341         <tr>
342           <td class="memname"><a class="el" href="class_urpo_process.html#a1be26b6dc5a227f88d8fa7be477578a2">UrpoStatus</a> UrpoProcess::getStatus </td>
343           <td>(</td>
344           <td class="paramname"></td>
345           <td>&nbsp;)&nbsp;</td>
346           <td> const<code> [inline]</code></td>
347         </tr>
348       </table>
349 </div>
350 <div class="memdoc">
351
352 <p>Process status. </p>
353 <dl class="return"><dt><b>Returns:</b></dt><dd>Status (Ready, Running, Successed, Failed) </dd></dl>
354
355 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00135">135</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
356
357 </div>
358 </div>
359 <a class="anchor" id="aaa8de6c9a6635cf2433958a60e4cf87f"></a><!-- doxytag: member="UrpoProcess::getTimeout" ref="aaa8de6c9a6635cf2433958a60e4cf87f" args="()" -->
360 <div class="memitem">
361 <div class="memproto">
362       <table class="memname">
363         <tr>
364           <td class="memname">int UrpoProcess::getTimeout </td>
365           <td>(</td>
366           <td class="paramname"></td>
367           <td>&nbsp;)&nbsp;</td>
368           <td><code> [inline]</code></td>
369         </tr>
370       </table>
371 </div>
372 <div class="memdoc">
373
374 <p>Return timeout. </p>
375 <dl class="return"><dt><b>Returns:</b></dt><dd>Timeout in msecs </dd></dl>
376
377 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00159">159</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
378
379 </div>
380 </div>
381 <a class="anchor" id="a0d75a2951e7add2e70c02cd8bf56de3e"></a><!-- doxytag: member="UrpoProcess::sendDebugMessage" ref="a0d75a2951e7add2e70c02cd8bf56de3e" args="(QString message)" -->
382 <div class="memitem">
383 <div class="memproto">
384       <table class="memname">
385         <tr>
386           <td class="memname">void UrpoProcess::sendDebugMessage </td>
387           <td>(</td>
388           <td class="paramtype">QString&nbsp;</td>
389           <td class="paramname"> <em>message</em></td>
390           <td>&nbsp;)&nbsp;</td>
391           <td><code> [inline]</code></td>
392         </tr>
393       </table>
394 </div>
395 <div class="memdoc">
396
397 <p>Send debug message. </p>
398 <dl><dt><b>Parameters:</b></dt><dd>
399   <table border="0" cellspacing="2" cellpadding="0">
400     <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>Message to debug monitor</td></tr>
401   </table>
402   </dd>
403 </dl>
404 <p>If debug monitor has been connected, send message to debug monitor </p>
405
406 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00145">145</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
407
408 </div>
409 </div>
410 <a class="anchor" id="af3cd19eb0af2b51d6740471a344cbb69"></a><!-- doxytag: member="UrpoProcess::setTimeout" ref="af3cd19eb0af2b51d6740471a344cbb69" args="(int msecs)" -->
411 <div class="memitem">
412 <div class="memproto">
413       <table class="memname">
414         <tr>
415           <td class="memname">void UrpoProcess::setTimeout </td>
416           <td>(</td>
417           <td class="paramtype">int&nbsp;</td>
418           <td class="paramname"> <em>msecs</em></td>
419           <td>&nbsp;)&nbsp;</td>
420           <td><code> [inline]</code></td>
421         </tr>
422       </table>
423 </div>
424 <div class="memdoc">
425
426 <p>Set timeout. </p>
427 <p>Process time out, if running command last more than timeout</p>
428 <dl><dt><b>Parameters:</b></dt><dd>
429   <table border="0" cellspacing="2" cellpadding="0">
430     <tr><td valign="top"></td><td valign="top"><em>msecs</em>&nbsp;</td><td>Timeout in msecs </td></tr>
431   </table>
432   </dd>
433 </dl>
434
435 <p>Definition at line <a class="el" href="urpoprocess_8h_source.html#l00154">154</a> of file <a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a>.</p>
436
437 </div>
438 </div>
439 <a class="anchor" id="a1bf2519b81fe6d5074db04f9acd38cb0"></a><!-- doxytag: member="UrpoProcess::start" ref="a1bf2519b81fe6d5074db04f9acd38cb0" args="(const QString &amp;command)" -->
440 <div class="memitem">
441 <div class="memproto">
442       <table class="memname">
443         <tr>
444           <td class="memname">void UrpoProcess::start </td>
445           <td>(</td>
446           <td class="paramtype">const QString &amp;&nbsp;</td>
447           <td class="paramname"> <em>command</em></td>
448           <td>&nbsp;)&nbsp;</td>
449           <td></td>
450         </tr>
451       </table>
452 </div>
453 <div class="memdoc">
454
455 <p>Run command. </p>
456 <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>
457 <dl><dt><b>Parameters:</b></dt><dd>
458   <table border="0" cellspacing="2" cellpadding="0">
459     <tr><td valign="top"></td><td valign="top"><em>command</em>&nbsp;</td><td>Command to execute </td></tr>
460   </table>
461   </dd>
462 </dl>
463
464 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00067">67</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
465
466 </div>
467 </div>
468 <a class="anchor" id="ac4381636ee9e977dfac4d8fe53ddfeaa"></a><!-- doxytag: member="UrpoProcess::terminate" ref="ac4381636ee9e977dfac4d8fe53ddfeaa" args="()" -->
469 <div class="memitem">
470 <div class="memproto">
471       <table class="memname">
472         <tr>
473           <td class="memname">void UrpoProcess::terminate </td>
474           <td>(</td>
475           <td class="paramname"></td>
476           <td>&nbsp;)&nbsp;</td>
477           <td><code> [slot]</code></td>
478         </tr>
479       </table>
480 </div>
481 <div class="memdoc">
482
483 <p>Cancel process. </p>
484 <p>Terminate process. Emit finished(false) signal and set Cancelled error </p>
485
486 <p>Definition at line <a class="el" href="urpoprocess_8cpp_source.html#l00040">40</a> of file <a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a>.</p>
487
488 </div>
489 </div>
490 <hr/>The documentation for this class was generated from the following files:<ul>
491 <li>src/<a class="el" href="urpoprocess_8h_source.html">urpoprocess.h</a></li>
492 <li>src/<a class="el" href="urpoprocess_8cpp_source.html">urpoprocess.cpp</a></li>
493 </ul>
494 </div>
495 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Sep 27 18:46:05 2010 for Urpo by&nbsp;
496 <a href="http://www.doxygen.org/index.html">
497 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
498 </body>
499 </html>