initable.init()

Triggered by the application system immediately after the application launches.

arbiter.hasImplicitPerm(
    u8 dest,
    p vessel,
    p protab
)

Determines whether the given vessel holds implicit permission for the given protab.

• dest = Destination for the result
• vessel = Vessel which may hold permission
• protab = Protab sentry

arbiter.implicitPerm(
    p dest,
    p vessel,
    p protab
)

Retrieves implicit permission for the given protab held by the given vessel. The result will be null if the given vessel does not hold implicit permission for the given protab.

• dest = Destination for the implicit permission
• vessel = Vessel which may hold permission
• protab = Protab sentry

lifeControl.throttle()

Requests for the receiving agent to reduce memory usage. The agent should cause memSizeUsed to be below memSizeLeft. If this is not possible, the agent should terminate cleanly.

lifeControl.kill()

Requests for the receiving agent to terminate. The agent should clean up any volatile resources.

termDriver.producer(
    p dest
)

Retrieves terminal producer associated with the receiving agent. The result will be null if the receiving agent does not have a corresponding terminal producer.

• dest = Destination for the agent sentry

termDriver.setProducer(
    p producer
)

Modifies terminal producer associated with the receiving agent. If producer is null, then the receiving agent will not have any terminal producer. This function will be invoked by implementations of termProducer.setDriver.

• producer = Sentry of agent which will be the terminal producer

termDriver.size(
    u32 widthDest,
    u32 heightDest
)

Retrieves the width and height of the terminal display. Each dimenion specifies a number of characters.

• widthDest = Destination for the width
• heightDest = Destination for the height

termDriver.setCursorPos(
    u32 x,
    u32 y
)

Modifies the position of the cursor on the terminal display. Each position coordinate specifies a number of characters.

• x = Horizontal coordinate
• y = Vertical coordinate

termDriver.setCursorIsVisible(
    u8 isVisible
)

Modifies whether the terminal cursor is visible.

• isVisible = Whether the cursor will be visible

termDriver.setTextIsInverted(
    u8 isInverted
)

Modifies whether to swap foreground and background colors for new characters on the terminal.

• isInverted = Whether to invert colors

termDriver.wrtText(
    p text
)

Adds the given text to the terminal starting at the cursor position. The cursor will move as each character is added.

• text = Text to write

termDriver.showMainBuffer()

Displays the main terminal buffer. The main buffer stores some extent of scrollback which may be controlled by the user.

termDriver.showAltBuffer()

Displays the alternate terminal buffer. The alternate buffer contents are stored independently from the main buffer. The alternate buffer cannot be scrolled by the user.

termProducer.driver(
    p dest
)

Retrieves terminal driver associated with the receiving agent. The result will be null if the receiving agent does not have a corresponding terminal driver.

• dest = Destination for the agent sentry

termProducer.setDriver(
    p driver
)

Modifies terminal driver associated with the receiving agent. If driver is null, then the receiving agent will not have any terminal driver. An implementation of this function is expected to invoke setProducer on driver when driver is not null.

• driver = Sentry of agent which will be the terminal driver

termProducer.sizeChanged()

Triggered by the terminal driver whenever the display changes size.

termProducer.keyTyped(
    u32 key,
    u8 modifiers
)

Triggered by the terminal driver whenever the user presses a key.

• key = Key code
• modifiers = Bitmask of key modifiers

termArbiter.termDriverProtab(
    p dest,
    p termDriver
)

Retrieves the protab to invoke functions of the given terminal driver. Every terminal driver holds implicit permission for this protab on itself.

• dest = Destination for the protab
• termDriver = Vessel

termArbiter.termProducerProtab(
    p dest,
    p termProducer
)

Retrieves the protab to invoke functions of the given terminal producer. Every terminal producer holds implicit permission for this protab on itself.

• dest = Destination for the protab
• termProducer = Vessel

volDriver.size(
    u64 dest
)

Retrieves the storage capacity of the volume. The size is measured in number of bytes.

• dest = Destination for the size

volDriver.pageSize(
    u32 dest
)

Retrieves the page size of the volume. The size is measured in number of bytes. Modifying a page requires erasing the entire page, then writing the new contents.

• dest = Destination for the size

volDriver.read(
    p dest,
    u64 offset,
    u64 size
)

Reads a sequence of bytes from the volume.

• dest = Destination for the buffer
• offset = Offset within the volume
• size = Number of bytes to read

volDriver.wrt(
    u64 offset,
    p buff
)

Writes a sequence of bytes to the volume.

• offset = Offset within the volume
• buff = Buffer to write

volDriver.flush(
    u64 offset
)

Persists the given volume page to storage.

• offset = Offset of page within the volume

volClient.volEjected(
    p vol
)

Triggered by the file system when the given volume is being ejected.

• vol = Volume name