<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfilezilla: process Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="libfilezilla.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfilezilla
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefz.html">fz</a></li><li class="navelem"><a class="el" href="classfz_1_1process.html">process</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classfz_1_1process-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">process Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The process class manages an asynchronous process with redirected IO.
<a href="classfz_1_1process.html#details">More...</a></p>
<p><code>#include <<a class="el" href="process_8hpp_source.html">process.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1c7fbaf7eabf18a2a724100403fdde54"><td class="memItemLeft" align="right" valign="top"><a id="a1c7fbaf7eabf18a2a724100403fdde54"></a>
 </td><td class="memItemRight" valign="bottom"><b>process</b> (<a class="el" href="classfz_1_1process.html">process</a> const &)=delete</td></tr>
<tr class="separator:a1c7fbaf7eabf18a2a724100403fdde54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7cab9bbde4cf43b8c06c9333d2bcebf"><td class="memItemLeft" align="right" valign="top"><a id="af7cab9bbde4cf43b8c06c9333d2bcebf"></a>
<a class="el" href="classfz_1_1process.html">process</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfz_1_1process.html">process</a> const &)=delete</td></tr>
<tr class="separator:af7cab9bbde4cf43b8c06c9333d2bcebf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a115d96e600e24af03f50dfa02f41f7cf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1process.html#a115d96e600e24af03f50dfa02f41f7cf">spawn</a> (<a class="el" href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">native_string</a> const &cmd, std::vector< <a class="el" href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">native_string</a> > const &args=std::vector< <a class="el" href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">native_string</a> >())</td></tr>
<tr class="memdesc:a115d96e600e24af03f50dfa02f41f7cf"><td class="mdescLeft"> </td><td class="mdescRight">Start the process. <a href="#a115d96e600e24af03f50dfa02f41f7cf">More...</a><br /></td></tr>
<tr class="separator:a115d96e600e24af03f50dfa02f41f7cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b0cbbec974c5074951c857e23d8da77"><td class="memItemLeft" align="right" valign="top"><a id="a1b0cbbec974c5074951c857e23d8da77"></a>
bool </td><td class="memItemRight" valign="bottom"><b>spawn</b> (std::vector< <a class="el" href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">native_string</a> > const &command_with_args)</td></tr>
<tr class="separator:a1b0cbbec974c5074951c857e23d8da77"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae9d52caad9fb2892deeb25596cfd2ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1process.html#aae9d52caad9fb2892deeb25596cfd2ab">kill</a> ()</td></tr>
<tr class="memdesc:aae9d52caad9fb2892deeb25596cfd2ab"><td class="mdescLeft"> </td><td class="mdescRight">Stops the spawned process. <a href="#aae9d52caad9fb2892deeb25596cfd2ab">More...</a><br /></td></tr>
<tr class="separator:aae9d52caad9fb2892deeb25596cfd2ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22ad3ef13eba91f03285364cf3610df8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1process.html#a22ad3ef13eba91f03285364cf3610df8">read</a> (char *<a class="el" href="classfz_1_1buffer.html">buffer</a>, unsigned int len)</td></tr>
<tr class="memdesc:a22ad3ef13eba91f03285364cf3610df8"><td class="mdescLeft"> </td><td class="mdescRight">Read data from process. <a href="#a22ad3ef13eba91f03285364cf3610df8">More...</a><br /></td></tr>
<tr class="separator:a22ad3ef13eba91f03285364cf3610df8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a55142f6c2dc7a599dfc29eb7d2433b62"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classfz_1_1process.html#a55142f6c2dc7a599dfc29eb7d2433b62">write</a> (char const *<a class="el" href="classfz_1_1buffer.html">buffer</a>, unsigned int len)</td></tr>
<tr class="memdesc:a55142f6c2dc7a599dfc29eb7d2433b62"><td class="mdescLeft"> </td><td class="mdescRight">Write data data process. <a href="#a55142f6c2dc7a599dfc29eb7d2433b62">More...</a><br /></td></tr>
<tr class="separator:a55142f6c2dc7a599dfc29eb7d2433b62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5538d1e5603c2d2ab6401dee241a7533"><td class="memItemLeft" align="right" valign="top"><a id="a5538d1e5603c2d2ab6401dee241a7533"></a>
bool </td><td class="memItemRight" valign="bottom"><b>write</b> (std::string_view const &s)</td></tr>
<tr class="separator:a5538d1e5603c2d2ab6401dee241a7533"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The process class manages an asynchronous process with redirected IO. </p>
<p>No console window is being created.</p>
<p>To use, spawn the process and, since it's blocking, call read from a different thread. </p>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="process_8cpp-example.html#_a2">process.cpp</a>.</dd>
</dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aae9d52caad9fb2892deeb25596cfd2ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae9d52caad9fb2892deeb25596cfd2ab">◆ </a></span>kill()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kill </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stops the spawned process. </p>
<p>This function doesn't actually kill the process, it merely closes the pipes.</p>
<p>Blocks until the process has quit. </p>
</div>
</div>
<a id="a22ad3ef13eba91f03285364cf3610df8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22ad3ef13eba91f03285364cf3610df8">◆ </a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int read </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from process. </p>
<p>This function blocks</p>
<dl class="section return"><dt>Returns</dt><dd>>0 Number of octets read, can be less than requested </dd>
<dd>
0 on EOF </dd>
<dd>
-1 on error. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="process_8cpp-example.html#a5">process.cpp</a>.</dd>
</dl>
</div>
</div>
<a id="a115d96e600e24af03f50dfa02f41f7cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a115d96e600e24af03f50dfa02f41f7cf">◆ </a></span>spawn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool spawn </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">native_string</a> const & </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< <a class="el" href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">native_string</a> > const & </td>
<td class="paramname"><em>args</em> = <code>std::vector< <a class="el" href="namespacefz.html#a79dcecd35ee9a55ae1a5afe76d23e9e5">native_string</a> >()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the process. </p>
<p>This function takes care of properly quoting and escaping the the program's path and its arguments. Fails if process has already been spawned.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cmd</td><td>The path of the program to execute </td></tr>
<tr><td class="paramname">args</td><td>The command-line arguments for the process.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>May return <code>true</code> even if the process cannot be started. In that case, trying to read from the process will fail with an error or EOF. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="process_8cpp-example.html#a3">process.cpp</a>.</dd>
</dl>
</div>
</div>
<a id="a55142f6c2dc7a599dfc29eb7d2433b62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55142f6c2dc7a599dfc29eb7d2433b62">◆ </a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool write </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write data data process. </p>
<p>This function blocks</p>
<dl class="section return"><dt>Returns</dt><dd>true if all octets have been written. </dd>
<dd>
false on error. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="process_8cpp-example.html#a4">process.cpp</a>.</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="process_8hpp_source.html">process.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
94774a05d4f99367afd97b8b4adf565d
>
files
>
134
