libzypp  17.8.0
zypp::PluginScript Class Reference

Interface to plugin scripts using a 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. More...
 

Public Member Functions

 PluginScript ()
 Default ctor. More...
 
 PluginScript (const Pathname &script_r)
 Ctor taking script path and no arguments. More...
 
 PluginScript (const Pathname &script_r, const Arguments &args_r)
 Ctor taking script path and script arguments. More...
 
const Pathnamescript () const
 Return the script path if set. More...
 
const Argumentsargs () const
 Return the script arguments if set. More...
 
bool isOpen () const
 Whether we are connected to a script. More...
 
pid_t getPid () const
 Return a connected scripts pid or NotConnected. More...
 
int lastReturn () const
 Remembers a scripts return value after close until next open. More...
 
const std::string & lastExecError () const
 Remembers a scripts execError string after close until next open. More...
 
void open ()
 Setup connection and execute script. More...
 
void open (const Pathname &script_r)
 
void open (const Pathname &script_r, const Arguments &args_r)
 
int close ()
 Close any open connection. More...
 
void send (const PluginFrame &frame_r) const
 Send a PluginFrame. More...
 
PluginFrame receive () const
 Receive a PluginFrame. More...
 
Get/set local timeout settings.
long sendTimeout () const
 Local default timeout (sec.) when sending data. More...
 
long receiveTimeout () const
 Local default timeout (sec.) when receiving data. More...
 
void sendTimeout (long newval_r)
 Set local default timeout (sec.) when sending data. More...
 
void receiveTimeout (long newval_r)
 Set local default timeout (sec.) when receiving data. More...
 
void timeout (long newval_r)
 Set local default timeout (sec.) (both: send and receive). More...
 

Static Public Member Functions

Get/set the global timeout settings.

Timeout when sending/receiving data to/from a plugin default to 30 sec.

The value (in seconds) my be changed via the environment variables ZYPP_PLUGIN_SEND_TIMEOUT, ZYPP_PLUGIN_RECEIVE_TIMEOUT or ZYPP_PLUGIN_TIMEOUT (both: send and receive).

static long defaultSendTimeout ()
 Global default timeout (sec.) when sending data. More...
 
static long defaultReceiveTimeout ()
 Global default timeout (sec.) when receiving data. More...
 
static void defaultSendTimeout (long newval_r)
 Set global default timeout (sec.) when sending data. More...
 
static void defaultReceiveTimeout (long newval_r)
 Set global default timeout (sec.) when receiving data. More...
 
static void defaultTimeout (long newval_r)
 Set global default timeout (sec.) (both: send and receive). More...
 

Static Public Attributes

static const pid_t NotConnected
 pid_t(-1) constant indicating no connection. More...
 

Private Attributes

RW_pointer< Impl_pimpl
 Pointer to implementation. More...
 

Friends

std::ostream & operator<< (std::ostream &str, const PluginScript &obj)
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &str, const PluginScript &obj)
 

Detailed Description

Interface to plugin scripts using a Stomp inspired communication protocol.

Note
PluginScript is copyable and assignable, but the connection is shared among multiple copies. It gets automatically closed if the last copy goes out of scope.

Timeout when sending/receiving data to/from a plugin default to 30 sec. The value (in seconds) my be changed via the environment variables ZYPP_PLUGIN_SEND_TIMEOUT, ZYPP_PLUGIN_RECEIVE_TIMEOUT or ZYPP_PLUGIN_TIMEOUT (both: send and receive).

// Setup comnnection to plugin script
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();
See also
http://stomp.codehaus.org/

Definition at line 62 of file PluginScript.h.

Member Typedef Documentation

◆ Arguments

typedef std::vector<std::string> zypp::PluginScript::Arguments

Commandline arguments passed to a script on open.

Definition at line 68 of file PluginScript.h.

Constructor & Destructor Documentation

◆ PluginScript() [1/3]

zypp::PluginScript::PluginScript ( )

Default ctor.

Definition at line 462 of file PluginScript.cc.

◆ PluginScript() [2/3]

zypp::PluginScript::PluginScript ( const Pathname script_r)

Ctor taking script path and no arguments.

Definition at line 466 of file PluginScript.cc.

◆ PluginScript() [3/3]

zypp::PluginScript::PluginScript ( const Pathname script_r,
const Arguments args_r 
)

Ctor taking script path and script arguments.

Definition at line 470 of file PluginScript.cc.

Member Function Documentation

◆ defaultSendTimeout() [1/2]

long zypp::PluginScript::defaultSendTimeout ( )
static

Global default timeout (sec.) when sending data.

Definition at line 438 of file PluginScript.cc.

◆ defaultReceiveTimeout() [1/2]

long zypp::PluginScript::defaultReceiveTimeout ( )
static

Global default timeout (sec.) when receiving data.

