Keywords: nebuloid

Up: Nebuloid Type Reference Previous: Contents Contents
Subsections

- 1.1 NULL
- 1.2 ALIVE
- 1.3 CPU
- 1.4 FD
- 1.5 GETPIDBYNAME
- 1.6 KILL
- 1.7 LOG
- 1.8 MAXMEM
- 1.9 MEM
- 1.10 VAR
- 1.11 EXIT
- 1.12 SH
- 1.13 EXEC

# 1 Nebuloids Types

## 1.1 NULL

name | NULL
module | mod_null
platforms | posix
inst() args | none
get function | Always returns 0.
get() args | none
set function | nothing.

## 1.2 ALIVE

name | ALIVE
module | mod_alive
platforms | posix
inst() args | none
get function | Returns a 0 to signify that the process does not exist and non-zero to signify that it does.
get() args | none
set function | nothing.

## 1.3 CPU

name | CPU
module | mod_cpu
platforms | nto
inst() args | none
get function | Return that percentage of cpu usage used by the process (or whole system, if pid is 0) multiplied by 1000.
get() args | none
set function | nothing.

## 1.4 FD

name | FD
module | mod_fd
platforms | nto
inst() args | none
get function | Returns number of file descriptors used by the process(or whole system, if pid is 0. not done yet)
get() args | none
set function | nothing.

## 1.5 GETPIDBYNAME

name | GETPIDBYNAME
module | mod_getpidbyname
platforms | nto
inst() args | kString String containing name of process.
get function | Returns that pid of the first process that matches the name of the string given on instantiation. 0 if none exist.
get() args | none
set function | nothing.

## 1.6 KILL

name | KILL
module | mod_kill
platforms | posix
inst() args | kInt Integer representing the signal number
get function | Sends signal number to the process. Returns errno from signal().
get() args | none
set function | nothing.

Should the signal number be give on get instead of on instantiation?

## 1.7 LOG

name | LOG
module | mod_log
platforms | posix
inst() args | kInt Type of error logging. 0 - stderr, 1 - file, 2 - syslog. kString Log filename, or syslog server address.
get function | Records a log message.
get() args | kInt Severity of log message 0-10 (fatal-debug). kString Log message itself.
set function | nothing

## 1.8 MAXMEM

name | MAXMEM
module | mod_maxmem
platforms | nto
inst() args | none
get function | Returns the total amount of memory in the system(in bytes.)
get() args | none
set function | nothing.

## 1.9 MEM

name | MEM
module | mod_mem
platforms | nto
inst() args | kInt 0 just heap 1 heap/stack 2 code/data/heap/stack 3 code/data/heap/stack/shared_objects 4 code/data/heap/stack/shared_objects/other(memmapped files, shared memory, etc).
get function | Return the amount of memory in bytes used by the process or system.
get() args | none
set function | nothing.

## 1.10 VAR

name | VAR
module | mod_var
platforms | posix
inst() args | kInt Value to be stored in variable.
get function | Return value stored in variable.
get() args | none
set function | Sets value of variable.

## 1.11 EXIT

name | EXIT
module | mod_exit
platforms | posix
inst() args | none.
get function | Used for testing. Immediately exit()'s the program.
get() args | kInt Exit code of the process.
set function | nothing.

## 1.12 SH

name | SH
module | mod_sh
platforms | posix
inst() args | kString Path of your shell.
get function | Starts a shell with the arguement given. Returns the pid of the shell or if the argument begins with `exec' the pid of the program exec'd.
get() args | kString Command line to be executed by the shell.
set function | nothing.
note | This will not work with QNX Neutrino's uesh.

## 1.13 EXEC

name | EXEC
module | mod_exec
platforms | posix
inst() args | none
get function | Fork()'s and exec()'s the program. No arguements are allows. This is a very special purpose nebuloid and is rarely useful, but it does allow you to execute programs without a shell. Returns the pid of the process.
get() args | kString Program to be executed.
set function | nothing.

Up: Nebuloid Type Reference Previous: Contents Contents