git.maemo.org Git - urpo/blob - www/apidoc/html/class_urpo_connection.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: UrpoConnection 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>UrpoConnection Class Reference</h1><!-- doxytag: class="UrpoConnection" -->
  29 <p>Information about ssh connection (abstract).
  30 <a href="#_details">More...</a></p>
  31
  32 <p><code>#include &lt;<a class="el" href="urpoconnection_8h_source.html">urpoconnection.h</a>&gt;</code></p>
  33 <div class="dynheader">
  34 Inheritance diagram for UrpoConnection:</div>
  35 <div class="dynsection">
  36  <div class="center">
  37   <img src="class_urpo_connection.png" usemap="#UrpoConnection_map" alt=""/>
  38   <map id="UrpoConnection_map" name="UrpoConnection_map">
  39 <area href="class_urpo_connection_settings.html" alt="UrpoConnectionSettings" shape="rect" coords="0,56,147,80"/>
  40 </map>
  41  </div>
  42 </div>
  43
  44 <p><a href="class_urpo_connection-members.html">List of all members.</a></p>
  45 <table border="0" cellpadding="0" cellspacing="0">
  46 <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
  47 <tr><td class="memItemLeft" align="right" valign="top">virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection.html#acfaef63e321ad056ef6da06772967c3b">getHost</a> () const =0</td></tr>
  48 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Host name or ip address.  <a href="#acfaef63e321ad056ef6da06772967c3b"></a><br/></td></tr>
  49 <tr><td class="memItemLeft" align="right" valign="top">virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection.html#aba99d8ff49fffbca8346d54adf244c84">getUserid</a> () const =0</td></tr>
  50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Userid in server.  <a href="#aba99d8ff49fffbca8346d54adf244c84"></a><br/></td></tr>
  51 <tr><td class="memItemLeft" align="right" valign="top">virtual QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection.html#ade5d637438a69724385e268fe32d989c">getIdentity</a> () const =0</td></tr>
  52 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Identity file.  <a href="#ade5d637438a69724385e268fe32d989c"></a><br/></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_connection.html#a00838175ff1a662c9c140b3f45a0d2c4">setDebugMonitor</a> (QObject *monitor)</td></tr>
  54 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default time out in connection.  <a href="#a00838175ff1a662c9c140b3f45a0d2c4"></a><br/></td></tr>
  55 <tr><td class="memItemLeft" align="right" valign="top">QObject *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection.html#abd0b75726873690496758671d4ac2675">getDebugMonitor</a> () const </td></tr>
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get pointer to Debug monitor.  <a href="#abd0b75726873690496758671d4ac2675"></a><br/></td></tr>
  57 <tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection.html#a27a49d8cc8af0a22879f25ed9fe45b68">getHostString</a> ()</td></tr>
  58 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">user@host -string  <a href="#a27a49d8cc8af0a22879f25ed9fe45b68"></a><br/></td></tr>
  59 <tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_urpo_connection.html#a2612ae2ee7c49d582c9f8dc21ab7c406">getKeyOption</a> ()</td></tr>
  60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Key option needed for ssh.  <a href="#a2612ae2ee7c49d582c9f8dc21ab7c406"></a><br/></td></tr>
  61 </table>
  62 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  63 <p>Information about ssh connection (abstract). </p>
  64 <dl class="author"><dt><b>Author:</b></dt><dd>Arto Hyvättinen </dd></dl>
  65 <dl class="date"><dt><b>Date:</b></dt><dd>2010-06-11 </dd></dl>
  66 <dl class="version"><dt><b>Version:</b></dt><dd>1  </dd></dl>
  67
  68 <p>Definition at line <a class="el" href="urpoconnection_8h_source.html#l00039">39</a> of file <a class="el" href="urpoconnection_8h_source.html">urpoconnection.h</a>.</p>
  69 <hr/><h2>Member Function Documentation</h2>
  70 <a class="anchor" id="abd0b75726873690496758671d4ac2675"></a><!-- doxytag: member="UrpoConnection::getDebugMonitor" ref="abd0b75726873690496758671d4ac2675" args="() const " -->
  71 <div class="memitem">
  72 <div class="memproto">
  73       <table class="memname">
  74         <tr>
  75           <td class="memname">QObject * UrpoConnection::getDebugMonitor </td>
  76           <td>(</td>
  77           <td class="paramname"></td>
  78           <td>&nbsp;)&nbsp;</td>
  79           <td> const</td>
  80         </tr>
  81       </table>
  82 </div>
  83 <div class="memdoc">
  84
  85 <p>Get pointer to Debug monitor. </p>
  86 <p>Debug monitor is QObject receiving debugMsg(QString&amp;) signals. </p>
  87 <dl class="return"><dt><b>Returns:</b></dt><dd>QObject receiving debug messages </dd></dl>
  88
  89 <p>Definition at line <a class="el" href="urpoconnection_8cpp_source.html#l00037">37</a> of file <a class="el" href="urpoconnection_8cpp_source.html">urpoconnection.cpp</a>.</p>
  90
  91 </div>
  92 </div>
  93 <a class="anchor" id="acfaef63e321ad056ef6da06772967c3b"></a><!-- doxytag: member="UrpoConnection::getHost" ref="acfaef63e321ad056ef6da06772967c3b" args="() const =0" -->
  94 <div class="memitem">
  95 <div class="memproto">
  96       <table class="memname">
  97         <tr>
  98           <td class="memname">virtual QString UrpoConnection::getHost </td>
  99           <td>(</td>
 100           <td class="paramname"></td>
 101           <td>&nbsp;)&nbsp;</td>
 102           <td> const<code> [pure virtual]</code></td>
 103         </tr>
 104       </table>
 105 </div>
 106 <div class="memdoc">
 107
 108 <p>Host name or ip address. </p>
 109 <dl class="return"><dt><b>Returns:</b></dt><dd>Server host name of ip address </dd></dl>
 110
 111 <p>Implemented in <a class="el" href="class_urpo_connection_settings.html#a2b24ed1467e465c776b8fc9fea398ba3">UrpoConnectionSettings</a>.</p>
 112
 113 </div>
 114 </div>
 115 <a class="anchor" id="a27a49d8cc8af0a22879f25ed9fe45b68"></a><!-- doxytag: member="UrpoConnection::getHostString" ref="a27a49d8cc8af0a22879f25ed9fe45b68" args="()" -->
 116 <div class="memitem">
 117 <div class="memproto">
 118       <table class="memname">
 119         <tr>
 120           <td class="memname">QString UrpoConnection::getHostString </td>
 121           <td>(</td>
 122           <td class="paramname"></td>
 123           <td>&nbsp;)&nbsp;</td>
 124           <td></td>
 125         </tr>
 126       </table>
 127 </div>
 128 <div class="memdoc">
 129
 130 <p>user@host -string </p>
 131 <dl class="return"><dt><b>Returns:</b></dt><dd>user@host -string </dd></dl>
 132
 133 <p>Definition at line <a class="el" href="urpoconnection_8cpp_source.html#l00047">47</a> of file <a class="el" href="urpoconnection_8cpp_source.html">urpoconnection.cpp</a>.</p>
 134
 135 </div>
 136 </div>
 137 <a class="anchor" id="ade5d637438a69724385e268fe32d989c"></a><!-- doxytag: member="UrpoConnection::getIdentity" ref="ade5d637438a69724385e268fe32d989c" args="() const =0" -->
 138 <div class="memitem">
 139 <div class="memproto">
 140       <table class="memname">
 141         <tr>
 142           <td class="memname">virtual QString UrpoConnection::getIdentity </td>
 143           <td>(</td>
 144           <td class="paramname"></td>
 145           <td>&nbsp;)&nbsp;</td>
 146           <td> const<code> [pure virtual]</code></td>
 147         </tr>
 148       </table>
 149 </div>
 150 <div class="memdoc">
 151
 152 <p>Identity file. </p>
 153 <p>ssh identity file (private key)</p>
 154 <dl class="return"><dt><b>Returns:</b></dt><dd>ssh identity file path </dd></dl>
 155
 156 <p>Implemented in <a class="el" href="class_urpo_connection_settings.html#af929c71f228d34ef86a0f940aa7910ae">UrpoConnectionSettings</a>.</p>
 157
 158 </div>
 159 </div>
 160 <a class="anchor" id="a2612ae2ee7c49d582c9f8dc21ab7c406"></a><!-- doxytag: member="UrpoConnection::getKeyOption" ref="a2612ae2ee7c49d582c9f8dc21ab7c406" args="()" -->
 161 <div class="memitem">
 162 <div class="memproto">
 163       <table class="memname">
 164         <tr>
 165           <td class="memname">QString UrpoConnection::getKeyOption </td>
 166           <td>(</td>
 167           <td class="paramname"></td>
 168           <td>&nbsp;)&nbsp;</td>
 169           <td></td>
 170         </tr>
 171       </table>
 172 </div>
 173 <div class="memdoc">
 174
 175 <p>Key option needed for ssh. </p>
 176 <dl class="return"><dt><b>Returns:</b></dt><dd>-i key_file or empty if no keyfile </dd></dl>
 177
 178 <p>Definition at line <a class="el" href="urpoconnection_8cpp_source.html#l00057">57</a> of file <a class="el" href="urpoconnection_8cpp_source.html">urpoconnection.cpp</a>.</p>
 179
 180 </div>
 181 </div>
 182 <a class="anchor" id="aba99d8ff49fffbca8346d54adf244c84"></a><!-- doxytag: member="UrpoConnection::getUserid" ref="aba99d8ff49fffbca8346d54adf244c84" args="() const =0" -->
 183 <div class="memitem">
 184 <div class="memproto">
 185       <table class="memname">
 186         <tr>
 187           <td class="memname">virtual QString UrpoConnection::getUserid </td>
 188           <td>(</td>
 189           <td class="paramname"></td>
 190           <td>&nbsp;)&nbsp;</td>
 191           <td> const<code> [pure virtual]</code></td>
 192         </tr>
 193       </table>
 194 </div>
 195 <div class="memdoc">
 196
 197 <p>Userid in server. </p>
 198 <dl class="return"><dt><b>Returns:</b></dt><dd>userid in server </dd></dl>
 199
 200 <p>Implemented in <a class="el" href="class_urpo_connection_settings.html#a628e651c01d58bd283308fab9aba98be">UrpoConnectionSettings</a>.</p>
 201
 202 </div>
 203 </div>
 204 <a class="anchor" id="a00838175ff1a662c9c140b3f45a0d2c4"></a><!-- doxytag: member="UrpoConnection::setDebugMonitor" ref="a00838175ff1a662c9c140b3f45a0d2c4" args="(QObject *monitor)" -->
 205 <div class="memitem">
 206 <div class="memproto">
 207       <table class="memname">
 208         <tr>
 209           <td class="memname">void UrpoConnection::setDebugMonitor </td>
 210           <td>(</td>
 211           <td class="paramtype">QObject *&nbsp;</td>
 212           <td class="paramname"> <em>monitor</em></td>
 213           <td>&nbsp;)&nbsp;</td>
 214           <td></td>
 215         </tr>
 216       </table>
 217 </div>
 218 <div class="memdoc">
 219
 220 <p>Default time out in connection. </p>
 221 <p>Connection fais if connecting or commanding lasts more than timeout.</p>
 222 <dl class="return"><dt><b>Returns:</b></dt><dd>default timeout in msecs</dd></dl>
 223 <p>Set Debug monitor Debug monitor is QObject receiving debugMsg(QString&amp;) signals. </p>
 224 <dl><dt><b>Parameters:</b></dt><dd>
 225   <table border="0" cellspacing="2" cellpadding="0">
 226     <tr><td valign="top"></td><td valign="top"><em>monitor</em>&nbsp;</td><td>QObject receiving debug messages </td></tr>
 227   </table>
 228   </dd>
 229 </dl>
 230
 231 <p>Definition at line <a class="el" href="urpoconnection_8cpp_source.html#l00042">42</a> of file <a class="el" href="urpoconnection_8cpp_source.html">urpoconnection.cpp</a>.</p>
 232
 233 </div>
 234 </div>
 235 <hr/>The documentation for this class was generated from the following files:<ul>
 236 <li>src/<a class="el" href="urpoconnection_8h_source.html">urpoconnection.h</a></li>
 237 <li>src/<a class="el" href="urpoconnection_8cpp_source.html">urpoconnection.cpp</a></li>
 238 </ul>
 239 </div>
 240 <hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Sep 27 18:46:05 2010 for Urpo by&nbsp;
 241 <a href="http://www.doxygen.org/index.html">
 242 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 243 </body>
 244 </html>