git ssb

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

Table of Contents

• constructor
• send
• loadActor
• createActor
• createStateRoot
• setStateRoot
• registerContainer
• registerDriver

constructor

index.js:18-27

The Hypervisor manages the container instances by instantiating them and destorying them when possible. It also facilitates localating Containers

Parameters

• opts Object
  • opts.tree Object a radix tree to store the state
  • opts.container Array an array of containers to regester
  • opts.drivers Array an array of drivers to install
  • opts.meter boolean whether to meter gas or not (optional, default true)

send

index.js:34-39

sends a message(s). If an array of message is given the all the messages will be sent at once

Parameters

• messages
• message Object the message to send

Returns Promise a promise that resolves once the receiving container is loaded

loadActor

index.js:46-70

loads an actor from the tree given its id

Parameters

• id ID

Returns Promise&lt;Actor>

createActor

index.js:78-102

creates an instance of an Actor

Parameters

• type Integer the type id for the container
• code
• id Object the id for the actor (optional, default {nonce:this.nonce++,parent:null})
• message Object an intial message to send newly created actor

createStateRoot

index.js:116-124

creates a state root starting from a given container and a given number of ticks

Parameters

• ticks Number the number of ticks at which to create the state root

Returns Promise

setStateRoot

index.js:131-135

set the state root. The promise must resolve before creating or sending any more messages to the hypervisor

Parameters

• stateRoot Buffer

Returns Promise

registerContainer

index.js:141-143

regesters a container with the hypervisor

Parameters

• Constructor Function the container's constuctor

registerDriver

index.js:149-151

register a driver with the hypervisor

Parameters

• driver driver