Commit dc3270233dd1c56140f13fa0a8f4642baa134d81
updated docs
wanderer committed on 11/21/2017, 11:51:15 PMParent: 54682dbb20afd58e4292b4d018b5724bbdf68516
Files changed
docs/actor.md | changed |
docs/capsManager.md | changed |
docs/hypervisor.md | changed |
docs/inbox.md | changed |
docs/scheduler.md | changed |
docs/actor.md | ||
---|---|---|
@@ -7,31 +7,31 @@ | ||
7 | 7 | - [queue](#queue) |
8 | 8 | - [create](#create) |
9 | 9 | - [shutdown](#shutdown) |
10 | 10 | - [startup](#startup) |
11 | -- [message](#message) | |
11 | +- [runMessage](#runmessage) | |
12 | 12 | - [incrementTicks](#incrementticks) |
13 | 13 | - [createActor](#createactor) |
14 | 14 | - [send](#send) |
15 | 15 | |
16 | 16 | ## constructor |
17 | 17 | |
18 | -[actor.js:15-31](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L15-L31 "Source code on GitHub") | |
18 | +[actor.js:15-31](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L15-L31 "Source code on GitHub") | |
19 | 19 | |
20 | -the Kernel manages the varous message passing functions and provides | |
20 | +the Actor manages the varous message passing functions and provides | |
21 | 21 | an interface for the containers to use |
22 | 22 | |
23 | 23 | **Parameters** |
24 | 24 | |
25 | 25 | - `opts` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** |
26 | - - `opts.id` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the UUID of the Kernel | |
26 | + - `opts.id` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the UUID of the Actor | |
27 | 27 | - `opts.state` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the state of the container |
28 | 28 | - `opts.hypervisor` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the instance of the hypervisor |
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/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L38-L43 "Source code on GitHub") | |
33 | +[actor.js:38-43](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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,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:50-53](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L50-L53 "Source code on GitHub") | |
45 | +[actor.js:50-53](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L50-L53 "Source code on GitHub") | |
46 | 46 | |
47 | 47 | adds a message to this containers 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:60-63](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L60-L63 "Source code on GitHub") | |
56 | +[actor.js:60-66](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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:92-94](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L92-L94 "Source code on GitHub") | |
68 | +[actor.js:95-97](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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:99-101](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L99-L101 "Source code on GitHub") | |
74 | +[actor.js:102-104](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L102-L104 "Source code on GitHub") | |
75 | 75 | |
76 | 76 | Runs the startup routine for the actor |
77 | 77 | |
78 | -## message | |
78 | +## runMessage | |
79 | 79 | |
80 | -[actor.js:109-130](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L109-L130 "Source code on GitHub") | |
80 | +[actor.js:112-132](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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,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:136-139](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L136-L139 "Source code on GitHub") | |
93 | +[actor.js:138-141](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/actor.js#L138-L141 "Source code on GitHub") | |
94 | 94 | |
95 | 95 | updates the number of ticks that the container 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:146-149](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L146-L149 "Source code on GitHub") | |
103 | +[actor.js:148-151](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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:166-172](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/actor.js#L166-L172 "Source code on GitHub") | |
114 | +[actor.js:168-174](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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.md | ||
---|---|---|
@@ -8,45 +8,50 @@ | ||
8 | 8 | - [delete](#delete) |
9 | 9 | |
10 | 10 | ## constructor |
11 | 11 | |
12 | -[capsManager.js:7-10](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/capsManager.js#L7-L10 "Source code on GitHub") | |
12 | +[capsManager.js:10-12](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/capsManager.js#L10-L12 "Source code on GitHub") | |
13 | 13 | |
14 | -The caps manager manages perstantly stores the capabilities | |
14 | +The port manager manages the the ports. This inculdes creation, deletion | |
15 | 15 | fetching and waiting on ports |
16 | 16 | |
17 | 17 | **Parameters** |
18 | 18 | |
19 | -- `caps` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** | |
19 | +- `caps` | |
20 | +- `opts` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** | |
21 | + - `opts.state` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** | |
22 | + - `opts.hypervisor` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** | |
23 | + - `opts.exoInterface` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** | |
20 | 24 | |
21 | 25 | ## store |
22 | 26 | |
23 | -[capsManager.js:17-19](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/capsManager.js#L17-L19 "Source code on GitHub") | |
27 | +[capsManager.js:19-22](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/capsManager.js#L19-L22 "Source code on GitHub") | |
24 | 28 | |
25 | -Stores a capability persistantly | |
29 | +binds a port to a name | |
26 | 30 | |
27 | 31 | **Parameters** |
28 | 32 | |
29 | -- `key` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** | |
30 | -- `cap` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** | |
33 | +- `name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the port | |
34 | +- `cap` | |
35 | +- `port` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** the port to bind | |
31 | 36 | |
32 | 37 | ## get |
33 | 38 | |
34 | -[capsManager.js:26-29](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/capsManager.js#L26-L29 "Source code on GitHub") | |
39 | +[capsManager.js:29-32](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/capsManager.js#L29-L32 "Source code on GitHub") | |
35 | 40 | |
36 | -gets a cap given it's key | |
41 | +gets a port given it's name | |
37 | 42 | |
38 | 43 | **Parameters** |
39 | 44 | |
40 | -- `key` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** | |
45 | +- `name` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** | |
41 | 46 | |
42 | 47 | Returns **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** |
43 | 48 | |
44 | 49 | ## delete |
45 | 50 | |
46 | -[capsManager.js:35-37](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/capsManager.js#L35-L37 "Source code on GitHub") | |
51 | +[capsManager.js:38-40](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/capsManager.js#L38-L40 "Source code on GitHub") | |
47 | 52 | |
48 | -delete an cap given its key | |
53 | +delete an port given the name it is bound to | |
49 | 54 | |
50 | 55 | **Parameters** |
51 | 56 | |
52 | -- `key` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** | |
57 | +- `name` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** |
docs/hypervisor.md | ||
---|---|---|
@@ -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/1623d0570d9d2c2c1859ca73c05054596cccf553/index.js#L10-L15 "Source code on GitHub") | |
14 | +[index.js:10-15](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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/1623d0570d9d2c2c1859ca73c05054596cccf553/index.js#L23-L27 "Source code on GitHub") | |
25 | +[index.js:23-27](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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/1623d0570d9d2c2c1859ca73c05054596cccf553/index.js#L52-L63 "Source code on GitHub") | |
38 | +[index.js:52-63](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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/1623d0570d9d2c2c1859ca73c05054596cccf553/index.js#L71-L95 "Source code on GitHub") | |
50 | +[index.js:71-95](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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/1623d0570d9d2c2c1859ca73c05054596cccf553/index.js#L108-L111 "Source code on GitHub") | |
62 | +[index.js:108-111](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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,13 +71,13 @@ | ||
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/1623d0570d9d2c2c1859ca73c05054596cccf553/index.js#L119-L124 "Source code on GitHub") | |
75 | +[index.js:119-124](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/index.js#L119-L124 "Source code on GitHub") | |
76 | 76 | |
77 | 77 | regirsters a container with the hypervisor |
78 | 78 | |
79 | 79 | **Parameters** |
80 | 80 | |
81 | 81 | - `Constructor` **Class** a Class for instantiating the container |
82 | 82 | - `args` **any** any args that the contructor takes |
83 | -- `typeId` **Interger** the container's type identification ID (optional, default `Constructor.typeId`) | |
83 | +- `typeId` **Integer** the container's type identification ID (optional, default `Constructor.typeId`) |
docs/inbox.md | ||
---|---|---|
@@ -3,14 +3,14 @@ | ||
3 | 3 | ### Table of Contents |
4 | 4 | |
5 | 5 | - [constructor](#constructor) |
6 | 6 | - [queue](#queue) |
7 | -- [waitOnTag](#waitontag) | |
8 | -- [getNextMessage](#getnextmessage) | |
7 | +- [nextTaggedMessage](#nexttaggedmessage) | |
8 | +- [nextMessage](#nextmessage) | |
9 | 9 | |
10 | 10 | ## constructor |
11 | 11 | |
12 | -[inbox.js:12-20](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/inbox.js#L12-L20 "Source code on GitHub") | |
12 | +[inbox.js:23-31](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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,19 +21,19 @@ | ||
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:26-36](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/inbox.js#L26-L36 "Source code on GitHub") | |
25 | +[inbox.js:37-47](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/inbox.js#L37-L47 "Source code on GitHub") | |
26 | 26 | |
27 | 27 | queues a message |
28 | 28 | |
29 | 29 | **Parameters** |
30 | 30 | |
31 | 31 | - `message` **Message** |
32 | 32 | |
33 | -## waitOnTag | |
33 | +## nextTaggedMessage | |
34 | 34 | |
35 | -[inbox.js:44-59](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/inbox.js#L44-L59 "Source code on GitHub") | |
35 | +[inbox.js:55-66](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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** |
@@ -42,11 +42,11 @@ | ||
42 | 42 | - `timeout` **Integer** |
43 | 43 | |
44 | 44 | Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** |
45 | 45 | |
46 | -## getNextMessage | |
46 | +## nextMessage | |
47 | 47 | |
48 | -[inbox.js:66-95](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/inbox.js#L66-L95 "Source code on GitHub") | |
48 | +[inbox.js:73-109](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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.md | ||
---|---|---|
@@ -11,16 +11,16 @@ | ||
11 | 11 | - [leastNumberOfTicks](#leastnumberofticks) |
12 | 12 | |
13 | 13 | ## constructor |
14 | 14 | |
15 | -[scheduler.js:10-19](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/scheduler.js#L10-L19 "Source code on GitHub") | |
15 | +[scheduler.js:14-20](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L14-L20 "Source code on GitHub") | |
16 | 16 | |
17 | 17 | The Scheduler manages the run cycle of Actors and figures out which |
18 | 18 | order they should run in |
19 | 19 | |
20 | 20 | ## lock |
21 | 21 | |
22 | -[scheduler.js:26-28](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/scheduler.js#L26-L28 "Source code on GitHub") | |
22 | +[scheduler.js:27-29](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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:34-39](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/scheduler.js#L34-L39 "Source code on GitHub") | |
34 | +[scheduler.js:35-40](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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:51-53](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/scheduler.js#L51-L53 "Source code on GitHub") | |
44 | +[scheduler.js:52-54](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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:59-63](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/scheduler.js#L59-L63 "Source code on GitHub") | |
56 | +[scheduler.js:60-64](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/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:72-86](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/scheduler.js#L72-L86 "Source code on GitHub") | |
66 | +[scheduler.js:73-83](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L73-L83 "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:92-101](https://github.com/primea/js-primea-hypervisor/blob/1623d0570d9d2c2c1859ca73c05054596cccf553/scheduler.js#L92-L101 "Source code on GitHub") | |
80 | +[scheduler.js:89-98](https://github.com/primea/js-primea-hypervisor/blob/54682dbb20afd58e4292b4d018b5724bbdf68516/scheduler.js#L89-L98 "Source code on GitHub") | |
81 | 81 | |
82 | 82 | returns the oldest container's ticks |
83 | 83 | |
84 | 84 | **Parameters** |
Built with git-ssb-web