efl_task/exe: Further update docs
This commit is contained in:
parent
bc0eeeb1ec
commit
f78b4861af
|
@ -15,7 +15,7 @@ enum @beta Efl.Exe_Signal {
|
|||
}
|
||||
|
||||
enum @beta Efl.Exe_Flags {
|
||||
[[Flags to customize task behavior.]] // TODO: This needs more detail.
|
||||
[[Flags to customize process behavior.]]
|
||||
none = 0, [[No special flags.]]
|
||||
group_leader = 1, [[Process will be executed in its own session.]]
|
||||
hide_io = 4 [[All console IO will be hidden.]]
|
||||
|
@ -23,20 +23,21 @@ enum @beta Efl.Exe_Flags {
|
|||
|
||||
class @beta Efl.Exe extends Efl.Task implements Efl.Io.Reader, Efl.Io.Writer, Efl.Io.Closer, Efl.Core.Command_Line
|
||||
{
|
||||
[[The Efl.Exe
|
||||
|
||||
Efl.Exe is a kind of specialized @Efl.Task which is a abstraction of process(task).
|
||||
This class provides a way to execute some commands with certain executing flags under certain environment variables.
|
||||
and also it can provides a way to manage signals to a process that it handles.]]
|
||||
[[This is a specialized @Efl.Task which abstracts an operating system process.
|
||||
This class provides a way to start a task by running an executable file (specified using the
|
||||
@Efl.Core.Command_Line interface) and further customize its execution flags (@.exe_flags) and
|
||||
environment variables (@.env).
|
||||
It also allows communicating with the process through signals (@.signal).
|
||||
]]
|
||||
methods {
|
||||
signal {
|
||||
[[Send a signal to this task.]]
|
||||
[[Send a signal to this process.]]
|
||||
params {
|
||||
sig: Efl.Exe_Signal; [[Signal number to send.]]
|
||||
}
|
||||
}
|
||||
@property exe_flags {
|
||||
[[Customize the task's behavior.]]
|
||||
[[Customize the process' behavior.]]
|
||||
set { }
|
||||
get { }
|
||||
values {
|
||||
|
@ -44,17 +45,17 @@ class @beta Efl.Exe extends Efl.Task implements Efl.Io.Reader, Efl.Io.Writer, Ef
|
|||
}
|
||||
}
|
||||
@property exit_signal {
|
||||
[[The final exit signal of this task.]]
|
||||
[[The signal this process emitted upon exiting, if any.]]
|
||||
get { }
|
||||
values {
|
||||
sig: int; [[The exit signal, or -1 if no exit signal happened.]]
|
||||
}
|
||||
}
|
||||
@property env {
|
||||
[[If $env is $null then the process created by this object is
|
||||
[[If $env is $NULL then the process created by this object is
|
||||
going to inherit the environment of this process.
|
||||
|
||||
In case $env is not $null then the environment variables declared
|
||||
In case $env is not $NULL then the environment variables declared
|
||||
in this object will represent the environment passed to the new process.
|
||||
]]
|
||||
get {
|
||||
|
|
|
@ -58,7 +58,7 @@ abstract Efl.Task extends Efl.Loop_Consumer
|
|||
}
|
||||
end @pure_virtual {
|
||||
[[Request the task end (may send a signal or interrupt
|
||||
signal resulting in a terminate event being tiggered in the
|
||||
signal resulting in a terminate event being triggered in the
|
||||
target task loop).]]
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue