Kernel APIs

[iefserge]

Here is the current version of kernel APIs (global functions available to all programs):

• runtime.args() - get program arguments. Returns object like

{
  data: { ... }
  env: { ... }
  system: { ... }
}

Includes all data available to program. Where: data - data provided by parent program env - environment provided by parent program (usually inherited). For example, standard streams are part of the environment. (env.stdout, env.stderr, env.stdin) system - environment provided by kernel (according to program access level, system services like filesystem, network, etc). For example, each program is chrooted to directory where it's *.js file is located, so it gets it's own accessor object system.fs.current (not inherited from parent).

• runtime.exit([value]) - exit program and return optional value to parent program
• runtime.log([args,...]) - write to kernel log (console.log writes to stdout by default)
• runtime.version() - get system version

If you have any comments or suggestions, we can discuss it here.

UPDATED (latest version):

• isolate.data - data provided by parent program
• isolate.env - environment provided by parent program
• isolate.system - environment provided by kernel
• isolate.exit() - exit program
• isolate.log() - write to kernel log
• kernel.version() - get system version

[heapwolf]

Initial thoughts: if we're calling a runnable javascript file a program, something spawned, the closest analog seems like process or even better, isolate since it's spawned by the isolateManager. What about something more like...

KERNEL

• kernel.log([args, ...])
• kernel.version()

PROCESS

• isolate.exit([value])
• isolate.log(...)
• isolate.stdout(...)
• isolate.stdin(...)
• isolate.stderr(...)
• isolate.args()
• isolate.data

[iefserge]

isolate.stdout(...)
isolate.stdin(...)
isolate.stderr(...)

@hij1nx Why global functions for streams? I think streams should be a part of the program environment provided by shell.

[heapwolf]

oops, i didn't mean for those to be functions. not global functions, but members attached to the isolate object, similar to process.stdout etc. in node.

• isolate.stdout
• isolate.stdin
• isolate.stderr

[iefserge]

@hij1nx I like the idea to rename global runtime object to isolate. I was thinking about isolate.env().stdout or isolate.env.stdout because it's an environment object.

[heapwolf]

ah, yeah i see what you mean. :+1: I like isolate.env.stdout the best.

[iefserge]

Now API looks like this:

• isolate.data
• isolate.env
• isolate.system
• isolate.exit()
• isolate.log()
• kernel.version() // maybe put versions into isolate.system.version() ?

[heapwolf]

thats quite nice. I think the kernel object is a nice way to expose things about the kernel that don't directly relate to isolates, like kernel.version.

[iefserge]

Added API wiki page https://github.com/runtimejs/runtime/wiki/api

[heapwolf]

No longer relevant after latest discussions.