libzypp: zypp/PluginScript.h Source File

libzypp 17.25.10

PluginScript.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
12 #ifndef ZYPP_PLUGINSCRIPT_H
13 #define ZYPP_PLUGINSCRIPT_H
14
15 #include <iosfwd>
16 #include <string>
17 #include <vector>
18
19 #include <zypp/base/PtrTypes.h>
20 #include <zypp/Pathname.h>
21
22 #include <zypp/PluginFrame.h>
23 #include <zypp/PluginScriptException.h>
24
26 namespace zypp
27 {
28
62 class PluginScript
63 {
64 friend std::ostream & operator<<( std::ostream & str, const PluginScript & obj );
65
66 public:
68 typedef std::vector<std::string> Arguments;
69
71 static const pid_t NotConnected;
72
73 public:
81 static long defaultSendTimeout();
82
84 static long defaultReceiveTimeout();
85
87 static void defaultSendTimeout( long newval_r );
88
90 static void defaultReceiveTimeout( long newval_r );
91
93 static void defaultTimeout( long newval_r )
94 { defaultSendTimeout( newval_r ); defaultReceiveTimeout( newval_r ); }
96
97 public:
99 PluginScript();
100
102 PluginScript( const Pathname & script_r );
103
105 PluginScript( const Pathname & script_r, const Arguments & args_r );
106
107 public:
109 const Pathname & script() const;
110
112 const Arguments & args() const;
113
115 bool isOpen() const;
116
118 pid_t getPid() const;
119
121 int lastReturn() const;
122
126 const std::string & lastExecError() const;
127
128 public:
132 long sendTimeout() const;
133
135 long receiveTimeout() const;
136
138 void sendTimeout( long newval_r );
139
141 void receiveTimeout( long newval_r );
142
144 void timeout( long newval_r )
145 { sendTimeout( newval_r ); receiveTimeout( newval_r ); }
147
148 public:
154 void open();
155
157 void open( const Pathname & script_r );
158
160 void open( const Pathname & script_r, const Arguments & args_r );
161
163 int close();
164
165 public:
173 void send( const PluginFrame & frame_r ) const;
174
181 PluginFrame receive() const;
182
183 public:
185 struct Impl;
186 private:
188 RW_pointer<Impl> _pimpl;
189 };
190
192 std::ostream & operator<<( std::ostream & str, const PluginScript & obj );
193
195 } // namespace zypp
197 #endif // ZYPP_PLUGINSCRIPT_H
Pathname.h
PluginFrame.h
PluginScriptException.h
PtrTypes.h
Impl
zypp::PluginFrame
Command frame for communication with PluginScript.
Definition: PluginFrame.h:41
zypp::PluginScript
Interface to plugin scripts using a Stomp inspired communication protocol.
Definition: PluginScript.h:63
zypp::PluginScript::receive
PluginFrame receive() const
Receive a PluginFrame.
Definition: PluginScript.cc:507
zypp::PluginScript::sendTimeout
long sendTimeout() const
Local default timeout (sec.) when sending data.
Definition: PluginScript.cc:450
zypp::PluginScript::send
void send(const PluginFrame &frame_r) const
Send a PluginFrame.
Definition: PluginScript.cc:504
zypp::PluginScript::PluginScript
PluginScript()
Default ctor.
Definition: PluginScript.cc:462
zypp::PluginScript::_pimpl
RW_pointer< Impl > _pimpl
Pointer to implementation.
Definition: PluginScript.h:185
zypp::PluginScript::Arguments
std::vector< std::string > Arguments
Commandline arguments passed to a script on open.
Definition: PluginScript.h:68
zypp::PluginScript::lastReturn
int lastReturn() const
Remembers a scripts return value after close until next open.
Definition: PluginScript.cc:486
zypp::PluginScript::defaultReceiveTimeout
static long defaultReceiveTimeout()
Global default timeout (sec.) when receiving data.
Definition: PluginScript.cc:441
zypp::PluginScript::NotConnected
static const pid_t NotConnected
pid_t(-1) constant indicating no connection.
Definition: PluginScript.h:71
zypp::PluginScript::close
int close()
Close any open connection.
Definition: PluginScript.cc:501
zypp::PluginScript::lastExecError
const std::string & lastExecError() const
Remembers a scripts execError string after close until next open.
Definition: PluginScript.cc:489
zypp::PluginScript::timeout
void timeout(long newval_r)
Set local default timeout (sec.) (both: send and receive).
Definition: PluginScript.h:144
zypp::PluginScript::operator<<
friend std::ostream & operator<<(std::ostream &str, const PluginScript &obj)
Definition: PluginScript.cc:512
zypp::PluginScript::getPid
pid_t getPid() const
Return a connected scripts pid or NotConnected.
Definition: PluginScript.cc:483
zypp::PluginScript::open
void open()
Setup connection and execute script.
Definition: PluginScript.cc:492
zypp::PluginScript::defaultTimeout
static void defaultTimeout(long newval_r)
Set global default timeout (sec.) (both: send and receive).
Definition: PluginScript.h:93
zypp::PluginScript::script
const Pathname & script() const
Return the script path if set.
Definition: PluginScript.cc:474
zypp::PluginScript::defaultSendTimeout
static long defaultSendTimeout()
Global default timeout (sec.) when sending data.
Definition: PluginScript.cc:438
zypp::PluginScript::isOpen
bool isOpen() const
Whether we are connected to a script.
Definition: PluginScript.cc:480
zypp::PluginScript::receiveTimeout
long receiveTimeout() const
Local default timeout (sec.) when receiving data.
Definition: PluginScript.cc:453
zypp::PluginScript::args
const Arguments & args() const
Return the script arguments if set.
Definition: PluginScript.cc:477
zypp::filesystem::Pathname
Pathname.
Definition: Pathname.h:45
str
String related utilities and Regular expression matching.
zypp
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:2
zypp::operator<<
std::ostream & operator<<(std::ostream &str, const Exception &obj)
Definition: Exception.cc:147
zypp::RW_pointer
Wrapper for const correct access via Smart pointer types.
Definition: PtrTypes.h:286