Optionalproperties: Partial<Gio.Subprocess.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeCreates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Communicate with the subprocess until it terminates, and all input and output has been completed.
If stdin_buf is given, the subprocess must have been created with
Gio.SubprocessFlags.STDIN_PIPE. The given data is fed to the
stdin of the subprocess and the pipe is closed (ie: EOF).
At the same time (as not to cause blocking when dealing with large
amounts of data), if Gio.SubprocessFlags.STDOUT_PIPE or
Gio.SubprocessFlags.STDERR_PIPE were used, reads from those
streams. The data that was read is returned in stdout and/or
the stderr.
If the subprocess was created with Gio.SubprocessFlags.STDOUT_PIPE,
stdout_buf will contain the data read from stdout. Otherwise, for
subprocesses not created with Gio.SubprocessFlags.STDOUT_PIPE,
stdout_buf will be set to null. Similar provisions apply to
stderr_buf and Gio.SubprocessFlags.STDERR_PIPE.
As usual, any output variable may be given as null to ignore it.
If you desire the stdout and stderr data to be interleaved, create
the subprocess with Gio.SubprocessFlags.STDOUT_PIPE and
Gio.SubprocessFlags.STDERR_MERGE. The merged result will be returned
in stdout_buf and stderr_buf will be set to null.
In case of any error (including cancellation), false will be
returned with error set. Some or all of the stdin data may have
been written. Any stdout or stderr data that has been read will be
discarded. None of the out variables (aside from error) will have
been set to anything in particular and should not be inspected.
In the case that true is returned, the subprocess has exited and the
exit status inspection APIs (eg: g_subprocess_get_if_exited(),
g_subprocess_get_exit_status()) may be used.
You should not attempt to use any of the subprocess pipes after starting this function, since they may be left in strange states, even if the operation was cancelled. You should especially not attempt to interact with the pipes while the operation is in progress (either from another thread or if using the asynchronous version).
Optionalstdin_buf: GLib.Bytesdata to send to the stdin of the subprocess, or null
Optionalcancellable: Gio.Cancellabletrue if successful
Asynchronous version of g_subprocess_communicate(). Complete
invocation with g_subprocess_communicate_finish().
Input data, or null
Cancellable
Callback
Asynchronous version of g_subprocess_communicate(). Complete
invocation with g_subprocess_communicate_finish().
Optionalstdin_buf: GLib.BytesInput data, or null
Optionalcancellable: Gio.CancellableCancellable
Optionalcallback: AsyncReadyCallback<Gio.Subprocess>Callback
Like g_subprocess_communicate(), but validates the output of the
process as UTF-8, and returns it as a regular NUL terminated string.
On error, stdout_buf and stderr_buf will be set to undefined values and
should not be used.
data to send to the stdin of the subprocess, or null
Asynchronous version of g_subprocess_communicate_utf8(). Complete
invocation with g_subprocess_communicate_utf8_finish().
Optionalstdin_buf: stringInput data, or null
Optionalcancellable: Gio.CancellableCancellable
Asynchronous version of g_subprocess_communicate_utf8(). Complete
invocation with g_subprocess_communicate_utf8_finish().
Input data, or null
Cancellable
Callback
Asynchronous version of g_subprocess_communicate_utf8(). Complete
invocation with g_subprocess_communicate_utf8_finish().
Optionalstdin_buf: stringInput data, or null
Optionalcancellable: Gio.CancellableCancellable
Optionalcallback: AsyncReadyCallback<Gio.Subprocess>Callback
Complete an invocation of g_subprocess_communicate_utf8_async().
Result
SignalconnectSignalconnect_Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
SignalemitUse an operating-system specific method to attempt an immediate,
forceful termination of the process. There is no mechanism to
determine whether or not the request itself was successful;
however, you can use g_subprocess_wait() to monitor the status of
the process after calling this function.
On Unix, this function sends SIGKILL.
This function is intended for GObject.Object implementations to re-enforce
a [floating][floating-ref] object reference. Doing this is seldom
required: all GInitiallyUnowneds are created with a floating reference
which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
GObject.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Check the exit status of the subprocess, given that it exited
normally. This is the value passed to the exit() system call or the
return value from main.
This is equivalent to the system WEXITSTATUS macro.
It is an error to call this function before g_subprocess_wait() and
unless g_subprocess_get_if_exited() returned true.
the exit status
On UNIX, returns the process ID as a decimal string.
On Windows, returns the result of GetProcessId() also as a string.
If the subprocess has terminated, this will return null.
the subprocess identifier, or null if the subprocess has terminated
Check if the given subprocess exited normally (ie: by way of exit()
or return from main()).
This is equivalent to the system WIFEXITED macro.
It is an error to call this function before g_subprocess_wait() has
returned.
true if the case of a normal exit
Check if the given subprocess terminated in response to a signal.
This is equivalent to the system WIFSIGNALED macro.
It is an error to call this function before g_subprocess_wait() has
returned.
true if the case of termination due to a signal
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Gets the raw status code of the process, as from waitpid().
This value has no particular meaning, but it can be used with the
macros defined by the system headers such as WIFEXITED. It can also
be used with g_spawn_check_wait_status().
It is more likely that you want to use g_subprocess_get_if_exited()
followed by g_subprocess_get_exit_status().
It is an error to call this function before g_subprocess_wait() has
returned.
the (meaningless) waitpid() exit status from the kernel
Gets the Gio.InputStream from which to read the stderr output of
subprocess.
The process must have been created with Gio.SubprocessFlags.STDERR_PIPE,
otherwise null will be returned.
the stderr pipe
Gets the Gio.OutputStream that you can write to in order to give data
to the stdin of subprocess.
The process must have been created with Gio.SubprocessFlags.STDIN_PIPE and
not Gio.SubprocessFlags.STDIN_INHERIT, otherwise null will be returned.
the stdout pipe
Gets the Gio.InputStream from which to read the stdout output of
subprocess.
The process must have been created with Gio.SubprocessFlags.STDOUT_PIPE,
otherwise null will be returned.
the stdout pipe
Checks if the process was "successful". A process is considered
successful if it exited cleanly with an exit status of 0, either by
way of the exit() system call or return from main().
It is an error to call this function before g_subprocess_wait() has
returned.
true if the process exited cleanly with a exit status of 0
Get the signal number that caused the subprocess to terminate, given that it terminated due to a signal.
This is equivalent to the system WTERMSIG macro.
It is an error to call this function before g_subprocess_wait() and
unless g_subprocess_get_if_signaled() returned true.
the signal causing termination
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sends the UNIX signal signal_num to the subprocess, if it is still
running.
This API is race-free. If the subprocess has terminated, it will not be signalled.
This API is not available on Windows.
the signal number to send
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C,
g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial
construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not null,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
Gio.IOErrorEnum.CANCELLED will be returned. If cancellable is not null and
the object doesn't support cancellable initialization the error
Gio.IOErrorEnum.NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an
error, then all operations on the object except g_object_ref() and
g_object_unref() are considered to be invalid, and have undefined
behaviour. See the [description][iface@Gio.Initable#description] for more details.
Callers should not assume that a class which implements Gio.Initable can be
initialized multiple times, unless the class explicitly documents itself as
supporting this. Generally, a class’ implementation of init() can assume
(and assert) that it will only be called once. Previously, this documentation
recommended all Gio.Initable implementations should be idempotent; that
recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if
it is designed to be used via the singleton pattern, with a
GObject.ObjectClass.constructor that sometimes returns an existing instance.
In this pattern, a caller would expect to be able to call g_initable_init()
on the result of g_object_new(), regardless of whether it is in fact a new
instance.
Optionalcancellable: Gio.Cancellableoptional Gio.Cancellable object, null to ignore.
Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
Synchronously wait for the subprocess to terminate.
After the process terminates you can query its exit status with
functions such as g_subprocess_get_if_exited() and
g_subprocess_get_exit_status().
This function does not fail in the case of the subprocess having
abnormal termination. See g_subprocess_wait_check() for that.
Cancelling cancellable doesn't kill the subprocess. Call
g_subprocess_force_exit() if it is desirable.
Optionalcancellable: Gio.Cancellabletrue on success, false if cancellable was cancelled
Wait for the subprocess to terminate.
This is the asynchronous version of g_subprocess_wait().
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Wait for the subprocess to terminate.
This is the asynchronous version of g_subprocess_wait().
a Gio.Cancellable, or null
a Gio.AsyncReadyCallback to call when the operation is complete
Wait for the subprocess to terminate.
This is the asynchronous version of g_subprocess_wait().
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Optionalcallback: AsyncReadyCallback<Gio.Subprocess>a Gio.AsyncReadyCallback to call when the operation is complete
Combines g_subprocess_wait() with g_spawn_check_wait_status().
Optionalcancellable: Gio.Cancellabletrue on success, false if process exited abnormally, or cancellable was cancelled
Combines g_subprocess_wait_async() with g_spawn_check_wait_status().
This is the asynchronous version of g_subprocess_wait_check().
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Combines g_subprocess_wait_async() with g_spawn_check_wait_status().
This is the asynchronous version of g_subprocess_wait_check().
a Gio.Cancellable, or null
a Gio.AsyncReadyCallback to call when the operation is complete
Combines g_subprocess_wait_async() with g_spawn_check_wait_status().
This is the asynchronous version of g_subprocess_wait_check().
Optionalcancellable: Gio.Cancellablea Gio.Cancellable, or null
Optionalcallback: AsyncReadyCallback<Gio.Subprocess>a Gio.AsyncReadyCallback to call when the operation is complete
Collects the result of a previous call to
g_subprocess_wait_check_async().
the Gio.AsyncResult passed to your Gio.AsyncReadyCallback
true if successful, or false with error set
Collects the result of a previous call to
g_subprocess_wait_async().
the Gio.AsyncResult passed to your Gio.AsyncReadyCallback
true if successful, or false with error set
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
GObject.Closure to watch
StaticnewStatic_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_Add a property to an interface; this is only useful for interfaces
that are added to GObject-derived types. Adding a property to an
interface forces all objects classes with that interface to have a
compatible property. The compatible property could be a newly
created GObject.ParamSpec, but normally
g_object_class_override_property() will be used so that the object
class only needs to provide an implementation and inherits the
property description, default value, bounds, and so forth from the
interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Gio.Subprocess allows the creation of and interaction with child processes.
Processes can be communicated with using standard GIO-style APIs (ie: Gio.InputStream, Gio.OutputStream). There are GIO-style APIs to wait for process termination (ie: cancellable and with an asynchronous variant).
There is an API to force a process to terminate, as well as a race-free API for sending UNIX signals to a subprocess.
One major advantage that GIO brings over the core GLib library is comprehensive API for asynchronous I/O, such Gio.OutputStream.splice_async. This makes Gio.Subprocess significantly more powerful and flexible than equivalent APIs in some other languages such as the
subprocess.pyincluded with Python. For example, using Gio.Subprocess one could create two child processes, reading standard output from the first, processing it, and writing to the input stream of the second, all without blocking the main loop.A powerful Gio.Subprocess.communicate API is provided similar to the
communicate()method ofsubprocess.py. This enables very easy interaction with a subprocess that has been opened with pipes.Gio.Subprocess defaults to tight control over the file descriptors open in the child process, avoiding dangling-FD issues that are caused by a simple
fork()/exec(). The only open file descriptors in the spawned process are ones that were explicitly specified by the Gio.Subprocess API (unlessG_SUBPROCESS_FLAGS_INHERIT_FDSwas specified).Gio.Subprocess will quickly reap all child processes as they exit, avoiding ‘zombie processes’ remaining around for long periods of time. Gio.Subprocess.wait can be used to wait for this to happen, but it will happen even without the call being explicitly made.
As a matter of principle, Gio.Subprocess has no API that accepts shell-style space-separated strings. It will, however, match the typical shell behaviour of searching the
PATHfor executables that do not contain a directory separator in their name. By default, thePATHof the current process is used. You can specifyG_SUBPROCESS_FLAGS_SEARCH_PATH_FROM_ENVPto use thePATHof the launcher environment instead.Gio.Subprocess attempts to have a very simple API for most uses (ie: spawning a subprocess with arguments and support for most typical kinds of input and output redirection). See Gio.Subprocess.new. The Gio.SubprocessLauncher API is provided for more complicated cases (advanced types of redirection, environment variable manipulation, change of working directory, child setup functions, etc).
A typical use of Gio.Subprocess will involve calling Gio.Subprocess.new, followed by Gio.Subprocess.wait_async or Gio.Subprocess.wait. After the process exits, the status can be checked using functions such as Gio.Subprocess.get_if_exited (which are similar to the familiar
WIFEXITED-style POSIX macros).Note that as of GLib 2.82, creating a Gio.Subprocess causes the signal
SIGPIPEto be ignored for the remainder of the program. If you are writing a command-line utility that uses Gio.Subprocess, you may need to take into account the fact that your program will not automatically be killed if it tries to write tostdoutafter it has been closed.Since
2.40