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

Commit eaf33c2d3536ae3ec69d335f257a01bfee3f9dd3

rebuild docs

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

wanderer committed on 12/2/2017, 6:43:44 AM
Parent: 3ae2283be27509914459ba5c6d1acd9f4cc59b8d

Files changed

docs/actor.md	changed
docs/capsStore.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:16-33](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L16-L33 "Source code on GitHub")
	18	+[actor.js:17-32](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L17-L32 "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:40-45](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L40-L45 "Source code on GitHub")
	33	+[actor.js:39-44](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L39-L44 "Source code on GitHub")
34	34
35	35	Mints a new capabilitly with a given tag
36	36
37	37	Parameters
		@@ -41,9 +41,9 @@
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:52-55](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L52-L55 "Source code on GitHub")
	45	+[actor.js:51-54](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L51-L54 "Source code on GitHub")
46	46
47	47	adds a message to this actor's message queue
48	48
49	49	Parameters
		@@ -52,9 +52,9 @@
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:62-68](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L62-L68 "Source code on GitHub")
	56	+[actor.js:61-67](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L61-L67 "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:97-99](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L97-L99 "Source code on GitHub")
	68	+[actor.js:98-103](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L98-L103 "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:104-106](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L104-L106 "Source code on GitHub")
	74	+[actor.js:108-110](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L108-L110 "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:114-134](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L114-L134 "Source code on GitHub")
	80	+[actor.js:118-138](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L118-L138 "Source code on GitHub")
81	81
82	82	run the Actor with a given message
83	83
84	84	Parameters
		@@ -89,9 +89,9 @@
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:140-143](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L140-L143 "Source code on GitHub")
	93	+[actor.js:144-147](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L144-L147 "Source code on GitHub")
94	94
95	95	updates the number of ticks that the actor has run
96	96
97	97	Parameters
		@@ -99,9 +99,9 @@
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:150-153](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L150-L153 "Source code on GitHub")
	103	+[actor.js:154-157](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L154-L157 "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:170-177](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/actor.js#L170-L177 "Source code on GitHub")
	114	+[actor.js:174-181](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/actor.js#L174-L181 "Source code on GitHub")
115	115
116	116	sends a message to a given port
117	117
118	118	Parameters

docs/capsStore.mdView
		@@ -1,51 +1,3 @@
1	1	<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
2	2
3	3	### Table of Contents
4		-
5		-- [constructor](#constructor)
6		-- [store](#store)
7		-- [load](#load)
8		-- [delete](#delete)
9		-
10		-## constructor
11		-
12		-[capsStore.js:6-8](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/capsStore.js#L6-L8 "Source code on GitHub")
13		-
14		-The caps store, persistantly stores an actors capabilites.
15		-
16		-Parameters
17		-
18		-- `storedCaps` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
19		-
20		-## store
21		-
22		-[capsStore.js:15-18](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/capsStore.js#L15-L18 "Source code on GitHub")
23		-
24		-Stores a cap at a given key
25		-
26		-Parameters
27		-
28		-- `key` [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
29		-- `cap` [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
30		-
31		-## load
32		-
33		-[capsStore.js:25-28](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/capsStore.js#L25-L28 "Source code on GitHub")
34		-
35		-gets a cap given its key
36		-
37		-Parameters
38		-
39		-- `key` [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
40		-
41		-Returns [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
42		-
43		-## delete
44		-
45		-[capsStore.js:34-36](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/capsStore.js#L34-L36 "Source code on GitHub")
46		-
47		-delete cap given its key
48		-
49		-Parameters
50		-
51		-- `key` [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)

docs/hypervisor.mdView
		@@ -10,20 +10,21 @@
10	10	- [registerContainer](#registercontainer)
11	11
12	12	## constructor
13	13
14		-[index.js:10-15](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/index.js#L10-L15 "Source code on GitHub")
	14	+[index.js:10-15](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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
19	19	Parameters
20	20
21	21	- `tree` Tree a [radix tree](https://github.com/dfinity/js-dfinity-radix-tree) to store the state
	22	+- `nonce` (optional, default `0`)
22	23
23	24	## send
24	25
25		-[index.js:23-27](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/index.js#L23-L27 "Source code on GitHub")
	26	+[index.js:23-27](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/index.js#L23-L27 "Source code on GitHub")
26	27
27	28	sends a message
28	29
29	30	Parameters
		@@ -34,9 +35,9 @@
34	35	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	36
36	37	## getActor
37	38
38		-[index.js:52-63](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/index.js#L52-L63 "Source code on GitHub")
	39	+[index.js:52-63](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/index.js#L52-L63 "Source code on GitHub")
39	40
40	41	gets an existsing actor
41	42
42	43	Parameters
		@@ -46,9 +47,9 @@
46	47	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
47	48
48	49	## createActor
49	50
50		-[index.js:71-94](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/index.js#L71-L94 "Source code on GitHub")
	51	+[index.js:71-85](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/index.js#L71-L85 "Source code on GitHub")
51	52
52	53	creates an instance of an Actor
53	54
54	55	Parameters
		@@ -58,22 +59,22 @@
58	59	- `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	60
60	61	## createStateRoot
61	62
62		-[index.js:107-110](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/index.js#L107-L110 "Source code on GitHub")
	63	+[index.js:98-101](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/index.js#L98-L101 "Source code on GitHub")
63	64
64	65	creates a state root starting from a given container and a given number of
65	66	ticks
66	67
67	68	Parameters
68	69
69		-- `ticks` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the number of ticks at which to create the state root
	70	+- `ticks` [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the number of ticks at which to create the state root (optional, default `Infinity`)
70	71
71	72	Returns [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
72	73
73	74	## registerContainer
74	75
75		-[index.js:118-123](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/index.js#L118-L123 "Source code on GitHub")
	76	+[index.js:109-114](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/index.js#L109-L114 "Source code on GitHub")
76	77
77	78	regirsters a container with the hypervisor
78	79
79	80	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/46c11229b2dac84739660d8242a0eaa65697f8bc/inbox.js#L23-L31 "Source code on GitHub")
	12	+[inbox.js:23-31](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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/46c11229b2dac84739660d8242a0eaa65697f8bc/inbox.js#L37-L47 "Source code on GitHub")
	25	+[inbox.js:37-47](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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/46c11229b2dac84739660d8242a0eaa65697f8bc/inbox.js#L55-L66 "Source code on GitHub")
	35	+[inbox.js:55-66](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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-110](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/inbox.js#L73-L110 "Source code on GitHub")
	48	+[inbox.js:73-110](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/inbox.js#L73-L110 "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/46c11229b2dac84739660d8242a0eaa65697f8bc/scheduler.js#L14-L20 "Source code on GitHub")
	15	+[scheduler.js:14-20](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/scheduler.js#L14-L20 "Source code on GitHub")
16	16
17	17	The Scheduler manages the actor instances and tracks how many "ticks" they
18	18	have ran.
19	19
20	20	## lock
21	21
22		-[scheduler.js:27-29](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/scheduler.js#L27-L29 "Source code on GitHub")
	22	+[scheduler.js:27-29](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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/46c11229b2dac84739660d8242a0eaa65697f8bc/scheduler.js#L35-L40 "Source code on GitHub")
	34	+[scheduler.js:35-40](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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/46c11229b2dac84739660d8242a0eaa65697f8bc/scheduler.js#L52-L54 "Source code on GitHub")
	44	+[scheduler.js:52-54](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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/46c11229b2dac84739660d8242a0eaa65697f8bc/scheduler.js#L60-L64 "Source code on GitHub")
	56	+[scheduler.js:60-64](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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-84](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/scheduler.js#L73-L84 "Source code on GitHub")
	66	+[scheduler.js:73-84](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/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,9 +76,9 @@
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:90-100](https://github.com/primea/js-primea-hypervisor/blob/46c11229b2dac84739660d8242a0eaa65697f8bc/scheduler.js#L90-L100 "Source code on GitHub")
	80	+[scheduler.js:90-100](https://github.com/primea/js-primea-hypervisor/blob/3ae2283be27509914459ba5c6d1acd9f4cc59b8d/scheduler.js#L90-L100 "Source code on GitHub")
81	81
82	82	returns the oldest container's ticks
83	83
84	84	Parameters

Built with git-ssb-web

wanderer🌟 / js-primea-hypervisor

Commit eaf33c2d3536ae3ec69d335f257a01bfee3f9dd3

rebuild docs

Files changed