git ssb

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

Table of Contents

• constructor
• addNodeToCheck
• getDestPort
• getInstance
• createInstance
• createStateRoot
• registerContainer

constructor

index.js:16-29

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
• state object the starting state (optional, default {'/':Tree.emptyTreeState})

addNodeToCheck

index.js:35-37

add a potaintail node in the state graph to check for garbage collection

Parameters

• id string

getDestPort

index.js:44-51

given a port, this finds the corridsponeding endpoint port of the channel

Parameters

• port object

Returns Promise

getInstance

index.js:105-116

gets an existsing container instances

Parameters

• id string the containers ID

Returns Promise

createInstance

index.js:128-165

creates an new container instances and save it in the state

Parameters

• type string the type of container to create
• message (optional, default new Message())
• id object (optional, default {nonce:0,parent:null})
  • id.nonce object
  • id.parent object
• code any
• entryPorts array

Returns Promise

createStateRoot

index.js:187-196

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

registerContainer

index.js:204-209

regirsters a container with the hypervisor

Parameters

• Constructor Class a Class for instantiating the container
• args any any args that the contructor takes
• typeId interger the container's type identification ID (optional, default Constructor.typeId)