libfilezilla
Loading...
Searching...
No Matches
process.hpp
Go to the documentation of this file.
1#ifndef LIBFILEZILLA_PROCESS_HEADER
2#define LIBFILEZILLA_PROCESS_HEADER
3
4#include "libfilezilla.hpp"
5#include "fsresult.hpp"
6#include "event.hpp"
7#include "time.hpp"
8
13#include <vector>
14
15namespace fz {
16class event_handler;
17class impersonation_token;
18class thread_pool;
19
20
26{
28 read = 0x1,
29
31 write = 0x2,
32};
33
35struct process_event_type;
36
37class process;
38
53
60class FZ_PUBLIC_SYMBOL process final
61{
62public:
65
70 process(thread_pool & pool, event_handler & handler);
71
74 process(process const&) = delete;
75 process& operator=(process const&) = delete;
76
78 enum class io_redirection {
80 redirect,
81
83 none,
84
86 closeall,
87
89 redirect_except_stderr
90 };
91
105 bool spawn(native_string const& cmd, std::vector<native_string> const& args = std::vector<native_string>(), io_redirection redirect_mode = io_redirection::redirect);
106
107 bool spawn(std::vector<native_string> const& command_with_args, io_redirection redirect_mode = io_redirection::redirect);
108
109#if FZ_WINDOWS || FZ_UNIX
111 bool spawn(impersonation_token const& it, native_string const& cmd, std::vector<native_string> const& args, io_redirection redirect_mode = io_redirection::redirect);
112#endif
113
114#ifndef FZ_WINDOWS
121 bool spawn(native_string const& cmd, std::vector<native_string> const& args, std::vector<int> const& extra_fds, io_redirection redirect_mode = io_redirection::redirect);
122
123 bool spawn(impersonation_token const& it, native_string const& cmd, std::vector<native_string> const& args, std::vector<int> const& extra_fds, io_redirection redirect_mode = io_redirection::redirect);
124#endif
125
131 void kill();
132
145 bool stop(duration const& timeout = {});
146
155 rwresult read(void* buffer, size_t len);
156
164 rwresult write(void const* buffer, size_t len);
165
166 inline rwresult write(std::string_view const& s) {
167 return write(s.data(), s.size());
168 }
169
170#if FZ_WINDOWS
174 void* handle() const;
175#endif
176
177private:
178 class impl;
179 impl* impl_;
180};
181
182
191bool FZ_PUBLIC_SYMBOL spawn_detached_process(std::vector<native_string> const& cmd_with_args);
192
193#if !FZ_WINDOWS
203class FZ_PUBLIC_SYMBOL forkblock final
204{
205public:
206 forkblock();
207 ~forkblock();
208
209 forkblock(forkblock const&) = delete;
210 forkblock& operator=(forkblock const&) = delete;
211};
212#endif
213
214}
215
216#endif
The buffer class is a simple buffer where data can be appended at the end and consumed at the front....
Definition buffer.hpp:27
The duration class represents a time interval in milliseconds.
Definition time.hpp:291
Simple handler for asynchronous event processing.
Definition event_handler.hpp:55
Impersonation tokens for a given user can be used to spawn processes running as that user.
Definition impersonation.hpp:33
The process class manages an asynchronous process with redirected IO.
Definition process.hpp:61
rwresult write(void const *buffer, size_t len)
Write data data process.
process(thread_pool &pool, event_handler &handler)
Creates instance with non-blocking event-based redirected communication.
void * handle() const
Returns the HANDLE of the process.
rwresult read(void *buffer, size_t len)
Read data from process.
bool spawn(native_string const &cmd, std::vector< native_string > const &args=std::vector< native_string >(), io_redirection redirect_mode=io_redirection::redirect)
Start the process.
process()
Creates instance for blocking I/O.
~process()
If process still running, calls process::kill()
bool stop(duration const &timeout={})
Stops the spawned process.
io_redirection
IO redirection modes.
Definition process.hpp:78
bool spawn(impersonation_token const &it, native_string const &cmd, std::vector< native_string > const &args, io_redirection redirect_mode=io_redirection::redirect)
Creates a process running under the user represented by the impersonation token.
Holds the result of read/write operations.
Definition fsresult.hpp:77
This is the recommended event class.
Definition event.hpp:68
A dumb thread-pool for asynchronous tasks.
Definition thread_pool.hpp:64
Declares event_base and simple_event<>
fz::result and fz::rwresult wrappers for dealing with file system errors.
Sets some global macros and further includes string.hpp.
The namespace used by libfilezilla.
Definition apply.hpp:17
simple_event< process_event_type, process *, process_event_flag > process_event
Definition process.hpp:52
std::wstring native_string
A string in the system's native character type and encoding. Note: This typedef changes depending on...
Definition string.hpp:34
bool spawn_detached_process(std::vector< native_string > const &cmd_with_args)
Starts a detached process.
process_event_flag
The type of a process event.
Definition process.hpp:26
@ read
Data has become available.
@ write
data can be written.
Assorted classes dealing with time.