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