SC::AsyncProcessExit Struct Reference

Starts monitoring a process, notifying about its termination. More...

#include <Async.h>

Inheritance diagram for SC::AsyncProcessExit:

Classes
struct	CompletionData
struct	Result

Public Member Functions
SC::Result	start (AsyncEventLoop &eventLoop, FileDescriptor::Handle process)
	Sets async request members and calls AsyncEventLoop::start.
Result	start (AsyncEventLoop &eventLoop)
	Shortcut for AsyncEventLoop::start.
Public Member Functions inherited from SC::AsyncRequest
void	setDebugName (const char *newDebugName)
void	executeOn (AsyncSequence &sequence)
	Adds the request to be executed on a specific AsyncSequence.
Result	executeOn (AsyncTaskSequence &task, ThreadPool &pool)
	Adds the request to be executed on a specific AsyncTaskSequence.
void	disableThreadPool ()
	Disables the thread-pool usage for this request.
	AsyncRequest (Type type)
	Constructs a free async request of given type.
Result	stop (AsyncEventLoop &eventLoop, Function< void(AsyncResult &)> *afterStopped=nullptr)
	Ask to stop current async operation.
bool	isFree () const
	Returns true if this request is free.
bool	isCancelling () const
	Returns true if this request is being cancelled.
bool	isActive () const
	Returns true if this request is active or being reactivated.
Type	getType () const
	Returns request type.
Result	start (AsyncEventLoop &eventLoop)
	Shortcut for AsyncEventLoop::start.
void	setUserFlags (uint16_t externalFlags)
	Sets user flags, holding some meaningful data for the caller.
uint16_t	getUserFlags () const
	Gets user flags, holding some meaningful data for the caller.
Function< void(AsyncResult &)> *	getCloseCallback ()
	Returns currently set close callback (if any) passed to AsyncRequest::stop.
const Function< void(AsyncResult &)> *	getCloseCallback () const

Public Attributes
Function< void(Result &)>	callback
	Called when process has exited.
Public Attributes inherited from SC::AsyncRequest
AsyncRequest *	next = nullptr
AsyncRequest *	prev = nullptr

Friends
struct	AsyncEventLoop

Additional Inherited Members
Public Types inherited from SC::AsyncRequest
enum class	Type : uint8_t {   LoopTimeout ,   LoopWakeUp ,   LoopWork ,   ProcessExit ,   SocketAccept ,   SocketConnect ,   SocketSend ,   SocketSendTo ,   SocketReceive ,   SocketReceiveFrom ,   FileRead ,   FileWrite ,   FilePoll ,   FileSystemOperation }
	Type of async request. More...
Protected Member Functions inherited from SC::AsyncRequest
Result	checkState ()
void	queueSubmission (AsyncEventLoop &eventLoop)
AsyncTaskSequence *	getTask ()
Protected Attributes inherited from SC::AsyncRequest
AsyncSequence *	sequence = nullptr

Detailed Description

Starts monitoring a process, notifying about its termination.

Process library can be used to start a process and obtain the native process handle.

// Assuming an already created (and running) AsyncEventLoop named eventLoop
// ...
Process process;
SC_TRY(process.launch({"executable", "--parameter"}));
AsyncProcessExit processExit; //  Memory lifetime must be valid until callback is called
processExit.callback = [&](AsyncProcessExit::Result& res)
{
    int exitStatus = -1;
    if(res.get(exitStatus))
    {
        console.print("Process Exit status = {}", exitStatus);
    }
};
SC_TRY(processExit.start(eventLoop, process.handle));

Member Function Documentation

start() [1/2]

Result SC::AsyncRequest::start

(

AsyncEventLoop &

eventLoop

)

Shortcut for AsyncEventLoop::start.

start() [2/2]

SC::Result SC::AsyncProcessExit::start	(	AsyncEventLoop &	eventLoop,
		FileDescriptor::Handle	process )

Sets async request members and calls AsyncEventLoop::start.

Note

Using FileDescriptor::Handle instead of ProcessDescriptor::Handle not to depend on Process library because their low-level native representation are the same.

Member Data Documentation

callback

Function<void(Result&)> SC::AsyncProcessExit::callback

Called when process has exited.

---

The documentation for this struct was generated from the following file:

• Async.h