API

Content

• The Program Class
• The CpuVirtualMachine Class
• The VmSession Class
• The VirtualMachine Class

This document contains the API available to integrate BEAST into other projects. The API spans over multiple different classes that each have their own use-case in projects applying the BEAST library:

• The Program Class: The central entity holding BEAST programs. It has a high level programming interface to populate byte code programs without knowledge of their actual representation.
• The CpuVirtualMachine Class: The main execution engine for byte code programs. Is able to interpret the entire BEAST byte code operator set and makes use of a VmSession instance to maintain the state of a program.
• The VmSession Class: Holds the state of a program, including current instruction pointer, variable memory, and string table.
• The VirtualMachine Class: Acts as a base class for implementing custom virtual machines.