<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kdesu: SshProcess Class Reference (kdesu)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kdesu</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.4.4 -->
<h1>SshProcess Class Reference</h1><!-- doxytag: class="SshProcess" --><!-- doxytag: inherits="StubProcess" --><code>#include <<a class="el" href="ssh_8h-source.html">ssh.h</a>></code>
<p>
<p>Inheritance diagram for SshProcess:
<p><center><img src="classSshProcess.png" usemap="#SshProcess_map" border="0" alt=""></center>
<map name="SshProcess_map">
<area href="classStubProcess.html" alt="StubProcess" shape="rect" coords="0,56,83,80">
<area href="classPtyProcess.html" alt="PtyProcess" shape="rect" coords="0,0,83,24">
</map>
<a href="classSshProcess-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Executes a remote command, using ssh.
<p>
<p>
Definition at line <a class="el" href="ssh_8h-source.html#l00026">26</a> of file <a class="el" href="ssh_8h-source.html">ssh.h</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#w3">Errors</a> { <b>SshNotFound</b> = 1,
<b>SshNeedsPassword</b>,
<b>SshIncorrectPassword</b>
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="SshProcess::SshProcess" ref="a0" args="(const QCString &host=0, const QCString &user=0, const QCString &command=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a0">SshProcess</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &host=0, const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &user=0, const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &command=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="SshProcess::~SshProcess" ref="a1" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a1">~SshProcess</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a2">setHost</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &host)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a3">setStub</a> (const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &stub)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a4">checkNeedPassword</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a5">checkInstall</a> (const char *password)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a6">exec</a> (const char *password, int check=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7"></a><!-- doxytag: member="SshProcess::prompt" ref="a7" args="()" -->
<a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a7">prompt</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8"></a><!-- doxytag: member="SshProcess::error" ref="a8" args="()" -->
<a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#a8">error</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#b0">display</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b1"></a><!-- doxytag: member="SshProcess::displayAuth" ref="b1" args="()" -->
virtual <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#b1">displayAuth</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#b2">dcopServer</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b3"></a><!-- doxytag: member="SshProcess::virtual_hook" ref="b3" args="(int id, void *data)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSshProcess.html#b3">virtual_hook</a> (int id, void *data)</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a5"></a><!-- doxytag: member="SshProcess::checkInstall" ref="a5" args="(const char *password)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int SshProcess::checkInstall </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>password</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Checks if the stub is installed and if the password is correct.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Zero if everything is correct, nonzero otherwise.</dd></dl>
<p>
Definition at line <a class="el" href="ssh_8cpp-source.html#l00063">63</a> of file <a class="el" href="ssh_8cpp-source.html">ssh.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="SshProcess::checkNeedPassword" ref="a4" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int SshProcess::checkNeedPassword </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Checks if the current user@host needs a password.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>The prompt for the password if a password is required. A null string otherwise.</dd></dl>
<dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>The return doc is so obviously wrong that the C code needs to be checked.</dd></dl>
<p>
Definition at line <a class="el" href="ssh_8cpp-source.html#l00069">69</a> of file <a class="el" href="ssh_8cpp-source.html">ssh.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="b2"></a><!-- doxytag: member="SshProcess::dcopServer" ref="b2" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> SshProcess::dcopServer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
See display.
<p>
<p>
Reimplemented from <a class="el" href="classStubProcess.html#b3">StubProcess</a>.
<p>
Definition at line <a class="el" href="ssh_8cpp-source.html#l00273">273</a> of file <a class="el" href="ssh_8cpp-source.html">ssh.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="b0"></a><!-- doxytag: member="SshProcess::display" ref="b0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> SshProcess::display </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This virtual function can be overloaded when special behavior is desired.
<p>
By default, it returns the value returned by <a class="el" href="classKCookie.html">KCookie</a>.
<p>
Reimplemented from <a class="el" href="classStubProcess.html#b2">StubProcess</a>.
<p>
Definition at line <a class="el" href="ssh_8cpp-source.html#l00260">260</a> of file <a class="el" href="ssh_8cpp-source.html">ssh.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a6"></a><!-- doxytag: member="SshProcess::exec" ref="a6" args="(const char *password, int check=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int SshProcess::exec </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>password</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>check</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Executes the command.
<p>
<p>
Definition at line <a class="el" href="ssh_8cpp-source.html#l00075">75</a> of file <a class="el" href="ssh_8cpp-source.html">ssh.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="SshProcess::setHost" ref="a2" args="(const QCString &host)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void SshProcess::setHost </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>host</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the target host.
<p>
<p>
Definition at line <a class="el" href="ssh_8h-source.html#l00037">37</a> of file <a class="el" href="ssh_8h-source.html">ssh.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="SshProcess::setStub" ref="a3" args="(const QCString &stub)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void SshProcess::setStub </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="elRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>stub</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets the localtion of the remote stub.
<p>
<p>
Definition at line <a class="el" href="ssh_8cpp-source.html#l00057">57</a> of file <a class="el" href="ssh_8cpp-source.html">ssh.cpp</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ssh_8h-source.html">ssh.h</a><li><a class="el" href="ssh_8cpp-source.html">ssh.cpp</a></ul>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kdesu</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="dirs.html">Directories</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKCookie.html">kcookie</option>, <option value="classKDEsuClient.html">kdesuclient</option>, <option value="classPTY.html">pty</option>, <option value="classPtyProcess.html">ptyprocess</option>, <option value="classSshProcess.html">sshprocess</option>, <option value="classStubProcess.html">stubprocess</option>, <option value="classSuProcess.html">suprocess</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
distrib
>
PLD
>
ac
>
amd64
>
media
>
dist
>
by-pkgid
>
90467ea6a387df728f7218a11e972208
>
files
>
4775
