Files: 6bb7e160de386c6d753687b4ede2c14555ab5364 / docs / actor.md
2599 bytesRaw
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
Table of Contents
constructor
the Actor manages the various message passing functions and provides an interface for the containers to use
Parameters
opts
Objectopts.id
ID the UUID of the Actoropts.module
Object the module this actor was created fromopts.state
Object the state of the moduleopts.storage
Object the actor's persistent storageopts.hypervisor
Object the instance of the hypervisoropts.nonce
Numberopts.Container
Function the module constructor and arguments
shutdown
Runs the shutdown routine for the actor
startup
Runs the startup routine for the actor
runMessage
run the Actor with a given message
Parameters
Returns Promise
incrementTicks
updates the number of ticks that the actor has run
Parameters
count
Number the number of ticks to add
newActor
creates an actor from a module and code
Parameters
Returns ActorRef
createModule
creates a modref from a module and code
Parameters
Returns ModuleRef
createActor
creates an actor from a modref
Parameters
modRef
ModuleRef the modref
Returns ActorRef
send
sends a message
Parameters
message
Message the message
Built with git-ssb-web