Spawn

class Spawn {}

Constructors

this
this(string program, string[] envp)

Creates a Spawn for execution.

this
this(string[] program, string[] envp)

Creates a Spawn for execution.

Members

Aliases

ChildWatch
alias ChildWatch = bool delegate(Spawn)
Undocumented in source.

Classes

ReadFile
class ReadFile
Undocumented in source.

Functions

addChildWatch
void addChildWatch(ChildWatch dlg)

Adds a delegate to be notified on the end of the child process.

addParm
void addParm(string parm)

Adds a parameter to the execution program

close
void close()

Closes all open streams and child process.

commandLineSync
int commandLineSync(ChildWatch externalWatch, bool delegate(string) readOutput, bool delegate(string) readError)

Executes a command synchronasly and optionally calls delegates for sysout, syserr and end of job

endOfError
bool endOfError()
Undocumented in source. Be warned that the author may not have intended to support it.
endOfOutput
bool endOfOutput()
Undocumented in source. Be warned that the author may not have intended to support it.
execAsyncWithPipes
int execAsyncWithPipes(ChildWatch externalWatch, bool delegate(string) readOutput, bool delegate(string) readError)

Executes the prepared process

getErrorString
string getErrorString()
Undocumented in source. Be warned that the author may not have intended to support it.
getExitStatus
int getExitStatus()
Undocumented in source. Be warned that the author may not have intended to support it.
getLastError
string getLastError()

Gets the last error message

getOutputString
string getOutputString()
Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

async
bool async(string workingDirectory, string[] argv, string[] envp, GSpawnFlags flags, GSpawnChildSetupFunc childSetup, void* userData, GPid childPid)

See g_spawn_async_with_pipes() for a full description; this function simply calls the g_spawn_async_with_pipes() without any pipes.

asyncWithFds
bool asyncWithFds(string workingDirectory, string[] argv, string[] envp, GSpawnFlags flags, GSpawnChildSetupFunc childSetup, void* userData, GPid childPid, int stdinFd, int stdoutFd, int stderrFd)

Identical to g_spawn_async_with_pipes() but instead of creating pipes for the stdin/stdout/stderr, you can pass existing file descriptors into this function through the @stdin_fd, @stdout_fd and @stderr_fd parameters. The following @flags also have their behaviour slightly tweaked as a result:

checkExitStatus
bool checkExitStatus(int exitStatus)

Set @error if @exit_status indicates the child exited abnormally (e.g. with a nonzero exit code, or via a fatal signal).

childWatchCallback
void childWatchCallback(int pid, int status, Spawn spawn)
Undocumented in source. Be warned that the author may not have intended to support it.
closePid
void closePid(GPid pid)

On some platforms, notably Windows, the #GPid type represents a resource which must be closed to prevent resource leaking. g_spawn_close_pid() is provided for this purpose. It should be used on all platforms, even though it doesn't do anything under UNIX.

commandLineAsync
bool commandLineAsync(string commandLine)

A simple version of g_spawn_async() that parses a command line with g_shell_parse_argv() and passes it to g_spawn_async(). Runs a command line in the background. Unlike g_spawn_async(), the %G_SPAWN_SEARCH_PATH flag is enabled, other flags are not. Note that %G_SPAWN_SEARCH_PATH can have security implications, so consider using g_spawn_async() directly if appropriate. Possible errors are those from g_shell_parse_argv() and g_spawn_async().

commandLineSync
bool commandLineSync(string commandLine, string standardOutput, string standardError, int exitStatus)

A simple version of g_spawn_sync() with little-used parameters removed, taking a command line instead of an argument vector. See g_spawn_sync() for full details. @command_line will be parsed by g_shell_parse_argv(). Unlike g_spawn_sync(), the %G_SPAWN_SEARCH_PATH flag is enabled. Note that %G_SPAWN_SEARCH_PATH can have security implications, so consider using g_spawn_sync() directly if appropriate. Possible errors are those from g_spawn_sync() and those from g_shell_parse_argv().

errorQuark
GQuark errorQuark()
exitErrorQuark
GQuark exitErrorQuark()
sync
bool sync(string workingDirectory, string[] argv, string[] envp, GSpawnFlags flags, GSpawnChildSetupFunc childSetup, void* userData, string standardOutput, string standardError, int exitStatus)

Executes a child synchronously (waits for the child to exit before returning). All output from the child is stored in @standard_output and @standard_error, if those parameters are non-%NULL. Note that you must set the %G_SPAWN_STDOUT_TO_DEV_NULL and %G_SPAWN_STDERR_TO_DEV_NULL flags when passing %NULL for @standard_output and @standard_error.

Variables

argv
string[] argv;
Undocumented in source.
childPid
GPid childPid;
Undocumented in source.
childSetup
GSpawnChildSetupFunc childSetup;
Undocumented in source.
envp
string[] envp;
Undocumented in source.
error
GError* error;
Undocumented in source.
exitStatus
int exitStatus;
Undocumented in source.
externalWatch
ChildWatch externalWatch;
Undocumented in source.
flags
GSpawnFlags flags;
Undocumented in source.
standardError
FILE* standardError;
Undocumented in source.
standardInput
FILE* standardInput;
Undocumented in source.
standardOutput
FILE* standardOutput;
Undocumented in source.
stdErr
int stdErr;
Undocumented in source.
stdIn
int stdIn;
Undocumented in source.
stdOut
int stdOut;
Undocumented in source.
strError
char* strError;
Undocumented in source.
strOutput
char* strOutput;
Undocumented in source.
userData
void* userData;
Undocumented in source.
workingDirectory
string workingDirectory;
Undocumented in source.

Meta