Process
Utilities for accessing functionality and information about the Grain program’s process.
Edit on GitHubThis includes things like accessing environment variables and sending signals.
from "wasi/process" include ProcessType declarations included in the Process module.
enum Signal {
HUP,
INT,
QUIT,
ILL,
TRAP,
ABRT,
BUS,
FPE,
KILL,
USR1,
SEGV,
USR2,
PIPE,
ALRM,
TERM,
CHLD,
CONT,
STOP,
TSTP,
TTIN,
TTOU,
URG,
XCPU,
XFSZ,
VTALRM,
PROF,
WINCH,
POLL,
PWR,
SYS,
}Signals that can be sent to the host system.
Variants:
HUPHangup.
INTTerminate interrupt signal.
QUITTerminal quit signal.
ILLIllegal instruction.
TRAPTrace/breakpoint trap.
ABRTProcess abort signal.
BUSAccess to an undefined portion of a memory object.
FPEErroneous arithmetic operation.
KILLKill.
USR1User-defined signal 1.
SEGVInvalid memory reference.
USR2User-defined signal 2.
PIPEWrite on a pipe with no one to read it.
ALRMAlarm clock.
TERMTermination signal.
CHLDChild process terminated, stopped, or continued.
CONTContinue executing, if stopped.
STOPStop executing.
TSTPTerminal stop signal.
TTINBackground process attempting read.
TTOUBackground process attempting write.
URGHigh bandwidth data is available at a socket.
XCPUCPU time limit exceeded.
XFSZFile size limit exceeded.
VTALRMVirtual timer expired.
SYSBad system call.
Functions and constants included in the Process module.
argv : () => Result<Array<String>, Exception>Access command line arguments.
Returns:
| type | description |
|---|---|
Result<Array<String>, Exception> | Ok(args) of an array containing positional string arguments to the process if successful or Err(exception) otherwise |
Result<Array<String>, Exception>: Ok(args) of an array containing positional string arguments to the process if successful or Err(exception) otherwiseenv : () => Result<Array<String>, Exception>Access environment variables.
Returns:
| type | description |
|---|---|
Result<Array<String>, Exception> | Ok(vars) of an array containing environment variables supplied to the process if successful or Err(exception) otherwise |
Result<Array<String>, Exception>: Ok(vars) of an array containing environment variables supplied to the process if successful or Err(exception) otherwiseexit : (code: Number) => Result<Void, Exception>Terminate the process normally.
Parameters:
| param | type | description |
|---|---|---|
code | Number | The value to exit with. An exit code of 0 is considered normal, with other values having meaning depending on the platform |
code: The value to exit with. An exit code of 0 is considered normal, with other values having meaning depending on the platformReturns:
| type | description |
|---|---|
Result<Void, Exception> | Err(exception) if unsuccessful. Will not actually return a value if successful, as the process has ended |
Result<Void, Exception>: Err(exception) if unsuccessful. Will not actually return a value if successful, as the process has endedsigRaise : (signal: Signal) => Result<Void, Exception>Send a signal to the process of the calling thread.
Parameters:
| param | type | description |
|---|---|---|
signal | Signal | The signal to send |
signal: The signal to sendReturns:
| type | description |
|---|---|
Result<Void, Exception> | Ok(void) if successful or Err(exception) otherwise |
Result<Void, Exception>: Ok(void) if successful or Err(exception) otherwiseschedYield : () => Result<Void, Exception>Yield execution to the calling thread.
Returns:
| type | description |
|---|---|
Result<Void, Exception> | Ok(void) if successful or Err(exception) otherwise |
Result<Void, Exception>: Ok(void) if successful or Err(exception) otherwise