git ssb

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

Table of Contents

• constructor
• getInstanceByPath
• getInstanceByPort
• wait
• createInstance
• createStateRoot
• registerContainer

constructor

index.js:10-14

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

Parameters

• dag Graph an instance of ipfs.dag

getInstanceByPath

index.js:21-28

get a container by its path

Parameters

• root Object the root container to start searching from
• path String the path to travers

getInstanceByPort

index.js:35-46

get a contrainer instance given its entry port and its mounting port

Parameters

• port Object the entry port for the container
• parentPort Object the entry port of the parent container

wait

index.js:56-63

given a port, wait untill its source contract has reached the threshold tick count

Parameters

• port Object the port to wait on
• threshold Number the number of ticks to wait before resolving
• fromPort Object the entryPort of the container requesting the wait. Used internally so that waits don't become cyclic

createInstance

index.js:73-95

creates an instance given the container type, starting state, entry port and the parentPort

Parameters

• type
• state
• entryPort (optional, default null)
• parentPort
• the String type of VM to load
• the Object starting state of the VM
• the Object entry port
• the Object parent port

createStateRoot

index.js:104-107

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

Parameters

• container Container an container instance
• ticks Number the number of ticks at which to create the state root

Returns Promise

registerContainer

index.js:114-116

regirsters a container with the hypervisor

Parameters

• type
• vm
• the String name of the type
• a Class Class for instantiating the container