<!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>libzypp: zypp::PluginScript 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libzypp
 <span id="projectnumber">17.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classzypp_1_1PluginScript.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="#friends">Friends</a> |
<a href="#related">Related Functions</a> |
<a href="classzypp_1_1PluginScript-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">zypp::PluginScript Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Interface to plugin scripts using a <code>Stomp</code> inspired communication protocol.
<a href="classzypp_1_1PluginScript.html#details">More...</a></p>
<p><code>#include <<a class="el" href="PluginScript_8h_source.html">PluginScript.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structzypp_1_1PluginScript_1_1Impl.html">Impl</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classzypp_1_1PluginScript.html">PluginScript</a> implementation. <a href="structzypp_1_1PluginScript_1_1Impl.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a42522c153b0e2d1ec258845008477dd7"><td class="memItemLeft" align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">Arguments</a></td></tr>
<tr class="memdesc:a42522c153b0e2d1ec258845008477dd7"><td class="mdescLeft"> </td><td class="mdescRight">Commandline arguments passed to a script on <a class="el" href="classzypp_1_1PluginScript.html#ad93e8078dee37f33e003fc3be9f61e05">open</a>. <a href="#a42522c153b0e2d1ec258845008477dd7">More...</a><br /></td></tr>
<tr class="separator:a42522c153b0e2d1ec258845008477dd7"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a2c3c41480d1a150ba13b618eca2cfc4c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a2c3c41480d1a150ba13b618eca2cfc4c">PluginScript</a> ()</td></tr>
<tr class="memdesc:a2c3c41480d1a150ba13b618eca2cfc4c"><td class="mdescLeft"> </td><td class="mdescRight">Default ctor. <a href="#a2c3c41480d1a150ba13b618eca2cfc4c">More...</a><br /></td></tr>
<tr class="separator:a2c3c41480d1a150ba13b618eca2cfc4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac992df0d7f6605606241de2e0d2285cf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#ac992df0d7f6605606241de2e0d2285cf">PluginScript</a> (const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> &script_r)</td></tr>
<tr class="memdesc:ac992df0d7f6605606241de2e0d2285cf"><td class="mdescLeft"> </td><td class="mdescRight">Ctor taking script path and no arguments. <a href="#ac992df0d7f6605606241de2e0d2285cf">More...</a><br /></td></tr>
<tr class="separator:ac992df0d7f6605606241de2e0d2285cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a550aa6ba324dac8dba131e432855a7fb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a550aa6ba324dac8dba131e432855a7fb">PluginScript</a> (const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> &script_r, const <a class="el" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">Arguments</a> &args_r)</td></tr>
<tr class="memdesc:a550aa6ba324dac8dba131e432855a7fb"><td class="mdescLeft"> </td><td class="mdescRight">Ctor taking script path and script arguments. <a href="#a550aa6ba324dac8dba131e432855a7fb">More...</a><br /></td></tr>
<tr class="separator:a550aa6ba324dac8dba131e432855a7fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2f0c12369a8c14828b935340f0db607"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#ae2f0c12369a8c14828b935340f0db607">script</a> () const</td></tr>
<tr class="memdesc:ae2f0c12369a8c14828b935340f0db607"><td class="mdescLeft"> </td><td class="mdescRight">Return the script path if set. <a href="#ae2f0c12369a8c14828b935340f0db607">More...</a><br /></td></tr>
<tr class="separator:ae2f0c12369a8c14828b935340f0db607"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af32a99f2dccd5cbd6a8ac2f5945aa719"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">Arguments</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#af32a99f2dccd5cbd6a8ac2f5945aa719">args</a> () const</td></tr>
<tr class="memdesc:af32a99f2dccd5cbd6a8ac2f5945aa719"><td class="mdescLeft"> </td><td class="mdescRight">Return the script arguments if set. <a href="#af32a99f2dccd5cbd6a8ac2f5945aa719">More...</a><br /></td></tr>
<tr class="separator:af32a99f2dccd5cbd6a8ac2f5945aa719"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0b2a0015fd0768adaa00942a26251cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#af0b2a0015fd0768adaa00942a26251cd">isOpen</a> () const</td></tr>
<tr class="memdesc:af0b2a0015fd0768adaa00942a26251cd"><td class="mdescLeft"> </td><td class="mdescRight">Whether we are connected to a script. <a href="#af0b2a0015fd0768adaa00942a26251cd">More...</a><br /></td></tr>
<tr class="separator:af0b2a0015fd0768adaa00942a26251cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd27f49a38c1a5873b9eda276c59acc7"><td class="memItemLeft" align="right" valign="top">pid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#acd27f49a38c1a5873b9eda276c59acc7">getPid</a> () const</td></tr>
<tr class="memdesc:acd27f49a38c1a5873b9eda276c59acc7"><td class="mdescLeft"> </td><td class="mdescRight">Return a connected scripts pid or <a class="el" href="classzypp_1_1PluginScript.html#a8d3df60072b20ef1fea0821af78944f4">NotConnected</a>. <a href="#acd27f49a38c1a5873b9eda276c59acc7">More...</a><br /></td></tr>
<tr class="separator:acd27f49a38c1a5873b9eda276c59acc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4705afb32d6695f05c9f86c5c79fc036"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a4705afb32d6695f05c9f86c5c79fc036">lastReturn</a> () const</td></tr>
<tr class="memdesc:a4705afb32d6695f05c9f86c5c79fc036"><td class="mdescLeft"> </td><td class="mdescRight">Remembers a scripts return value after <a class="el" href="classzypp_1_1PluginScript.html#a9b6093ffa8368f2731bd5297143e5e7d">close</a> until next <a class="el" href="classzypp_1_1PluginScript.html#ad93e8078dee37f33e003fc3be9f61e05">open</a>. <a href="#a4705afb32d6695f05c9f86c5c79fc036">More...</a><br /></td></tr>
<tr class="separator:a4705afb32d6695f05c9f86c5c79fc036"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c8614617f570f7e5451334f4baee4ec"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a9c8614617f570f7e5451334f4baee4ec">lastExecError</a> () const</td></tr>
<tr class="memdesc:a9c8614617f570f7e5451334f4baee4ec"><td class="mdescLeft"> </td><td class="mdescRight">Remembers a scripts execError string after <a class="el" href="classzypp_1_1PluginScript.html#a9b6093ffa8368f2731bd5297143e5e7d">close</a> until next <a class="el" href="classzypp_1_1PluginScript.html#ad93e8078dee37f33e003fc3be9f61e05">open</a>. <a href="#a9c8614617f570f7e5451334f4baee4ec">More...</a><br /></td></tr>
<tr class="separator:a9c8614617f570f7e5451334f4baee4ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad93e8078dee37f33e003fc3be9f61e05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#ad93e8078dee37f33e003fc3be9f61e05">open</a> ()</td></tr>
<tr class="memdesc:ad93e8078dee37f33e003fc3be9f61e05"><td class="mdescLeft"> </td><td class="mdescRight">Setup connection and execute script. <a href="#ad93e8078dee37f33e003fc3be9f61e05">More...</a><br /></td></tr>
<tr class="separator:ad93e8078dee37f33e003fc3be9f61e05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64d990ad0b5c3be7dd28cd75577afe4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a64d990ad0b5c3be7dd28cd75577afe4b">open</a> (const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> &script_r)</td></tr>
<tr class="separator:a64d990ad0b5c3be7dd28cd75577afe4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0e70f48a59acec606c0f7ab147e8ecd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#ae0e70f48a59acec606c0f7ab147e8ecd">open</a> (const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> &script_r, const <a class="el" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">Arguments</a> &args_r)</td></tr>
<tr class="separator:ae0e70f48a59acec606c0f7ab147e8ecd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b6093ffa8368f2731bd5297143e5e7d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a9b6093ffa8368f2731bd5297143e5e7d">close</a> ()</td></tr>
<tr class="memdesc:a9b6093ffa8368f2731bd5297143e5e7d"><td class="mdescLeft"> </td><td class="mdescRight">Close any open connection. <a href="#a9b6093ffa8368f2731bd5297143e5e7d">More...</a><br /></td></tr>
<tr class="separator:a9b6093ffa8368f2731bd5297143e5e7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23313d5bb29823d87ea7ac63eeee95ba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a23313d5bb29823d87ea7ac63eeee95ba">send</a> (const <a class="el" href="classzypp_1_1PluginFrame.html">PluginFrame</a> &frame_r) const</td></tr>
<tr class="memdesc:a23313d5bb29823d87ea7ac63eeee95ba"><td class="mdescLeft"> </td><td class="mdescRight">Send a <a class="el" href="classzypp_1_1PluginFrame.html">PluginFrame</a>. <a href="#a23313d5bb29823d87ea7ac63eeee95ba">More...</a><br /></td></tr>
<tr class="separator:a23313d5bb29823d87ea7ac63eeee95ba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a066fd4185d38ea5bbcb2627ab6615ee4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classzypp_1_1PluginFrame.html">PluginFrame</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a066fd4185d38ea5bbcb2627ab6615ee4">receive</a> () const</td></tr>
<tr class="memdesc:a066fd4185d38ea5bbcb2627ab6615ee4"><td class="mdescLeft"> </td><td class="mdescRight">Receive a <a class="el" href="classzypp_1_1PluginFrame.html">PluginFrame</a>. <a href="#a066fd4185d38ea5bbcb2627ab6615ee4">More...</a><br /></td></tr>
<tr class="separator:a066fd4185d38ea5bbcb2627ab6615ee4"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Get/set local timeout settings.</div></td></tr>
<tr class="memitem:a21c04ff49898bb0d14c062c317cf41ca"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a21c04ff49898bb0d14c062c317cf41ca">sendTimeout</a> () const</td></tr>
<tr class="memdesc:a21c04ff49898bb0d14c062c317cf41ca"><td class="mdescLeft"> </td><td class="mdescRight">Local default timeout (sec.) when sending data. <a href="#a21c04ff49898bb0d14c062c317cf41ca">More...</a><br /></td></tr>
<tr class="separator:a21c04ff49898bb0d14c062c317cf41ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1fd70d587ecd63c33d5e0a266adfb3c"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#af1fd70d587ecd63c33d5e0a266adfb3c">receiveTimeout</a> () const</td></tr>
<tr class="memdesc:af1fd70d587ecd63c33d5e0a266adfb3c"><td class="mdescLeft"> </td><td class="mdescRight">Local default timeout (sec.) when receiving data. <a href="#af1fd70d587ecd63c33d5e0a266adfb3c">More...</a><br /></td></tr>
<tr class="separator:af1fd70d587ecd63c33d5e0a266adfb3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb4955b9b9afe5893a97c5d1707cec27"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#aeb4955b9b9afe5893a97c5d1707cec27">sendTimeout</a> (long newval_r)</td></tr>
<tr class="memdesc:aeb4955b9b9afe5893a97c5d1707cec27"><td class="mdescLeft"> </td><td class="mdescRight">Set local default timeout (sec.) when sending data. <a href="#aeb4955b9b9afe5893a97c5d1707cec27">More...</a><br /></td></tr>
<tr class="separator:aeb4955b9b9afe5893a97c5d1707cec27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad57e20b7b04d7fcb62e477f3259827a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#ad57e20b7b04d7fcb62e477f3259827a6">receiveTimeout</a> (long newval_r)</td></tr>
<tr class="memdesc:ad57e20b7b04d7fcb62e477f3259827a6"><td class="mdescLeft"> </td><td class="mdescRight">Set local default timeout (sec.) when receiving data. <a href="#ad57e20b7b04d7fcb62e477f3259827a6">More...</a><br /></td></tr>
<tr class="separator:ad57e20b7b04d7fcb62e477f3259827a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa13d73fbe70aa0d60ea2ff51d6ef2e7b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#aa13d73fbe70aa0d60ea2ff51d6ef2e7b">timeout</a> (long newval_r)</td></tr>
<tr class="memdesc:aa13d73fbe70aa0d60ea2ff51d6ef2e7b"><td class="mdescLeft"> </td><td class="mdescRight">Set local default timeout (sec.) (both: send and receive). <a href="#aa13d73fbe70aa0d60ea2ff51d6ef2e7b">More...</a><br /></td></tr>
<tr class="separator:aa13d73fbe70aa0d60ea2ff51d6ef2e7b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Get/set the global timeout settings.</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>Timeout when sending/receiving data to/from a plugin default to 30 sec.</p>
<p>The value (in seconds) my be changed via the environment variables <code>ZYPP_PLUGIN_SEND_TIMEOUT</code>, <code>ZYPP_PLUGIN_RECEIVE_TIMEOUT</code> or <code>ZYPP_PLUGIN_TIMEOUT</code> (both: send and receive). </p>
</div></td></tr>
<tr class="memitem:aeb060fc6906b4cc7b2cace5852272072"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#aeb060fc6906b4cc7b2cace5852272072">defaultSendTimeout</a> ()</td></tr>
<tr class="memdesc:aeb060fc6906b4cc7b2cace5852272072"><td class="mdescLeft"> </td><td class="mdescRight">Global default timeout (sec.) when sending data. <a href="#aeb060fc6906b4cc7b2cace5852272072">More...</a><br /></td></tr>
<tr class="separator:aeb060fc6906b4cc7b2cace5852272072"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ab072dc1c4b0b961fce44e5c8c2eb71"><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a5ab072dc1c4b0b961fce44e5c8c2eb71">defaultReceiveTimeout</a> ()</td></tr>
<tr class="memdesc:a5ab072dc1c4b0b961fce44e5c8c2eb71"><td class="mdescLeft"> </td><td class="mdescRight">Global default timeout (sec.) when receiving data. <a href="#a5ab072dc1c4b0b961fce44e5c8c2eb71">More...</a><br /></td></tr>
<tr class="separator:a5ab072dc1c4b0b961fce44e5c8c2eb71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89291bb804ee9a73eb73b2386ced5a0b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a89291bb804ee9a73eb73b2386ced5a0b">defaultSendTimeout</a> (long newval_r)</td></tr>
<tr class="memdesc:a89291bb804ee9a73eb73b2386ced5a0b"><td class="mdescLeft"> </td><td class="mdescRight">Set global default timeout (sec.) when sending data. <a href="#a89291bb804ee9a73eb73b2386ced5a0b">More...</a><br /></td></tr>
<tr class="separator:a89291bb804ee9a73eb73b2386ced5a0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe8b3497b0f1c7febd61260579d89e42"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#abe8b3497b0f1c7febd61260579d89e42">defaultReceiveTimeout</a> (long newval_r)</td></tr>
<tr class="memdesc:abe8b3497b0f1c7febd61260579d89e42"><td class="mdescLeft"> </td><td class="mdescRight">Set global default timeout (sec.) when receiving data. <a href="#abe8b3497b0f1c7febd61260579d89e42">More...</a><br /></td></tr>
<tr class="separator:abe8b3497b0f1c7febd61260579d89e42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade5f691577b3655ddf63dcbebbf323b2"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#ade5f691577b3655ddf63dcbebbf323b2">defaultTimeout</a> (long newval_r)</td></tr>
<tr class="memdesc:ade5f691577b3655ddf63dcbebbf323b2"><td class="mdescLeft"> </td><td class="mdescRight">Set global default timeout (sec.) (both: send and receive). <a href="#ade5f691577b3655ddf63dcbebbf323b2">More...</a><br /></td></tr>
<tr class="separator:ade5f691577b3655ddf63dcbebbf323b2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a8d3df60072b20ef1fea0821af78944f4"><td class="memItemLeft" align="right" valign="top">static const pid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a8d3df60072b20ef1fea0821af78944f4">NotConnected</a></td></tr>
<tr class="memdesc:a8d3df60072b20ef1fea0821af78944f4"><td class="mdescLeft"> </td><td class="mdescRight"><code>pid_t</code>(-1) constant indicating no connection. <a href="#a8d3df60072b20ef1fea0821af78944f4">More...</a><br /></td></tr>
<tr class="separator:a8d3df60072b20ef1fea0821af78944f4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a3c592916dbe159e013b555a86b1c001e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structzypp_1_1RW__pointer.html">RW_pointer</a>< <a class="el" href="structzypp_1_1PluginScript_1_1Impl.html">Impl</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a3c592916dbe159e013b555a86b1c001e">_pimpl</a></td></tr>
<tr class="memdesc:a3c592916dbe159e013b555a86b1c001e"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to implementation. <a href="#a3c592916dbe159e013b555a86b1c001e">More...</a><br /></td></tr>
<tr class="separator:a3c592916dbe159e013b555a86b1c001e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aa8d45ebfcd32c5980d3b21643054a813"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#aa8d45ebfcd32c5980d3b21643054a813">operator<<</a> (std::ostream &str, const <a class="el" href="classzypp_1_1PluginScript.html">PluginScript</a> &obj)</td></tr>
<tr class="separator:aa8d45ebfcd32c5980d3b21643054a813"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a14388da39089aeb024325b0c18144767"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classzypp_1_1PluginScript.html#a14388da39089aeb024325b0c18144767">operator<<</a> (std::ostream &str, const <a class="el" href="classzypp_1_1PluginScript.html">PluginScript</a> &obj)</td></tr>
<tr class="separator:a14388da39089aeb024325b0c18144767"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface to plugin scripts using a <code>Stomp</code> inspired communication protocol. </p>
<dl class="section note"><dt>Note</dt><dd><a class="el" href="classzypp_1_1PluginScript.html">PluginScript</a> is copyable and assignable, but the connection is shared among multiple copies. It gets automatically closed if the last copy goes out of scope.</dd></dl>
<p>Timeout when sending/receiving data to/from a plugin default to 30 sec. The value (in seconds) my be changed via the environment variables <code>ZYPP_PLUGIN_SEND_TIMEOUT</code>, <code>ZYPP_PLUGIN_RECEIVE_TIMEOUT</code> or <code>ZYPP_PLUGIN_TIMEOUT</code> (both: send and receive).</p>
<div class="fragment"><div class="line"><span class="comment">// Setup comnnection to plugin script</span></div><div class="line"><a class="code" href="classzypp_1_1PluginScript.html#a2c3c41480d1a150ba13b618eca2cfc4c">PluginScript</a> scr;</div><div class="line"><a class="code" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">PluginScript::Arguments</a> <a class="code" href="classzypp_1_1PluginScript.html#af32a99f2dccd5cbd6a8ac2f5945aa719">args</a>;</div><div class="line"><a class="code" href="classzypp_1_1PluginScript.html#af32a99f2dccd5cbd6a8ac2f5945aa719">args</a>.push_back( <span class="stringliteral">"-v"</span> );</div><div class="line">scr.open( <span class="stringliteral">"/soem/testplugin"</span>, <a class="code" href="classzypp_1_1PluginScript.html#af32a99f2dccd5cbd6a8ac2f5945aa719">args</a> );</div><div class="line"></div><div class="line"><span class="comment">// send frame to plugin</span></div><div class="line">PluginFrame f( <span class="stringliteral">"COMMAND"</span> );</div><div class="line">f.setHeader( <span class="stringliteral">"key"</span>, <span class="stringliteral">"value"</span> );</div><div class="line">f.setBody( <span class="stringliteral">"some\ndata"</span> );</div><div class="line">scr.send( f );</div><div class="line"></div><div class="line"><span class="comment">// receive frame from plugin</span></div><div class="line">PluginFrame r( scr.receive() );</div><div class="line"></div><div class="line"><span class="comment">// explicitly close or let PluginScript go out of scope</span></div><div class="line">scr.close();</div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a href="http://stomp.codehaus.org/">http://stomp.codehaus.org/</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="PluginScript_8h_source.html#l00062">62</a> of file <a class="el" href="PluginScript_8h_source.html">PluginScript.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a42522c153b0e2d1ec258845008477dd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42522c153b0e2d1ec258845008477dd7">◆ </a></span>Arguments</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::vector<std::string> <a class="el" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">zypp::PluginScript::Arguments</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commandline arguments passed to a script on <a class="el" href="classzypp_1_1PluginScript.html#ad93e8078dee37f33e003fc3be9f61e05">open</a>. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8h_source.html#l00068">68</a> of file <a class="el" href="PluginScript_8h_source.html">PluginScript.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a2c3c41480d1a150ba13b618eca2cfc4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c3c41480d1a150ba13b618eca2cfc4c">◆ </a></span>PluginScript() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">zypp::PluginScript::PluginScript </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default ctor. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00462">462</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="ac992df0d7f6605606241de2e0d2285cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac992df0d7f6605606241de2e0d2285cf">◆ </a></span>PluginScript() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">zypp::PluginScript::PluginScript </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> & </td>
<td class="paramname"><em>script_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ctor taking script path and no arguments. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00466">466</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a550aa6ba324dac8dba131e432855a7fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a550aa6ba324dac8dba131e432855a7fb">◆ </a></span>PluginScript() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">zypp::PluginScript::PluginScript </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> & </td>
<td class="paramname"><em>script_r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">Arguments</a> & </td>
<td class="paramname"><em>args_r</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ctor taking script path and script arguments. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00470">470</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aeb060fc6906b4cc7b2cace5852272072"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb060fc6906b4cc7b2cace5852272072">◆ </a></span>defaultSendTimeout() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">long zypp::PluginScript::defaultSendTimeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Global default timeout (sec.) when sending data. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00438">438</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a5ab072dc1c4b0b961fce44e5c8c2eb71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ab072dc1c4b0b961fce44e5c8c2eb71">◆ </a></span>defaultReceiveTimeout() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">long zypp::PluginScript::defaultReceiveTimeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Global default timeout (sec.) when receiving data. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00441">441</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a89291bb804ee9a73eb73b2386ced5a0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89291bb804ee9a73eb73b2386ced5a0b">◆ </a></span>defaultSendTimeout() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::defaultSendTimeout </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>newval_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set global default timeout (sec.) when sending data. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00444">444</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="abe8b3497b0f1c7febd61260579d89e42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe8b3497b0f1c7febd61260579d89e42">◆ </a></span>defaultReceiveTimeout() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::defaultReceiveTimeout </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>newval_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set global default timeout (sec.) when receiving data. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00447">447</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="ade5f691577b3655ddf63dcbebbf323b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ade5f691577b3655ddf63dcbebbf323b2">◆ </a></span>defaultTimeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void zypp::PluginScript::defaultTimeout </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>newval_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set global default timeout (sec.) (both: send and receive). </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8h_source.html#l00093">93</a> of file <a class="el" href="PluginScript_8h_source.html">PluginScript.h</a>.</p>
</div>
</div>
<a id="ae2f0c12369a8c14828b935340f0db607"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2f0c12369a8c14828b935340f0db607">◆ </a></span>script()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> & zypp::PluginScript::script </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the script path if set. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00474">474</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="af32a99f2dccd5cbd6a8ac2f5945aa719"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af32a99f2dccd5cbd6a8ac2f5945aa719">◆ </a></span>args()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">PluginScript::Arguments</a> & zypp::PluginScript::args </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the script arguments if set. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00477">477</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="af0b2a0015fd0768adaa00942a26251cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0b2a0015fd0768adaa00942a26251cd">◆ </a></span>isOpen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbool.html">bool</a> zypp::PluginScript::isOpen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether we are connected to a script. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00480">480</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="acd27f49a38c1a5873b9eda276c59acc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd27f49a38c1a5873b9eda276c59acc7">◆ </a></span>getPid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">pid_t zypp::PluginScript::getPid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a connected scripts pid or <a class="el" href="classzypp_1_1PluginScript.html#a8d3df60072b20ef1fea0821af78944f4">NotConnected</a>. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00483">483</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a4705afb32d6695f05c9f86c5c79fc036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4705afb32d6695f05c9f86c5c79fc036">◆ </a></span>lastReturn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int zypp::PluginScript::lastReturn </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Remembers a scripts return value after <a class="el" href="classzypp_1_1PluginScript.html#a9b6093ffa8368f2731bd5297143e5e7d">close</a> until next <a class="el" href="classzypp_1_1PluginScript.html#ad93e8078dee37f33e003fc3be9f61e05">open</a>. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00486">486</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a9c8614617f570f7e5451334f4baee4ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c8614617f570f7e5451334f4baee4ec">◆ </a></span>lastExecError()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string & zypp::PluginScript::lastExecError </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Remembers a scripts execError string after <a class="el" href="classzypp_1_1PluginScript.html#a9b6093ffa8368f2731bd5297143e5e7d">close</a> until next <a class="el" href="classzypp_1_1PluginScript.html#ad93e8078dee37f33e003fc3be9f61e05">open</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classzypp_1_1ExternalProgram.html#a018285fba95217aac0581a5d4c6a486a">ExternalProgram::execError</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00489">489</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a21c04ff49898bb0d14c062c317cf41ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21c04ff49898bb0d14c062c317cf41ca">◆ </a></span>sendTimeout() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long zypp::PluginScript::sendTimeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Local default timeout (sec.) when sending data. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00450">450</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="af1fd70d587ecd63c33d5e0a266adfb3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1fd70d587ecd63c33d5e0a266adfb3c">◆ </a></span>receiveTimeout() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long zypp::PluginScript::receiveTimeout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Local default timeout (sec.) when receiving data. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00453">453</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="aeb4955b9b9afe5893a97c5d1707cec27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb4955b9b9afe5893a97c5d1707cec27">◆ </a></span>sendTimeout() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::sendTimeout </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>newval_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set local default timeout (sec.) when sending data. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00456">456</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="ad57e20b7b04d7fcb62e477f3259827a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad57e20b7b04d7fcb62e477f3259827a6">◆ </a></span>receiveTimeout() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::receiveTimeout </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>newval_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set local default timeout (sec.) when receiving data. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00459">459</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="aa13d73fbe70aa0d60ea2ff51d6ef2e7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa13d73fbe70aa0d60ea2ff51d6ef2e7b">◆ </a></span>timeout()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::timeout </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>newval_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set local default timeout (sec.) (both: send and receive). </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8h_source.html#l00144">144</a> of file <a class="el" href="PluginScript_8h_source.html">PluginScript.h</a>.</p>
</div>
</div>
<a id="ad93e8078dee37f33e003fc3be9f61e05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad93e8078dee37f33e003fc3be9f61e05">◆ </a></span>open() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::open </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setup connection and execute script. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classzypp_1_1PluginScriptException.html" title="Base class for PluginScript Exception.">PluginScriptException</a></td><td>if already connected to a script </td></tr>
<tr><td class="paramname"><a class="el" href="classzypp_1_1PluginScriptException.html" title="Base class for PluginScript Exception.">PluginScriptException</a></td><td>if script does not exist or is not executable </td></tr>
<tr><td class="paramname"><a class="el" href="classzypp_1_1PluginScriptException.html" title="Base class for PluginScript Exception.">PluginScriptException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00492">492</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a64d990ad0b5c3be7dd28cd75577afe4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64d990ad0b5c3be7dd28cd75577afe4b">◆ </a></span>open() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::open </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> & </td>
<td class="paramname"><em>script_r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00495">495</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="ae0e70f48a59acec606c0f7ab147e8ecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0e70f48a59acec606c0f7ab147e8ecd">◆ </a></span>open() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::open </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classzypp_1_1filesystem_1_1Pathname.html">Pathname</a> & </td>
<td class="paramname"><em>script_r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classzypp_1_1PluginScript.html#a42522c153b0e2d1ec258845008477dd7">Arguments</a> & </td>
<td class="paramname"><em>args_r</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00498">498</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a9b6093ffa8368f2731bd5297143e5e7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b6093ffa8368f2731bd5297143e5e7d">◆ </a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int zypp::PluginScript::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close any open connection. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00501">501</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a23313d5bb29823d87ea7ac63eeee95ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23313d5bb29823d87ea7ac63eeee95ba">◆ </a></span>send()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void zypp::PluginScript::send </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classzypp_1_1PluginFrame.html">PluginFrame</a> & </td>
<td class="paramname"><em>frame_r</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a <a class="el" href="classzypp_1_1PluginFrame.html">PluginFrame</a>. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">PluginScriptNotConnected</td><td></td></tr>
<tr><td class="paramname">PluginScriptSendTimeout</td><td></td></tr>
<tr><td class="paramname">PluginScriptDiedUnexpectedly</td><td>(does not <a class="el" href="classzypp_1_1PluginScript.html#a9b6093ffa8368f2731bd5297143e5e7d">close</a>) </td></tr>
<tr><td class="paramname"><a class="el" href="classzypp_1_1PluginScriptException.html" title="Base class for PluginScript Exception.">PluginScriptException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00504">504</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a066fd4185d38ea5bbcb2627ab6615ee4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a066fd4185d38ea5bbcb2627ab6615ee4">◆ </a></span>receive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classzypp_1_1PluginFrame.html">PluginFrame</a> zypp::PluginScript::receive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Receive a <a class="el" href="classzypp_1_1PluginFrame.html">PluginFrame</a>. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">PluginScriptNotConnected</td><td></td></tr>
<tr><td class="paramname">PluginScriptReceiveTimeout</td><td></td></tr>
<tr><td class="paramname">PluginScriptDiedUnexpectedly</td><td>(does not <a class="el" href="classzypp_1_1PluginScript.html#a9b6093ffa8368f2731bd5297143e5e7d">close</a>) </td></tr>
<tr><td class="paramname"><a class="el" href="classzypp_1_1PluginScriptException.html" title="Base class for PluginScript Exception.">PluginScriptException</a></td><td>on error </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00507">507</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="aa8d45ebfcd32c5980d3b21643054a813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8d45ebfcd32c5980d3b21643054a813">◆ </a></span>operator<< <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream& operator<< </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classzypp_1_1PluginScript.html">PluginScript</a> & </td>
<td class="paramname"><em>obj</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00512">512</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<a id="a14388da39089aeb024325b0c18144767"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14388da39089aeb024325b0c18144767">◆ </a></span>operator<<() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream & operator<< </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classzypp_1_1PluginScript.html">PluginScript</a> & </td>
<td class="paramname"><em>obj</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stream output </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8cc_source.html#l00512">512</a> of file <a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8d3df60072b20ef1fea0821af78944f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d3df60072b20ef1fea0821af78944f4">◆ </a></span>NotConnected</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const pid_t zypp::PluginScript::NotConnected</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><code>pid_t</code>(-1) constant indicating no connection. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8h_source.html#l00071">71</a> of file <a class="el" href="PluginScript_8h_source.html">PluginScript.h</a>.</p>
</div>
</div>
<a id="a3c592916dbe159e013b555a86b1c001e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c592916dbe159e013b555a86b1c001e">◆ </a></span>_pimpl</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structzypp_1_1RW__pointer.html">RW_pointer</a><<a class="el" href="structzypp_1_1PluginScript_1_1Impl.html">Impl</a>> zypp::PluginScript::_pimpl</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to implementation. </p>
<p class="definition">Definition at line <a class="el" href="PluginScript_8h_source.html#l00185">185</a> of file <a class="el" href="PluginScript_8h_source.html">PluginScript.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>zypp/<a class="el" href="PluginScript_8h_source.html">PluginScript.h</a></li>
<li>zypp/<a class="el" href="PluginScript_8cc_source.html">PluginScript.cc</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacezypp.html">zypp</a></li><li class="navelem"><a class="el" href="classzypp_1_1PluginScript.html">PluginScript</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
68c0c2ff89d8bf9051ff1b9773ed48e4
>
files
>
4172
