LADI
/
jack-plugin-docs
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
jack-plugin-docs/libjpl-api/loader_8h.html

319 lines
17 KiB
HTML
Raw Blame History

<!-- HTML header for doxygen 1.9.6-->
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JACK Plugin Launcher: loader.h File 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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">JACK Plugin Launcher
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">loader.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Interface to the code that starts programs (launcher module)
<a href="#details">More...</a></p>
<p><a href="loader_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structjpl__child__tag.html">jpl_child_tag</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a8da2c08d82e942d6a383ccadace574de" id="r_a8da2c08d82e942d6a383ccadace574de"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structjpl__child__tag.html">jpl_child_tag</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="loader_8h.html#a8da2c08d82e942d6a383ccadace574de">jpl_child_handle</a></td></tr>
<tr class="separator:a8da2c08d82e942d6a383ccadace574de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b5b920eec41d3a3d367694a7d5604f5" id="r_a9b5b920eec41d3a3d367694a7d5604f5"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="loader_8h.html#a9b5b920eec41d3a3d367694a7d5604f5">jpl_on_child_exit</a>) (void *ctx, int exit_status)</td></tr>
<tr class="memdesc:a9b5b920eec41d3a3d367694a7d5604f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">function type for callback called on child exit <br /></td></tr>
<tr class="separator:a9b5b920eec41d3a3d367694a7d5604f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d3d646ee1a8b02e8288d2c248407376" id="r_a7d3d646ee1a8b02e8288d2c248407376"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="loader_8h.html#a7d3d646ee1a8b02e8288d2c248407376">jpl_log_callback</a>) (void *ctx, bool error, const char *format,...)</td></tr>
<tr class="memdesc:a7d3d646ee1a8b02e8288d2c248407376"><td class="mdescLeft">&#160;</td><td class="mdescRight">function type for callback called on child exit <br /></td></tr>
<tr class="separator:a7d3d646ee1a8b02e8288d2c248407376"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a26f5478ddde4a440a4e575bedf013081" id="r_a26f5478ddde4a440a4e575bedf013081"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="loader_8h.html#a26f5478ddde4a440a4e575bedf013081">jpl_init</a> (<a class="el" href="loader_8h.html#a9b5b920eec41d3a3d367694a7d5604f5">jpl_on_child_exit</a> on_child_exit, <a class="el" href="loader_8h.html#a7d3d646ee1a8b02e8288d2c248407376">jpl_log_callback</a> log_callback)</td></tr>
<tr class="memdesc:a26f5478ddde4a440a4e575bedf013081"><td class="mdescLeft">&#160;</td><td class="mdescRight">initialize the launcher module <br /></td></tr>
<tr class="separator:a26f5478ddde4a440a4e575bedf013081"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae127be7ab8852a56c48d4ef64109ae5c" id="r_ae127be7ab8852a56c48d4ef64109ae5c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="loader_8h.html#ae127be7ab8852a56c48d4ef64109ae5c">jpl_execute</a> (void *ctx, const char *working_dir, bool run_in_terminal, const char *commandline, const char *const *env_vars, const char *const *ldpreload, pid_t *pid_ptr, <a class="el" href="loader_8h.html#a8da2c08d82e942d6a383ccadace574de">jpl_child_handle</a> *child_handle_ptr)</td></tr>
<tr class="memdesc:ae127be7ab8852a56c48d4ef64109ae5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">run child program in a subprocess <br /></td></tr>
<tr class="separator:ae127be7ab8852a56c48d4ef64109ae5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47053fa4c3be985fe8cfc9cba35943c7" id="r_a47053fa4c3be985fe8cfc9cba35943c7"><td class="memItemLeft" align="right" valign="top"><a id="a47053fa4c3be985fe8cfc9cba35943c7" name="a47053fa4c3be985fe8cfc9cba35943c7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>jpl_run</b> (void)</td></tr>
<tr class="memdesc:a47053fa4c3be985fe8cfc9cba35943c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read subprocess output and call the callbacks. <br /></td></tr>
<tr class="separator:a47053fa4c3be985fe8cfc9cba35943c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0bce03ff80a12b8e3c5d081949acf89" id="r_ad0bce03ff80a12b8e3c5d081949acf89"><td class="memItemLeft" align="right" valign="top"><a id="ad0bce03ff80a12b8e3c5d081949acf89" name="ad0bce03ff80a12b8e3c5d081949acf89"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>jpl_uninit</b> (void)</td></tr>
<tr class="memdesc:ad0bce03ff80a12b8e3c5d081949acf89"><td class="mdescLeft">&#160;</td><td class="mdescRight">uninitialize the launcher module <br /></td></tr>
<tr class="separator:ad0bce03ff80a12b8e3c5d081949acf89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7725c04ff746f77ebbbe57a738c8bb55" id="r_a7725c04ff746f77ebbbe57a738c8bb55"><td class="memItemLeft" align="right" valign="top"><a id="a7725c04ff746f77ebbbe57a738c8bb55" name="a7725c04ff746f77ebbbe57a738c8bb55"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>jpl_get_app_count</b> (void)</td></tr>
<tr class="memdesc:a7725c04ff746f77ebbbe57a738c8bb55"><td class="mdescLeft">&#160;</td><td class="mdescRight">get number of child processes <br /></td></tr>
<tr class="separator:a7725c04ff746f77ebbbe57a738c8bb55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface to the code that starts programs (launcher module) </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a8da2c08d82e942d6a383ccadace574de" name="a8da2c08d82e942d6a383ccadace574de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8da2c08d82e942d6a383ccadace574de">&#9670;&#160;</a></span>jpl_child_handle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structjpl__child__tag.html">jpl_child_tag</a> * <a class="el" href="loader_8h.html#a8da2c08d82e942d6a383ccadace574de">jpl_child_handle</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Handle to object describing child </p>
</div>
</div>
<a id="a7d3d646ee1a8b02e8288d2c248407376" name="a7d3d646ee1a8b02e8288d2c248407376"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d3d646ee1a8b02e8288d2c248407376">&#9670;&#160;</a></span>jpl_log_callback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* jpl_log_callback) (void *ctx, bool error, const char *format,...)</td>
</tr>
</table>
</div><div class="memdoc">
<p>function type for callback called on child exit </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>context pointer with value as supplied by call to <a class="el" href="loader_8h.html#ae127be7ab8852a56c48d4ef64109ae5c" title="run child program in a subprocess">jpl_execute()</a> </td></tr>
<tr><td class="paramname">error</td><td>whether line from stderr (true) is being logged or from stdout (false) </td></tr>
<tr><td class="paramname">format</td><td>format string </td></tr>
<tr><td class="paramname">...</td><td>optional args, as specified by <code>format</code> parameter </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9b5b920eec41d3a3d367694a7d5604f5" name="a9b5b920eec41d3a3d367694a7d5604f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b5b920eec41d3a3d367694a7d5604f5">&#9670;&#160;</a></span>jpl_on_child_exit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* jpl_on_child_exit) (void *ctx, int exit_status)</td>
</tr>
</table>
</div><div class="memdoc">
<p>function type for callback called on child exit </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>context pointer with value as supplied by call to <a class="el" href="loader_8h.html#ae127be7ab8852a56c48d4ef64109ae5c" title="run child program in a subprocess">jpl_execute()</a> </td></tr>
<tr><td class="paramname">exit_status</td><td>Exit status of the child process </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae127be7ab8852a56c48d4ef64109ae5c" name="ae127be7ab8852a56c48d4ef64109ae5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae127be7ab8852a56c48d4ef64109ae5c">&#9670;&#160;</a></span>jpl_execute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool jpl_execute </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>working_dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>run_in_terminal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>commandline</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const *&#160;</td>
<td class="paramname"><em>env_vars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *const *&#160;</td>
<td class="paramname"><em>ldpreload</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">pid_t *&#160;</td>
<td class="paramname"><em>pid_ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="loader_8h.html#a8da2c08d82e942d6a383ccadace574de">jpl_child_handle</a> *&#160;</td>
<td class="paramname"><em>child_handle_ptr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>run child program in a subprocess </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>context pointer that will be passed as parameter when functions, previously specified int the <a class="el" href="loader_8h.html#a26f5478ddde4a440a4e575bedf013081" title="initialize the launcher module">jpl_init()</a> call, are called. </td></tr>
<tr><td class="paramname">working_dir</td><td>working dir where the program is started </td></tr>
<tr><td class="paramname">run_in_terminal</td><td>whether to run the child program in a new terminal </td></tr>
<tr><td class="paramname">commandline</td><td>command-line to use for starting the child process </td></tr>
<tr><td class="paramname">env_vars</td><td>optional (can be NULL) array of strings for environment variables to be set in the child process the array is terminated by empty string element. </td></tr>
<tr><td class="paramname">ldpreload</td><td>optional (can be NULL) array of strings for LD_PRELOAD-ed libraries. the array is terminated by empty string element. </td></tr>
<tr><td class="paramname">pid_ptr</td><td>pointer to variable where, upon successful return, the child process identifier value will be stored. </td></tr>
<tr><td class="paramname">child_handle_ptr</td><td>pointer to variable where, upon successful return, child handle is stored.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status </dd></dl>
</div>
</div>
<a id="a26f5478ddde4a440a4e575bedf013081" name="a26f5478ddde4a440a4e575bedf013081"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26f5478ddde4a440a4e575bedf013081">&#9670;&#160;</a></span>jpl_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jpl_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="loader_8h.html#a9b5b920eec41d3a3d367694a7d5604f5">jpl_on_child_exit</a>&#160;</td>
<td class="paramname"><em>on_child_exit</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="loader_8h.html#a7d3d646ee1a8b02e8288d2c248407376">jpl_log_callback</a>&#160;</td>
<td class="paramname"><em>log_callback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>initialize the launcher module </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">on_child_exit</td><td>function to call back when child exits </td></tr>
<tr><td class="paramname">log_callback</td><td>function to call back child produces a line </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink