Stomp
inspired communication protocol.
More...
#include <PluginScript.h>
Classes | |
struct | Impl |
PluginScript implementation. More... | |
Public Types | |
typedef std::vector< std::string > | Arguments |
Commandline arguments passed to a script on open. | |
Public Member Functions | |
PluginScript () | |
Default ctor. | |
PluginScript (const Pathname &script_r) | |
Ctor taking script path and no arguments. | |
PluginScript (const Pathname &script_r, const Arguments &args_r) | |
Ctor taking script path and script arguments. | |
const Pathname & | script () const |
Return the script path if set. | |
const Arguments & | args () const |
Return the script arguments if set. | |
bool | isOpen () const |
Whether we are connected to a script. | |
pid_t | getPid () const |
Return a connected scripts pid or NotConnected. | |
int | lastReturn () const |
Remembers a scripts return value after close until next open. | |
const std::string & | lastExecError () const |
Remembers a scripts execError string after close until next open. | |
void | open () |
Setup connection and execute script. | |
void | open (const Pathname &script_r) |
void | open (const Pathname &script_r, const Arguments &args_r) |
int | close () |
Close any open connection. | |
void | send (const PluginFrame &frame_r) const |
Send a PluginFrame. | |
PluginFrame | receive () const |
Receive a PluginFrame. | |
Static Public Attributes | |
static const pid_t | NotConnected |
pid_t (-1) constant indicating no connection. | |
Private Attributes | |
RW_pointer< Impl > | _pimpl |
Pointer to implementation. | |
Friends | |
std::ostream & | operator<< (std::ostream &str, const PluginScript &obj) |
Stomp
inspired communication protocol.
ZYPP_PLUGIN_SEND_TIMEOUT
, ZYPP_PLUGIN_RECEIVE_TIMEOUT
or ZYPP_PLUGIN_TIMEOUT
(both: send and receive).
// Setup comnnection to plugin script PluginScript scr; PluginScript::Arguments args; args.push_back( "-v" ); scr.open( "/soem/testplugin", args ); // send frame to plugin PluginFrame f( "COMMAND" ); f.setHeader( "key", "value" ); f.setBody( "some\ndata" ); scr.send( f ); // receive frame from plugin PluginFrame r( scr.receive() ); // explicitly close or let PluginScript go out of scope scr.close();
Definition at line 62 of file PluginScript.h.
typedef std::vector<std::string> zypp::PluginScript::Arguments |
zypp::PluginScript::PluginScript | ( | ) |
zypp::PluginScript::PluginScript | ( | const Pathname & | script_r | ) |
zypp::PluginScript::PluginScript | ( | const Pathname & | script_r, | |
const Arguments & | args_r | |||
) |
const Pathname & zypp::PluginScript::script | ( | ) | const |
const PluginScript::Arguments & zypp::PluginScript::args | ( | ) | const |
Return the script arguments if set.
Definition at line 427 of file PluginScript.cc.
References _pimpl.
bool zypp::PluginScript::isOpen | ( | ) | const |
Whether we are connected to a script.
Definition at line 430 of file PluginScript.cc.
References _pimpl.
pid_t zypp::PluginScript::getPid | ( | ) | const |
Return a connected scripts pid or NotConnected.
Definition at line 433 of file PluginScript.cc.
References _pimpl.
int zypp::PluginScript::lastReturn | ( | ) | const |
Remembers a scripts return value after close until next open.
Definition at line 436 of file PluginScript.cc.
References _pimpl.
const std::string & zypp::PluginScript::lastExecError | ( | ) | const |
Remembers a scripts execError string after close until next open.
Definition at line 439 of file PluginScript.cc.
References _pimpl.
void zypp::PluginScript::open | ( | ) |
Setup connection and execute script.
PluginScriptException | if already connected to a script | |
PluginScriptException | if script does not exist or is not executable | |
PluginScriptException | on error |
Definition at line 442 of file PluginScript.cc.
References _pimpl.
Referenced by zypp::target::TargetImpl::buildCache(), and zypp::media::UrlResolverPlugin::resolveUrl().
void zypp::PluginScript::open | ( | const Pathname & | script_r | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 445 of file PluginScript.cc.
References _pimpl.
void zypp::PluginScript::open | ( | const Pathname & | script_r, | |
const Arguments & | args_r | |||
) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 448 of file PluginScript.cc.
References _pimpl.
int zypp::PluginScript::close | ( | ) |
void zypp::PluginScript::send | ( | const PluginFrame & | frame_r | ) | const |
Send a PluginFrame.
PluginScriptNotConnected | ||
PluginScriptSendTimeout | ||
PluginScriptDiedUnexpectedly | (does not close) | |
PluginScriptException | on error |
Definition at line 454 of file PluginScript.cc.
References _pimpl.
Referenced by zypp::target::TargetImpl::buildCache(), and zypp::media::UrlResolverPlugin::resolveUrl().
PluginFrame zypp::PluginScript::receive | ( | ) | const |
Receive a PluginFrame.
PluginScriptNotConnected | ||
PluginScriptReceiveTimeout | ||
PluginScriptDiedUnexpectedly | (does not close) | |
PluginScriptException | on error |
Definition at line 457 of file PluginScript.cc.
References _pimpl.
Referenced by zypp::target::TargetImpl::buildCache(), and zypp::media::UrlResolverPlugin::resolveUrl().
std::ostream & operator<< | ( | std::ostream & | str, | |
const PluginScript & | obj | |||
) | [friend] |
Stream output
Definition at line 462 of file PluginScript.cc.
const pid_t zypp::PluginScript::NotConnected [static] |
pid_t
(-1) constant indicating no connection.
Definition at line 71 of file PluginScript.h.
Referenced by zypp::PluginScript::Impl::getPid().
RW_pointer<Impl> zypp::PluginScript::_pimpl [private] |
Pointer to implementation.
Definition at line 141 of file PluginScript.h.
Referenced by args(), close(), getPid(), isOpen(), lastExecError(), lastReturn(), open(), zypp::operator<<(), receive(), script(), and send().