Definition at line 441 of file PluginScript.cc.

◆ defaultSendTimeout() [2/2]

void zypp::PluginScript::defaultSendTimeout ( long  newval_r)
static

Set global default timeout (sec.) when sending data.

Definition at line 444 of file PluginScript.cc.

◆ defaultReceiveTimeout() [2/2]

void zypp::PluginScript::defaultReceiveTimeout ( long  newval_r)
static

Set global default timeout (sec.) when receiving data.

Definition at line 447 of file PluginScript.cc.

◆ defaultTimeout()

static void zypp::PluginScript::defaultTimeout ( long  newval_r)
inlinestatic

Set global default timeout (sec.) (both: send and receive).

Definition at line 93 of file PluginScript.h.

◆ script()

const Pathname & zypp::PluginScript::script ( ) const

Return the script path if set.

Definition at line 474 of file PluginScript.cc.

◆ args()

const PluginScript::Arguments & zypp::PluginScript::args ( ) const

Return the script arguments if set.

Definition at line 477 of file PluginScript.cc.

◆ isOpen()

bool zypp::PluginScript::isOpen ( ) const

Whether we are connected to a script.

Definition at line 480 of file PluginScript.cc.

◆ getPid()

pid_t zypp::PluginScript::getPid ( ) const

Return a connected scripts pid or NotConnected.

Definition at line 483 of file PluginScript.cc.

◆ lastReturn()

int zypp::PluginScript::lastReturn ( ) const

Remembers a scripts return value after close until next open.

Definition at line 486 of file PluginScript.cc.

◆ lastExecError()

const std::string & zypp::PluginScript::lastExecError ( ) const

Remembers a scripts execError string after close until next open.

See also
ExternalProgram::execError.

Definition at line 489 of file PluginScript.cc.

◆ sendTimeout() [1/2]

long zypp::PluginScript::sendTimeout ( ) const

Local default timeout (sec.) when sending data.

Definition at line 450 of file PluginScript.cc.

◆ receiveTimeout() [1/2]

long zypp::PluginScript::receiveTimeout ( ) const

Local default timeout (sec.) when receiving data.

Definition at line 453 of file PluginScript.cc.

◆ sendTimeout() [2/2]

void zypp::PluginScript::sendTimeout ( long  newval_r)

Set local default timeout (sec.) when sending data.

Definition at line 456 of file PluginScript.cc.

◆ receiveTimeout() [2/2]

void zypp::PluginScript::receiveTimeout ( long  newval_r)

Set local default timeout (sec.) when receiving data.

Definition at line 459 of file PluginScript.cc.

◆ timeout()

void zypp::PluginScript::timeout ( long  newval_r)
inline

Set local default timeout (sec.) (both: send and receive).

Definition at line 144 of file PluginScript.h.

◆ open() [1/3]

void zypp::PluginScript::open ( )

Setup connection and execute script.

Exceptions
PluginScriptExceptionif already connected to a script
PluginScriptExceptionif script does not exist or is not executable
PluginScriptExceptionon error

Definition at line 492 of file PluginScript.cc.

◆ open() [2/3]

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 495 of file PluginScript.cc.

◆ open() [3/3]

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 498 of file PluginScript.cc.

◆ close()

int zypp::PluginScript::close ( )

Close any open connection.

Definition at line 501 of file PluginScript.cc.

◆ send()

void zypp::PluginScript::send ( const PluginFrame frame_r) const

Send a PluginFrame.

Exceptions
PluginScriptNotConnected
PluginScriptSendTimeout
PluginScriptDiedUnexpectedly(does not close)
PluginScriptExceptionon error

Definition at line 504 of file PluginScript.cc.

◆ receive()

PluginFrame zypp::PluginScript::receive ( ) const

Receive a PluginFrame.

Exceptions
PluginScriptNotConnected
PluginScriptReceiveTimeout
PluginScriptDiedUnexpectedly(does not close)
PluginScriptExceptionon error

Definition at line 507 of file PluginScript.cc.

Friends And Related Function Documentation

◆ operator<< [1/2]

std::ostream& operator<< ( std::ostream &  str,
const PluginScript obj 
)
friend

Definition at line 512 of file PluginScript.cc.

◆ operator<<() [2/2]

std::ostream & operator<< ( std::ostream &  str,
const PluginScript obj 
)
related

Stream output

Definition at line 512 of file PluginScript.cc.

Member Data Documentation

◆ NotConnected

const pid_t zypp::PluginScript::NotConnected
static

pid_t(-1) constant indicating no connection.

Definition at line 71 of file PluginScript.h.

◆ _pimpl

RW_pointer<Impl> zypp::PluginScript::_pimpl
private

Pointer to implementation.

Definition at line 185 of file PluginScript.h.


The documentation for this class was generated from the following files: