git ssb - rebuild docs · wanderer🌟/js-primea-hypervisor@d747310d

Commit d747310d661b519bb57c6ac0aed7b5edcbe440cf

rebuild docs

Signed-off-by: wanderer <mjbecze@gmail.com>

wanderer committed on 11/26/2017, 2:13:25 AM
Parent: 4d548116a6a4d4ceeda766ea686a328148cb029b

Files changed

docs/actor.md	changed
docs/capsManager.md	changed
docs/hypervisor.md	changed
docs/inbox.md	changed
docs/scheduler.md	changed

docs/actor.mdView
		@@ -14,9 +14,9 @@
14	14 …	- [send](#send)
15	15 …
16	16 …	## constructor
17	17 …
18		-[actor.js:15-31](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L15-L31 "Source code on GitHub")
	18 …	+[actor.js:15-31](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L15-L31 "Source code on GitHub")
19	19 …
20	20 …	the Actor manages the varous message passing functions and provides
21	21 …	an interface for the containers to use
22	22 …
		@@ -29,9 +29,9 @@
29	29 …	- `opts.container` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) the container constuctor and argments
30	30 …
31	31 …	## mintCap
32	32 …
33		-[actor.js:38-43](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L38-L43 "Source code on GitHub")
	33 …	+[actor.js:38-43](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L38-L43 "Source code on GitHub")
34	34 …
35	35 …	Mints a new capabilitly with a given tag
36	36 …
37	37 …	Parameters
		@@ -41,20 +41,20 @@
41	41 …	Returns [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
42	42 …
43	43 …	## queue
44	44 …
45		-[actor.js:50-53](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L50-L53 "Source code on GitHub")
	45 …	+[actor.js:50-53](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L50-L53 "Source code on GitHub")
46	46 …
47		-adds a message to this containers message queue
	47 …	+adds a message to this actor's message queue
48	48 …
49	49 …	Parameters
50	50 …
51	51 …	- `message` [object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
52	52 …	- `portName` [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
53	53 …
54	54 …	## create
55	55 …
56		-[actor.js:60-66](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L60-L66 "Source code on GitHub")
	56 …	+[actor.js:60-66](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L60-L66 "Source code on GitHub")
57	57 …
58	58 …	runs the creation routine for the actor
59	59 …
60	60 …	Parameters
		@@ -64,21 +64,21 @@
64	64 …	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
65	65 …
66	66 …	## shutdown
67	67 …
68		-[actor.js:95-97](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L95-L97 "Source code on GitHub")
	68 …	+[actor.js:95-97](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L95-L97 "Source code on GitHub")
69	69 …
70	70 …	Runs the shutdown routine for the actor
71	71 …
72	72 …	## startup
73	73 …
74		-[actor.js:102-104](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L102-L104 "Source code on GitHub")
	74 …	+[actor.js:102-104](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L102-L104 "Source code on GitHub")
75	75 …
76	76 …	Runs the startup routine for the actor
77	77 …
78	78 …	## runMessage
79	79 …
80		-[actor.js:112-132](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L112-L132 "Source code on GitHub")
	80 …	+[actor.js:112-132](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L112-L132 "Source code on GitHub")
81	81 …
82	82 …	run the Actor with a given message
83	83 …
84	84 …	Parameters
		@@ -89,19 +89,19 @@
89	89 …	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
90	90 …
91	91 …	## incrementTicks
92	92 …
93		-[actor.js:138-141](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L138-L141 "Source code on GitHub")
	93 …	+[actor.js:138-141](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L138-L141 "Source code on GitHub")
94	94 …
95		-updates the number of ticks that the container has run
	95 …	+updates the number of ticks that the actor has run
96	96 …
97	97 …	Parameters
98	98 …
99	99 …	- `count` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the number of ticks to add
100	100 …
101	101 …	## createActor
102	102 …
103		-[actor.js:148-151](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L148-L151 "Source code on GitHub")
	103 …	+[actor.js:148-151](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L148-L151 "Source code on GitHub")
104	104 …
105	105 …	creates an actor
106	106 …
107	107 …	Parameters
		@@ -110,9 +110,9 @@
110	110 …	- `message` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) an intial [message](https://github.com/primea/js-primea-message) to send newly created actor
111	111 …
112	112 …	## send
113	113 …
114		-[actor.js:168-174](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L168-L174 "Source code on GitHub")
	114 …	+[actor.js:168-174](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/actor.js#L168-L174 "Source code on GitHub")
115	115 …
116	116 …	sends a message to a given port
117	117 …
118	118 …	Parameters

docs/capsManager.mdView
		@@ -8,9 +8,9 @@
8	8 …	- [delete](#delete)
9	9 …
10	10 …	## constructor
11	11 …
12		-[capsManager.js:10-12](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/capsManager.js#L10-L12 "Source code on GitHub")
	12 …	+[capsManager.js:10-12](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/capsManager.js#L10-L12 "Source code on GitHub")
13	13 …
14	14 …	The port manager manages the the ports. This inculdes creation, deletion
15	15 …	fetching and waiting on ports
16	16 …
		@@ -23,9 +23,9 @@
23	23 …	- `opts.exoInterface` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
24	24 …
25	25 …	## store
26	26 …
27		-[capsManager.js:19-22](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/capsManager.js#L19-L22 "Source code on GitHub")
	27 …	+[capsManager.js:19-22](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/capsManager.js#L19-L22 "Source code on GitHub")
28	28 …
29	29 …	binds a port to a name
30	30 …
31	31 …	Parameters
		@@ -35,9 +35,9 @@
35	35 …	- `port` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) the port to bind
36	36 …
37	37 …	## get
38	38 …
39		-[capsManager.js:29-32](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/capsManager.js#L29-L32 "Source code on GitHub")
	39 …	+[capsManager.js:29-32](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/capsManager.js#L29-L32 "Source code on GitHub")
40	40 …
41	41 …	gets a port given it's name
42	42 …
43	43 …	Parameters
		@@ -47,9 +47,9 @@
47	47 …	Returns [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
48	48 …
49	49 …	## delete
50	50 …
51		-[capsManager.js:38-40](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/capsManager.js#L38-L40 "Source code on GitHub")
	51 …	+[capsManager.js:38-40](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/capsManager.js#L38-L40 "Source code on GitHub")
52	52 …
53	53 …	delete an port given the name it is bound to
54	54 …
55	55 …	Parameters

docs/hypervisor.mdView
		@@ -10,9 +10,9 @@
10	10 …	- [registerContainer](#registercontainer)
11	11 …
12	12 …	## constructor
13	13 …
14		-[index.js:10-15](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/index.js#L10-L15 "Source code on GitHub")
	14 …	+[index.js:10-15](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/index.js#L10-L15 "Source code on GitHub")
15	15 …
16	16 …	The Hypervisor manages the container instances by instantiating them and
17	17 …	destorying them when possible. It also facilitates localating Containers
18	18 …
		@@ -21,9 +21,9 @@
21	21 …	- `tree` Tree a [radix tree](https://github.com/dfinity/js-dfinity-radix-tree) to store the state
22	22 …
23	23 …	## send
24	24 …
25		-[index.js:23-27](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/index.js#L23-L27 "Source code on GitHub")
	25 …	+[index.js:23-27](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/index.js#L23-L27 "Source code on GitHub")
26	26 …
27	27 …	sends a message
28	28 …
29	29 …	Parameters
		@@ -34,9 +34,9 @@
34	34 …	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) a promise that resolves once the receiving container is loaded
35	35 …
36	36 …	## getActor
37	37 …
38		-[index.js:52-63](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/index.js#L52-L63 "Source code on GitHub")
	38 …	+[index.js:52-63](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/index.js#L52-L63 "Source code on GitHub")
39	39 …
40	40 …	gets an existsing actor
41	41 …
42	42 …	Parameters
		@@ -46,9 +46,9 @@
46	46 …	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
47	47 …
48	48 …	## createActor
49	49 …
50		-[index.js:71-95](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/index.js#L71-L95 "Source code on GitHub")
	50 …	+[index.js:71-95](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/index.js#L71-L95 "Source code on GitHub")
51	51 …
52	52 …	creates an instance of an Actor
53	53 …
54	54 …	Parameters
		@@ -58,9 +58,9 @@
58	58 …	- `id` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) the id for the actor (optional, default `{nonce:this.nonce,parent:null}`)
59	59 …
60	60 …	## createStateRoot
61	61 …
62		-[index.js:108-111](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/index.js#L108-L111 "Source code on GitHub")
	62 …	+[index.js:108-111](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/index.js#L108-L111 "Source code on GitHub")
63	63 …
64	64 …	creates a state root starting from a given container and a given number of
65	65 …	ticks
66	66 …
		@@ -71,9 +71,9 @@
71	71 …	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
72	72 …
73	73 …	## registerContainer
74	74 …
75		-[index.js:119-124](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/index.js#L119-L124 "Source code on GitHub")
	75 …	+[index.js:119-124](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/index.js#L119-L124 "Source code on GitHub")
76	76 …
77	77 …	regirsters a container with the hypervisor
78	78 …
79	79 …	Parameters

docs/inbox.mdView
		@@ -8,9 +8,9 @@
8	8 …	- [nextMessage](#nextmessage)
9	9 …
10	10 …	## constructor
11	11 …
12		-[inbox.js:23-31](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/inbox.js#L23-L31 "Source code on GitHub")
	12 …	+[inbox.js:23-31](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/inbox.js#L23-L31 "Source code on GitHub")
13	13 …
14	14 …	The inbox manages and sorts incoming messages and provides functions
15	15 …	to wait on messages
16	16 …
		@@ -21,9 +21,9 @@
21	21 …	- `opts.hypervisor` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
22	22 …
23	23 …	## queue
24	24 …
25		-[inbox.js:37-47](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/inbox.js#L37-L47 "Source code on GitHub")
	25 …	+[inbox.js:37-47](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/inbox.js#L37-L47 "Source code on GitHub")
26	26 …
27	27 …	queues a message
28	28 …
29	29 …	Parameters
		@@ -31,9 +31,9 @@
31	31 …	- `message` Message
32	32 …
33	33 …	## nextTaggedMessage
34	34 …
35		-[inbox.js:55-66](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/inbox.js#L55-L66 "Source code on GitHub")
	35 …	+[inbox.js:55-66](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/inbox.js#L55-L66 "Source code on GitHub")
36	36 …
37	37 …	Waits for a message sent with a capablitly that has one of the given tags
38	38 …
39	39 …	Parameters
		@@ -44,9 +44,9 @@
44	44 …	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
45	45 …
46	46 …	## nextMessage
47	47 …
48		-[inbox.js:73-109](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/inbox.js#L73-L109 "Source code on GitHub")
	48 …	+[inbox.js:73-109](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/inbox.js#L73-L109 "Source code on GitHub")
49	49 …
50	50 …	Waits for the the next message if any
51	51 …
52	52 …	Parameters

docs/scheduler.mdView
		@@ -11,16 +11,16 @@
11	11 …	- [leastNumberOfTicks](#leastnumberofticks)
12	12 …
13	13 …	## constructor
14	14 …
15		-[scheduler.js:14-20](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L14-L20 "Source code on GitHub")
	15 …	+[scheduler.js:14-20](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/scheduler.js#L14-L20 "Source code on GitHub")
16	16 …
17		-The Scheduler manages the run cycle of Actors and figures out which
18		-order they should run in
	17 …	+The Scheduler manages the actor instances and tracks how many "ticks" they
	18 …	+have ran.
19	19 …
20	20 …	## lock
21	21 …
22		-[scheduler.js:27-29](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L27-L29 "Source code on GitHub")
	22 …	+[scheduler.js:27-29](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/scheduler.js#L27-L29 "Source code on GitHub")
23	23 …
24	24 …	locks the scheduler from clearing waits untill the lock is resolved
25	25 …
26	26 …	Parameters
		@@ -30,9 +30,9 @@
30	30 …	Returns [function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function) the resolve function to call once it to unlock
31	31 …
32	32 …	## update
33	33 …
34		-[scheduler.js:35-40](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L35-L40 "Source code on GitHub")
	34 …	+[scheduler.js:35-40](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/scheduler.js#L35-L40 "Source code on GitHub")
35	35 …
36	36 …	updates an instance with a new tick count
37	37 …
38	38 …	Parameters
		@@ -40,9 +40,9 @@
40	40 …	- `instance` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) an actor instance
41	41 …
42	42 …	## getInstance
43	43 …
44		-[scheduler.js:52-54](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L52-L54 "Source code on GitHub")
	44 …	+[scheduler.js:52-54](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/scheduler.js#L52-L54 "Source code on GitHub")
45	45 …
46	46 …	returns an Actor instance
47	47 …
48	48 …	Parameters
		@@ -52,9 +52,9 @@
52	52 …	Returns [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
53	53 …
54	54 …	## done
55	55 …
56		-[scheduler.js:60-64](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L60-L64 "Source code on GitHub")
	56 …	+[scheduler.js:60-64](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/scheduler.js#L60-L64 "Source code on GitHub")
57	57 …
58	58 …	deletes an instance from the scheduler
59	59 …
60	60 …	Parameters
		@@ -62,9 +62,9 @@
62	62 …	- `id` [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) the containers id
63	63 …
64	64 …	## wait
65	65 …
66		-[scheduler.js:73-83](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L73-L83 "Source code on GitHub")
	66 …	+[scheduler.js:73-84](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/scheduler.js#L73-L84 "Source code on GitHub")
67	67 …
68	68 …	returns a promise that resolves once all containers have reached the given
69	69 …	number of ticks
70	70 …
		@@ -76,13 +76,13 @@
76	76 …	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
77	77 …
78	78 …	## leastNumberOfTicks
79	79 …
80		-[scheduler.js:89-98](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L89-L98 "Source code on GitHub")
	80 …	+[scheduler.js:90-100](https://github.com/primea/js-primea-hypervisor/blob/4d548116a6a4d4ceeda766ea686a328148cb029b/scheduler.js#L90-L100 "Source code on GitHub")
81	81 …
82	82 …	returns the oldest container's ticks
83	83 …
84	84 …	Parameters
85	85 …
86		-- `exculde`
	86 …	+- `exclude`
87	87 …
88	88 …	Returns integer

Built with git-ssb-web

wanderer🌟 / js-primea-hypervisor

Commit d747310d661b519bb57c6ac0aed7b5edcbe440cf

rebuild docs

Files changed