entangld 2.4.1 → 2.7.0

package/test/timeouts.js

@@ -0,0 +1,173 @@
+const assert = require("assert");
+const Entangld = require("../lib/Datastore.js");
+const { EntangldError, EntangldTimeoutError } = require("../lib/error.js");
+
+const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+
+// Resolve to the error a promise rejects with, or fail if it resolves
+function rejection(promise) {
+    return promise.then(
+        (val) => assert.fail(`Expected a rejection, got ${val}`),
+        (err) => err
+    );
+}
+
+// Attach store b to store a. Messages from a are delivered only if allow(msg)
+function linked_stores(allow = () => true) {
+    const a = new Entangld();
+    const b = new Entangld();
+
+    a.transmit((msg, store) => {
+        if (allow(msg)) store.receive(msg, a);
+    });
+    b.transmit((msg, store) => store.receive(msg, b));
+
+    a.attach("b", b);
+    b.attach("a", a);
+
+    return { a, b };
+}
+
+describe("Timeouts", () => {
+
+    describe("get", () => {
+
+        it("rejects if a remote store never replies", async () => {
+            const { a } = linked_stores(() => false);
+
+            const err = await rejection(a.get("b.value", undefined, { timeout_ms: 10 }));
+
+            assert(err instanceof EntangldTimeoutError);
+            assert(err instanceof EntangldError);
+            assert.strictEqual(err.name, "EntangldTimeoutError");
+            assert.strictEqual(err.path, "b.value");
+            assert.strictEqual(err.timeout_ms, 10);
+        });
+
+        it("removes the request after timing out", async () => {
+            const { a } = linked_stores(() => false);
+
+            await rejection(a.get("b.value", undefined, { timeout_ms: 10 }));
+
+            assert.strictEqual(Object.keys(a._requests).length, 0);
+        });
+
+        it("resolves if the reply beats the timeout", async () => {
+            const { a, b } = linked_stores();
+            b.set("value", 7);
+
+            const value = await a.get("b.value", undefined, { timeout_ms: 1000 });
+
+            assert.strictEqual(value, 7);
+            assert.strictEqual(Object.keys(a._requests).length, 0);
+        });
+
+        it("ignores a reply which arrives after the timeout", async () => {
+            const { a, b } = linked_stores(() => false);
+            const sent = [];
+            a.transmit((msg) => sent.push(msg));
+
+            await rejection(a.get("b.value", undefined, { timeout_ms: 10 }));
+
+            assert.doesNotThrow(() => {
+                a.receive({ type: "value", uuid: sent[0].uuid, value: 1 }, b);
+            });
+        });
+
+        it("passes params through and keeps options off the wire", async () => {
+            const sent = [];
+            const { a, b } = linked_stores((msg) => {
+                sent.push(JSON.stringify(msg));
+                return true;
+            });
+            b.set("echo", (params) => params);
+
+            const value = await a.get("b.echo", ["x"], { timeout_ms: 1000 });
+
+            assert.deepStrictEqual(value, ["x"]);
+            assert(!sent.join("").includes("timeout_ms"));
+        });
+
+        it("rejects if a local function never settles", async () => {
+            const a = new Entangld();
+            a.set("hang", () => new Promise(() => { }));
+
+            const err = await rejection(a.get("hang", undefined, { timeout_ms: 10 }));
+
+            assert(err instanceof EntangldTimeoutError);
+        });
+
+        it("resolves if a local function beats the timeout", async () => {
+            const a = new Entangld();
+            a.set("slow", () => wait(1).then(() => 8));
+
+            assert.strictEqual(await a.get("slow", undefined, { timeout_ms: 1000 }), 8);
+        });
+
+        it("keeps the original error if a local function rejects", async () => {
+            const a = new Entangld();
+            a.set("bad", () => Promise.reject(new Error("boom")));
+
+            const err = await rejection(a.get("bad", undefined, { timeout_ms: 1000 }));
+
+            assert.strictEqual(err.message, "boom");
+        });
+
+        it("returns local data", async () => {
+            const a = new Entangld();
+            a.set("value", 3);
+
+            assert.strictEqual(await a.get("value", undefined, { timeout_ms: 10 }), 3);
+        });
+
+        it("never settles a lost reply without timeout_ms", async () => {
+            const { a } = linked_stores(() => false);
+            let settled = false;
+
+            a.get("b.value").finally(() => {
+                settled = true;
+            });
+            await wait(20);
+
+            assert.strictEqual(settled, false);
+            assert.strictEqual(Object.keys(a._requests).length, 1);
+        });
+
+        it("throws on an invalid timeout_ms", () => {
+            const a = new Entangld();
+
+            for (const timeout_ms of [0, -1, NaN, Infinity, 2147483648, "5", null]) {
+                assert.throws(() => a.get("value", undefined, { timeout_ms }), TypeError);
+            }
+        });
+    });
+
+    describe("call_rpc", () => {
+
+        it("rejects if a remote store never replies", async () => {
+            const { a } = linked_stores(() => false);
+
+            const err = await rejection(a.call_rpc("b.rpc", [1], { timeout_ms: 10 }));
+
+            assert(err instanceof EntangldTimeoutError);
+            assert.strictEqual(err.path, "b.rpc");
+        });
+
+        it("returns the result if the reply beats the timeout", async () => {
+            const { a, b } = linked_stores();
+            b.set_rpc("double", (value) => value * 2);
+
+            const value = await a.call_rpc("b.double", [4], { timeout_ms: 1000 });
+
+            assert.strictEqual(value, 8);
+        });
+
+        it("rejects on an invalid timeout_ms", async () => {
+            const a = new Entangld();
+
+            const err = await rejection(a.call_rpc("rpc", [], { timeout_ms: 0 }));
+
+            assert(err instanceof TypeError);
+        });
+    });
+});

package/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "libraries/unix/extern/json"]
-	path = libraries/unix/extern/json
-	url = https://github.com/nlohmann/json.git

package/README.hbs

@@ -1,190 +0,0 @@
-# Entangld
-
-Synchronized key-value stores with RPCs and pub/sub events.  Works over sockets (try it with [Sockhop](https://www.npmjs.com/package/sockhop "Sockhop on NPM")!)
-
-## Examples
-Basic use:
-```js
-    let e=new Entangld();
-
-    // Simple set/get
-    e.set("number.six",6);
-    e.get("number.six").then((val)=>{});     // val==6
-
-    // Functions as values
-    e._deref_mode=true;    // Or pass to constructor: new Entangld({ deref_mode: true });
-    e.set("number.seven",()=>{ return 7;});
-    e.get("number").then((val)=>{});         // val => { six:6, seven, 7}
-
-    // Promises from functions
-    e.set("number.eight",()=>{ return new Promise((resolve)=>{ resolve(8); }); });
-    e.get("number.eight").then((val)=>{});     // val==8
-
-    // Even dereference beneath functions
-    e.set("eenie.meenie",()=>{ return {"miney": "moe"}; });
-    e.get("eenie.meenie.miney").then((val)=>{});    // val=="moe"
-    
-```
-
-Pairing two data stores together:
-```js
-    let parent=new Entangld();
-    let child=new Entangld();
-
-    // Attach child namespace
-    parent.attach("child",child);
-
-    // Configure communications
-    parent.transmit((msg, store) => store.receive(msg,parent)); // store will always be child
-    child.transmit((msg, store) => store.receive(msg, child)); // store will always be parent
-
-    // Set something in the child...
-    child.set("system.voltage",33);
-
-    // Get it back in the parent
-    parent.get("child.system.voltage");        // == 33
-```
-Using getter functions as RPC:
-```js
-    // Assign a function to a child key
-    child.set("double.me",(param=0)=>param*2);    // Or we could return a Promise instead of a value, if we wanted to!
-
-    // Call the RPC from the parent
-    parent.get("child.double.me", 2).then((val)=>{
-
-        // val == 4
-    });
-
-```
-Note in this example how we set a default value for this getter function (0).  This is because when _deref_mode is ```true``` this getter will be called without any arguments.
-
-Pub/sub (remote events):
-```js
-    // Assign an event callback
-    parent.subscribe("child.system.voltage",(path, val)=>{
-
-        // path=="child.system.voltage"
-        // val==21
-    });
-
-    // Trigger a callback on the parent
-    child.set("system.voltage",21);
-
-
-    // Listen on the child for when the parent subscribes
-    child.on("subscription", ( path, uuid ) => console.log("Parent subscribed to :" + path));
-    parent.subscribe("child.system.voltage"); // Child prints: "Parent subscribed to : system.voltage"
-
-    // Throttle the subscription callbacks, so that the callback is only called every 2 sets
-    let counter = 0;
-    parent.subscribe("child.rapid.data", () => counter += 1, 2);
-    child.set("rapid.data", 1) // triggers callback
-    child.set("rapid.data", 1) // doesn't trigger callback
-    child.set("rapid.data", 1) // triggers callback
-    child.set("rapid.data", 1) // doesn't trigger callback
-    console.log( counter ); // === 2
-
-```
-Over sockets:
-```js
-    const Sockhop=require("sockhop");
-    const Entangld=require("entangld");
-
-
-    /**
-     * Parent / server setup
-     */
-
-    let parent=new Entangld();
-    let server=new Sockhop.server();
-
-    // Connect server to parent store
-    parent.transmit((msg, store)=>server.send(store, msg));
-    server
-        .on("receive",(data, meta)=>parent.receive(data, meta.sock))        // Use the socket as the data store handle
-        .on('connect',(sock)=>{
-
-            parent.attach("client", sock);                    // "client" works for one client.  Normally use uuid() or something
-
-            parent.get("client.my.name")
-                .then((val)=>{
-
-                    console.log("Client's name is "+val);
-                    server.close();
-                });
-        })
-        .on('disconnect', (sock)=>parent.detach(null, sock))
-        .on('error', (e)=>console.log("Sockhop error: "+e))
-        .listen();
-
-
-    /**
-     * Child / client setup
-     */
-
-    let child=new Entangld();
-    let client=new Sockhop.client();
-
-    // Connect client to child store
-    child.transmit((msg)=>client.send(msg));
-    client
-        .on("receive", (data, meta)=>child.receive(data))
-        .on("connect", ()=>{
-            // attach() to parent is optional, if we plan to get() parent items
-        })
-        .on("error", (e)=>console.log("Sockhop error: "+e))
-        .connect();
-
-    child.set("my.name", "Entangld");
-```
-
-
-## Raison d'etre
-Any object can store values.  And a Map can store values keyed to objects.  But what if you want to....
-
-- Have your store synchronized with multiple data sources (other stores)?
-- Over a network?
-- Subscribe to events within the datastore?
-- Support subscription wildcards?
-
-## Notes
-
-- As of version 2.0.0, subscriptions all have uuids (which are the same across a chain of subscription objects, in the case of subscriptions to remote datastores), which supports multiple (remote or local) subscriptions to the same endpoint, but with different callback functions. The uuid of a subscription is available in the subscription object (a list of which is exposed from the datastore via `store.owned_subscriptions()`), and is also returned from the method call `store.subscribe("path.to.data")`. Having access to this uuid also allows the user to cancel specific subscriptions. The method call `store.unsubscribe(...)` will now either accept a path or a uuid. For paths, the method will terminate _all_ subscriptions matching that path, while for uuids, only the specific subscription matching that uuid will be canceled.
-- As of version 1.5.0, subscriptions may be created across multiple chained datastores.  Subscription removal now acts on all subscriptions matching (but not beneath) a given path.  To unsubscribe a tree, use ```unsubscribe_tree()```
-- As of version 1.2.0, attached datastores may be located at arbitrary paths, not just in the root:
-```parent.attach("child.goes.here", child);```
-- Also as of 1.2.0, attach()ed child stores will appear in the parent as placeholders (empty objects) when .get() is called on paths within the parent.  For example:
-```
-child.set("",{"child" : "data" });
-parent.set("",{"parent" : "data"});
-parent.attach("child", child);
-
-parent.get("");     // Returns { "parent" : "data", "child" : {} }
-parent.get("child"); // Returns {"child" : "data"}
-```
-This is because we would have to perform recursive child queries to show you a complete tree.   This is left for a future version.
-- If you ```.set()``` a function, that function may return a value or a Promise.  If it returns a promise, that promise will be returned directly to you when you call ```.get()```
-- As of version 1.4.0, you may subscribe() to a local event.  This should probably be eventually replaced with native events.  In other words, instead of ```.subscribe("a.b.c", callback)``` we should use ```.on("path.a.b.c", callback)```
-
-## _deref_mode
-If you attach a key to a getter function instead of a value, that function would never be called until you request that key directly (i.e. querying the parent of that key would not reveal that that key exists).  This changed in 1.2.1, when _deref_mode was introduced.  If you set _deref_mode to true, it will iterate all leaves and try to call all functions.  Those that return Promise will have their Promise resolved before the result is actually returned.
-
-This is pretty cool, and after consideration it is probably the way this thing should work all the time.  However it also introduces two problems which are not yet resolved (//TODO):
-
-First, in an effort to not accidentally mutate the original data set, a copy is made.  This is somewhat inefficient.
-Second, when the copy is made, JSON.parse/JSON.stringify are used.  This means that leaves consisting of Map() or the like are just erased.
-
-If these two issues can be resolved at some point, _deref_mode will probably be turned on permanently.  Honestly, for remote stores operating over sockets it's probably not a huge issue.  More to the point are local stores where the user might be storing non JSON-compatible items.
-
-{{>main}}
-
-## TODO
-- Make sure incoming values request store doesn't build up
-- When querying a parent, perhaps there should be an option to also dump child stores located below that level (potentially resource intensive)
-- Fix _deref_mode so it doesn't "strip" the returned object by turning everything to JSON and back (inefficient and it's basically mutating the result silently)
-- Fix unit tests so they are completely independent (tests often depend on prior test ending with a particular state)
-- Detaching a store does not unsubscribe to any subscriptions from or through that store and may therefore leave things in a dirty or unstable state.  We could unsubscribe_tree(store_name) but that would not take care of passthrough subscriptions (those that don't belong to us)
-- unsubscribe_tree() needs to have a test ensuring errors are thrown if not all subs can be removed
-
-## License
-MIT

package/tags

@@ -1,244 +0,0 @@
-!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
-!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
-!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
-!_TAG_PROGRAM_NAME	Exuberant Ctags	//
-!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
-!_TAG_PROGRAM_VERSION	5.9~svn20110310	//
-DEBUG_ERROR	libraries/unix/samples/debug.h	27;"	d	line:27	language:C++
-DEBUG_H_	libraries/unix/samples/debug.h	9;"	d	line:9	language:C++
-DEBUG_INFO	libraries/unix/samples/debug.h	39;"	d	line:39	language:C++
-DEBUG_LEVEL_ERROR	libraries/unix/samples/debug.h	15;"	d	line:15	language:C++
-DEBUG_LEVEL_INFO	libraries/unix/samples/debug.h	17;"	d	line:17	language:C++
-DEBUG_LEVEL_VERBOSE	libraries/unix/samples/debug.h	18;"	d	line:18	language:C++
-DEBUG_LEVEL_WARN	libraries/unix/samples/debug.h	16;"	d	line:16	language:C++
-DEBUG_VERBOSE	libraries/unix/samples/debug.h	45;"	d	line:45	language:C++
-DEBUG_WARN	libraries/unix/samples/debug.h	33;"	d	line:33	language:C++
-DEFAULT_HOST	libraries/unix/samples/client.cpp	/^constexpr char DEFAULT_HOST[] = "127.0.0.1";    \/**< Default host address. *\/$/;"	v	line:17	language:C++
-DEFAULT_PORT	libraries/unix/samples/client.cpp	/^constexpr int DEFAULT_PORT = 50001;             \/**< Default host port. *\/$/;"	v	line:18	language:C++
-DEFAULT_PORT	libraries/unix/samples/server.cpp	/^constexpr int DEFAULT_PORT = 50001;$/;"	v	line:18	language:C++
-DEFAULT_TIMEOUT	libraries/unix/samples/client.cpp	/^constexpr int DEFAULT_TIMEOUT = 2000;           \/**< Default timeout. *\/$/;"	v	line:19	language:C++
-Datastore	libraries/unix/include/Datastore.h	/^            explicit Datastore(const nlohmann::json &data = nlohmann::json::object())$/;"	f	line:28	language:C++	class:entangld::Datastore	access:public	signature:(const nlohmann::json &data = nlohmann::json::object())
-Datastore	libraries/unix/include/Datastore.h	/^    class Datastore {$/;"	c	line:22	language:C++	namespace:entangld
-Entangld	index.js	/^class Entangld extends EventEmitter {$/;"	C	line:572	language:JavaScript
-EntangldError	index.js	/^class EntangldError extends Error {$/;"	C	line:153	language:JavaScript
-Entangld_Message	index.js	/^class Entangld_Message {$/;"	C	line:33	language:JavaScript
-FIXME	test/sockets.js	/^\/\/ FIXME : comment out for debugging$/;"	T	line:9	language:JavaScript
-Message	libraries/unix/include/Message.h	/^    class Message {$/;"	c	line:17	language:C++	namespace:entangld
-Subscription	index.js	/^class Subscription {$/;"	C	line:166	language:JavaScript
-TODO	test/tests.js	/^	\/\/ TODO: Add a triple multiplexed store test$/;"	T	line:588	language:JavaScript
-VERSION	libraries/unix/samples/server.cpp	/^constexpr char VERSION[] = "1.0.0";$/;"	v	line:15	language:C++
-_ENTANGLD_DATASTORE_H_	libraries/unix/include/Datastore.h	9;"	d	line:9	language:C++
-_ENTANGLD_MESSAGE_H_	libraries/unix/include/Message.h	9;"	d	line:9	language:C++
-_get_remote_object	index.js	/^    _get_remote_object(path) {$/;"	M	line:915	language:JavaScript
-_has_cb	index.js	/^        this._has_cb = (typeof(callback) === "function");$/;"	M	line:189	language:JavaScript
-_is_counting	index.js	/^        this._is_counting = (this.downstream === null);$/;"	M	line:190	language:JavaScript
-_local_data	index.js	/^        this._local_data = {};$/;"	P	line:581	language:JavaScript
-_requests	index.js	/^        this._requests = {};$/;"	P	line:582	language:JavaScript
-_set_local	index.js	/^    _set_local(path, data, op_type="set", params={}) {$/;"	M	line:1276	language:JavaScript
-_subscribe	index.js	/^    _subscribe(path, func, upstream = null, uuid = null, every = null) {$/;"	M	line:1090	language:JavaScript
-_transmit	index.js	/^        this._transmit = () => { };$/;"	M	line:580	language:JavaScript
-_unsubscribe	index.js	/^    _unsubscribe(subscriptions) {$/;"	M	line:1240	language:JavaScript
-a	test/tests.js	/^			a: {$/;"	P	line:13	language:JavaScript
-a	test/tests.js	/^			a: {$/;"	P	line:243	language:JavaScript
-address	test/sockets.js	/^                address : "localhost",$/;"	P	line:129	language:JavaScript
-address	test/sockets.js	/^            address : "localhost",$/;"	P	line:20	language:JavaScript
-address	test/sockets.js	/^            address : "localhost",$/;"	P	line:25	language:JavaScript
-afterEach	test/circular.js	/^    afterEach(function() {$/;"	M	line:25	language:JavaScript
-afterEach	test/sockets.js	/^    afterEach(function() {$/;"	M	line:48	language:JavaScript
-afterEach	test/subscriptions.js	/^    afterEach(function() {$/;"	M	line:21	language:JavaScript
-attach	index.js	/^    attach(namespace, obj) {$/;"	M	line:642	language:JavaScript
-attach	libraries/unix/src/Datastore.cpp	/^    void Datastore::attach($/;"	f	line:232	language:C++	class:entangld::Datastore	signature:( std::string name, void (*handler)(const Message &msg, void *ctx), void *ctx)
-b	test/tests.js	/^				b: {$/;"	P	line:14	language:JavaScript
-b	test/tests.js	/^				b: {$/;"	P	line:244	language:JavaScript
-beforeEach	test/circular.js	/^    beforeEach(function() {$/;"	M	line:10	language:JavaScript
-beforeEach	test/sockets.js	/^    beforeEach(function() {$/;"	M	line:15	language:JavaScript
-beforeEach	test/subscriptions.js	/^    beforeEach(function() {$/;"	M	line:7	language:JavaScript
-c	test/tests.js	/^					c: 6$/;"	P	line:15	language:JavaScript
-c	test/tests.js	/^					c: 6$/;"	P	line:245	language:JavaScript
-c	test/tests.js	/^		          c: {},$/;"	P	line:540	language:JavaScript
-call	index.js	/^    call(...args) {$/;"	M	line:213	language:JavaScript
-callback	index.js	/^            callback : func,$/;"	P	line:1109	language:JavaScript
-callback	libraries/unix/include/Datastore.h	/^                void (*callback)(const Message &msg, void *ctx);$/;"	m	line:128	language:C++	struct:entangld::Datastore::__anon2	access:public
-callback_ctx	libraries/unix/include/Datastore.h	/^                void *callback_ctx;$/;"	m	line:131	language:C++	struct:entangld::Datastore::__anon2	access:public
-constructor	index.js	/^    constructor() {$/;"	M	line:574	language:JavaScript
-constructor	index.js	/^    constructor(message) {$/;"	M	line:154	language:JavaScript
-constructor	index.js	/^    constructor({path, uuid, callback, downstream, upstream, every}) {$/;"	M	line:183	language:JavaScript
-constructor	index.js	/^    constructor({type, path, value, uuid, params, every}) {$/;"	M	line:35	language:JavaScript
-d	test/tests.js	/^			d: {$/;"	P	line:18	language:JavaScript
-d	test/tests.js	/^			d: {$/;"	P	line:248	language:JavaScript
-debug_print	libraries/unix/samples/debug.c	/^void debug_print(int level, const char *file, int line, const char *format, ...)$/;"	f	line:27	language:C	signature:(int level, const char *file, int line, const char *format, ...)
-dereferenced_copy	index.js	/^function dereferenced_copy(original) {$/;"	F	line:388	language:JavaScript
-describe	test/circular.js	/^describe("Circular References", function() {$/;"	M	line:7	language:JavaScript
-describe	test/sockets.js	/^describe("Sockets", function() {$/;"	M	line:12	language:JavaScript
-describe	test/subscriptions.js	/^describe("Subscription", function() {$/;"	M	line:4	language:JavaScript
-detach	index.js	/^    detach(namespace, obj) {$/;"	M	line:687	language:JavaScript
-detach	libraries/unix/src/Datastore.cpp	/^    void Datastore::detach(std::string name)$/;"	f	line:245	language:C++	class:entangld::Datastore	signature:(std::string name)
-downstream	index.js	/^            downstream : (this.downstream === null ? null : true),$/;"	M	line:366	language:JavaScript
-downstream	index.js	/^            downstream : obj,$/;"	P	line:1106	language:JavaScript
-e	test/tests.js	/^				e: [$/;"	P	line:19	language:JavaScript
-e	test/tests.js	/^				e: {$/;"	P	line:249	language:JavaScript
-entangld	libraries/unix/include/Datastore.h	/^namespace entangld$/;"	n	line:19	language:C++
-entangld	libraries/unix/include/Message.h	/^namespace entangld$/;"	n	line:14	language:C++
-entangld	libraries/unix/src/Datastore.cpp	/^namespace entangld$/;"	n	line:38	language:C++	file:
-event	index.js	/^    static event(path, value, uuid) {$/;"	M	line:125	language:JavaScript
-every	index.js	/^            every : every$/;"	P	line:1110	language:JavaScript
-every	index.js	/^        every : every$/;"	P	line:113	language:JavaScript
-extract_from_path	index.js	/^function extract_from_path(obj, path) {$/;"	F	line:464	language:JavaScript
-eyes	test/tests.js	/^		        eyes: "blue",$/;"	P	line:538	language:JavaScript
-eyes	test/tests.js	/^		        eyes: "blue",$/;"	P	line:577	language:JavaScript
-f	test/tests.js	/^						f: {$/;"	P	line:21	language:JavaScript
-f	test/tests.js	/^					f: 7$/;"	P	line:250	language:JavaScript
-from_json	libraries/unix/include/Message.h	/^    static void from_json(const nlohmann::json &j, Message &msg)$/;"	f	line:48	language:C++	namespace:entangld	signature:(const nlohmann::json &j, Message &msg)
-g	test/tests.js	/^							g: 7$/;"	P	line:22	language:JavaScript
-g_debug_level	libraries/unix/samples/debug.c	/^static int g_debug_level = 0;$/;"	v	line:12	language:C	file:
-g_shutdown_flag	libraries/unix/samples/client.cpp	/^volatile bool g_shutdown_flag = false;$/;"	v	line:22	language:C++
-g_shutdown_flag	libraries/unix/samples/server.cpp	/^volatile bool g_shutdown_flag = false;$/;"	v	line:21	language:C++
-get	index.js	/^    get(path, params) {$/;"	M	line:955	language:JavaScript
-get	index.js	/^    static get(tree, get_params) {$/;"	M	line:56	language:JavaScript
-get	libraries/unix/src/Datastore.cpp	/^    void Datastore::get($/;"	f	line:47	language:C++	class:entangld::Datastore	signature:( std::string path, void (*callback)(const Message &msg, void *ctx), void *callback_ctx, std::string uuid)
-get_uuidstring	libraries/unix/src/Datastore.cpp	/^static std::string get_uuidstring()$/;"	f	line:14	language:C++	file:	signature:()
-h	test/tests.js	/^			h: 4$/;"	P	line:27	language:JavaScript
-handler	libraries/unix/include/Datastore.h	/^                Message::handler_t handler; \/**< Send a Message to this remote. *\/$/;"	m	line:112	language:C++	struct:entangld::Datastore::__anon1	access:public
-handler_ctx	libraries/unix/include/Datastore.h	/^                void *handler_ctx;          \/**< User context passed to handler. *\/$/;"	m	line:113	language:C++	struct:entangld::Datastore::__anon1	access:public
-handler_t	libraries/unix/include/Message.h	/^            typedef void (*handler_t)(const Message &msg, void *ctx);$/;"	t	line:20	language:C++	class:entangld::Message	access:public
-has_downstream	index.js	/^    get has_downstream() {$/;"	M	line:263	language:JavaScript
-has_upstream	index.js	/^    get has_upstream() {$/;"	M	line:275	language:JavaScript
-if	index.js	/^                if(params.limit) {$/;"	M	line:1316	language:JavaScript
-index	index.js	/^            this.index = (this.index + 1) % this.every;$/;"	M	line:216	language:JavaScript
-is_above	index.js	/^    is_above(path) {$/;"	M	line:349	language:JavaScript
-is_beneath	index.js	/^    is_beneath(path) {$/;"	M	line:339	language:JavaScript
-is_beneath	index.js	/^function is_beneath(a, b) {$/;"	F	line:545	language:JavaScript
-is_head	index.js	/^    get is_head() {$/;"	M	line:250	language:JavaScript
-is_pass_through	index.js	/^    get is_pass_through() {$/;"	M	line:232	language:JavaScript
-is_terminal	index.js	/^    get is_terminal() {$/;"	M	line:241	language:JavaScript
-it	test/circular.js	/^    it("Circular subscriptions don't break", function(done) {$/;"	M	line:31	language:JavaScript
-it	test/sockets.js	/^    it("Can get", function(done) {$/;"	M	line:70	language:JavaScript
-it	test/sockets.js	/^    it("Can remove subs for persistant sockets", function(done) {$/;"	M	line:82	language:JavaScript
-it	test/sockets.js	/^    it("Can remove subs for reconnected sockets", function(done) {$/;"	M	line:113	language:JavaScript
-it	test/sockets.js	/^    it("Can subscribe", function(done) {$/;"	M	line:56	language:JavaScript
-it	test/sockets.js	/^    it("Cannot remove subs for dropped sockets", function(done) {$/;"	M	line:97	language:JavaScript
-it	test/subscriptions.js	/^    it("Can have parallel subscriptions (locallly)", function(done) {$/;"	M	line:117	language:JavaScript
-it	test/subscriptions.js	/^    it("Can have parallel subscriptions (locallly)", function(done) {$/;"	M	line:161	language:JavaScript
-it	test/subscriptions.js	/^    it("Can have parallel subscriptions (remote)", function(done) {$/;"	M	line:175	language:JavaScript
-it	test/subscriptions.js	/^    it("Emit on each subscription", function(done) {$/;"	M	line:104	language:JavaScript
-it	test/subscriptions.js	/^    it("Should emit on recieved subscriptions (locally)", function(done) {$/;"	M	line:37	language:JavaScript
-it	test/subscriptions.js	/^    it("Should emit on recieved subscriptions (remote)", function(done) {$/;"	M	line:53	language:JavaScript
-it	test/subscriptions.js	/^    it("Should emit on recieved unsubscriptions (locally)", function(done) {$/;"	M	line:44	language:JavaScript
-it	test/subscriptions.js	/^    it("Should emit on recieved unsubscriptions (remote)", function(done) {$/;"	M	line:60	language:JavaScript
-it	test/subscriptions.js	/^    it("Should only trigger subscriptions on an exact match", function(done) {$/;"	M	line:27	language:JavaScript
-it	test/subscriptions.js	/^    it("Shouldn't emit on passthrough subscriptions (remote)", function(done) {$/;"	M	line:86	language:JavaScript
-it	test/subscriptions.js	/^    it("Shouldn't emit on passthrough unsubscriptions (remote)", function(done) {$/;"	M	line:94	language:JavaScript
-it	test/subscriptions.js	/^    it("Shouldn't emit on sent subscriptions (remote)", function(done) {$/;"	M	line:69	language:JavaScript
-it	test/subscriptions.js	/^    it("Shouldn't emit on sent unsubscriptions (remote)", function(done) {$/;"	M	line:77	language:JavaScript
-log	test/sockets.js	/^console.log = () => {};$/;"	M	line:10	language:JavaScript
-long_shared	libraries/unix/samples/client.cpp	/^static struct option long_shared[] = {$/;"	v	line:25	language:C++	typeref:struct:option	file:
-long_shared	libraries/unix/samples/server.cpp	/^static struct option long_shared[] = {$/;"	v	line:24	language:C++	typeref:struct:option	file:
-m_local_data	libraries/unix/include/Datastore.h	/^            nlohmann::json m_local_data;$/;"	m	line:153	language:C++	class:entangld::Datastore	access:protected
-m_remotes	libraries/unix/include/Datastore.h	/^            std::unordered_map<std::string, remote_t> m_remotes;$/;"	m	line:156	language:C++	class:entangld::Datastore	access:protected
-m_requests	libraries/unix/include/Datastore.h	/^            std::unordered_map<std::string, request_t> m_requests;$/;"	m	line:162	language:C++	class:entangld::Datastore	access:protected
-m_subs	libraries/unix/include/Datastore.h	/^            std::vector<request_t> m_subs;$/;"	m	line:168	language:C++	class:entangld::Datastore	access:protected
-main	libraries/unix/samples/client.cpp	/^int main(int argc, char *argv[])$/;"	f	line:58	language:C++	signature:(int argc, char *argv[])
-main	libraries/unix/samples/server.cpp	/^int main(int argc, char *argv[])$/;"	f	line:52	language:C++	signature:(int argc, char *argv[])
-main	libraries/unix/test/0.misc/test_init.cpp	/^int main()$/;"	f	line:7	language:C++	signature:()
-main	libraries/unix/test/1.get/test_get_basic.cpp	/^int main()$/;"	f	line:7	language:C++	signature:()
-main	libraries/unix/test/1.get/test_get_nested.cpp	/^int main()$/;"	f	line:7	language:C++	signature:()
-main	libraries/unix/test/1.get/test_get_remote.cpp	/^int main()$/;"	f	line:7	language:C++	signature:()
-main	libraries/unix/test/2.set/test_set_basic.cpp	/^int main()$/;"	f	line:8	language:C++	signature:()
-main	libraries/unix/test/2.set/test_set_nested.cpp	/^int main()$/;"	f	line:8	language:C++	signature:()
-main	libraries/unix/test/2.set/test_set_remote.cpp	/^int main()$/;"	f	line:7	language:C++	signature:()
-main	libraries/unix/test/3.sub/test_sub_basic.cpp	/^int main(int argc, char *argv[])$/;"	f	line:10	language:C++	signature:(int argc, char *argv[])
-main	libraries/unix/test/3.sub/test_sub_nested.cpp	/^int main(int argc, char *argv[])$/;"	f	line:10	language:C++	signature:(int argc, char *argv[])
-main	libraries/unix/test/3.sub/test_sub_remote.cpp	/^int main(int argc, char *argv[])$/;"	f	line:10	language:C++	signature:(int argc, char *argv[])
-main	libraries/unix/test/4.unsub/test_unsub_basic.cpp	/^int main(int argc, char *argv[])$/;"	f	line:10	language:C++	signature:(int argc, char *argv[])
-main	libraries/unix/test/4.unsub/test_unsub_remote.cpp	/^int main(int argc, char *argv[])$/;"	f	line:10	language:C++	signature:(int argc, char *argv[])
-matches_event_message	index.js	/^    matches_event_message(msg) {$/;"	M	line:296	language:JavaScript
-matches_path	index.js	/^    matches_path(path) {$/;"	M	line:319	language:JavaScript
-matches_subscription	index.js	/^    matches_subscription(sub) {$/;"	M	line:286	language:JavaScript
-matches_unsubscribe_message	index.js	/^    matches_unsubscribe_message(msg) {$/;"	M	line:309	language:JavaScript
-matches_uuid	index.js	/^    matches_uuid(uuid) {$/;"	M	line:329	language:JavaScript
-more_stores	test/tests.js	/^		        more_stores: {$/;"	P	line:539	language:JavaScript
-more_stores	test/tests.js	/^		        more_stores: {$/;"	P	line:578	language:JavaScript
-msg	libraries/unix/include/Datastore.h	/^                Message msg;$/;"	m	line:119	language:C++	struct:entangld::Datastore::__anon2	access:public
-name	libraries/unix/include/Datastore.h	/^                std::string name;           \/**< Namespace the store is mapped to. *\/$/;"	m	line:111	language:C++	struct:entangld::Datastore::__anon1	access:public
-namespace	index.js	/^    namespace(store) {$/;"	M	line:627	language:JavaScript
-namespaces	index.js	/^    get namespaces() {$/;"	M	line:603	language:JavaScript
-p	index.js	/^                let p = (result && result.constructor && result.constructor.name$/;"	F	line:977	language:JavaScript
-params	index.js	/^              params : params$/;"	P	line:888	language:JavaScript
-params	index.js	/^        params : params$/;"	P	line:97	language:JavaScript
-parse_namespace	libraries/unix/src/Datastore.cpp	/^    std::string Datastore::parse_namespace(std::string path)$/;"	f	line:322	language:C++	class:entangld::Datastore	signature:(std::string path)
-partial_copy	index.js	/^function partial_copy(o, max_depth) {$/;"	F	line:506	language:JavaScript
-path	index.js	/^            path : path,$/;"	P	line:1105	language:JavaScript
-path	index.js	/^        path : path,$/;"	P	line:128	language:JavaScript
-path	index.js	/^        path : tree,$/;"	P	line:111	language:JavaScript
-path	index.js	/^        path : tree,$/;"	P	line:95	language:JavaScript
-path	libraries/unix/include/Message.h	/^            nlohmann::json path;    \/**< Datastore path that the message is referencing. *\/$/;"	m	line:23	language:C++	class:entangld::Message	access:public
-port	test/sockets.js	/^                port : 9876$/;"	P	line:130	language:JavaScript
-port	test/sockets.js	/^            port : 9876$/;"	P	line:21	language:JavaScript
-port	test/sockets.js	/^            port : 9876$/;"	P	line:26	language:JavaScript
-print_help	libraries/unix/samples/client.cpp	/^static void print_help(const char *name)$/;"	f	line:36	language:C++	file:	signature:(const char *name)
-print_help	libraries/unix/samples/server.cpp	/^static void print_help(const char *name)$/;"	f	line:34	language:C++	file:	signature:(const char *name)
-ptr	libraries/unix/include/Datastore.h	/^                nlohmann::json::json_pointer ptr;$/;"	m	line:125	language:C++	struct:entangld::Datastore::__anon2	access:public
-push	index.js	/^    push(path, data, limit=null) {$/;"	M	line:828	language:JavaScript
-push	libraries/unix/include/Datastore.h	/^            inline void push(std::string path, nlohmann::json value)$/;"	f	line:103	language:C++	class:entangld::Datastore	access:public	signature:(std::string path, nlohmann::json value)
-receive	index.js	/^    receive(msg, obj) {$/;"	M	line:734	language:JavaScript
-receive	libraries/unix/src/Datastore.cpp	/^    void Datastore::receive(const Message &msg, std::string name)$/;"	f	line:250	language:C++	class:entangld::Datastore	signature:(const Message &msg, std::string name)
-recurse	index.js	/^    function recurse(o, c, parent, key) {$/;"	F	line:406	language:JavaScript
-remote	libraries/unix/include/Datastore.h	/^                remote_t *remote;$/;"	m	line:122	language:C++	struct:entangld::Datastore::__anon2	access:public
-remote_t	libraries/unix/include/Datastore.h	/^            } remote_t;$/;"	t	line:114	language:C++	class:entangld::Datastore	typeref:struct:entangld::Datastore::__anon1	access:protected
-request_t	libraries/unix/include/Datastore.h	/^            } request_t;$/;"	t	line:132	language:C++	class:entangld::Datastore	typeref:struct:entangld::Datastore::__anon2	access:protected
-reset	libraries/unix/src/Datastore.cpp	/^    void Datastore::reset()$/;"	f	line:40	language:C++	class:entangld::Datastore	signature:()
-set	index.js	/^    set(path, data, operation_type="set", params={}) {$/;"	M	line:846	language:JavaScript
-set	libraries/unix/src/Datastore.cpp	/^    void Datastore::set(std::string path, nlohmann::json value, bool push)$/;"	f	line:89	language:C++	class:entangld::Datastore	signature:(std::string path, nlohmann::json value, bool push)
-set_debug_level	libraries/unix/samples/debug.c	/^void set_debug_level(int debug_level)$/;"	f	line:14	language:C	signature:(int debug_level)
-setpush	index.js	/^    static setpush({type = "set", tree, value, params}) {$/;"	M	line:91	language:JavaScript
-static_copy	index.js	/^    static_copy() {$/;"	M	line:362	language:JavaScript
-subscribe	index.js	/^    static subscribe(tree, uuid, every = null) {$/;"	M	line:108	language:JavaScript
-subscribe	index.js	/^    subscribe(path, func, every = null) {$/;"	M	line:1067	language:JavaScript
-subscribe	libraries/unix/src/Datastore.cpp	/^    void Datastore::subscribe($/;"	f	line:138	language:C++	class:entangld::Datastore	signature:( std::string path, void (*callback)(const Message &msg, void *ctx), void *callback_ctx, std::string uuid)
-subscribed_to	index.js	/^    subscribed_to(path) {$/;"	M	line:1145	language:JavaScript
-subscriptions	index.js	/^    get subscriptions() {$/;"	M	line:617	language:JavaScript
-test_done	libraries/unix/test/3.sub/test_sub_basic.cpp	/^volatile bool test_done[3] = {false, false, false};$/;"	v	line:8	language:C++
-test_done	libraries/unix/test/3.sub/test_sub_nested.cpp	/^volatile bool test_done = false;$/;"	v	line:8	language:C++
-test_done	libraries/unix/test/3.sub/test_sub_remote.cpp	/^volatile bool test_done[2] = {false, false};$/;"	v	line:8	language:C++
-test_done	libraries/unix/test/4.unsub/test_unsub_basic.cpp	/^volatile bool test_done[3] = {false, false, false};$/;"	v	line:8	language:C++
-test_done	libraries/unix/test/4.unsub/test_unsub_remote.cpp	/^volatile bool test_done[2] = {false, false};$/;"	v	line:8	language:C++
-title	test/tests.js	/^		          title: "store C is located at this level"$/;"	P	line:541	language:JavaScript
-title	test/tests.js	/^		          title: "store C is located at this level"$/;"	P	line:579	language:JavaScript
-to_json	libraries/unix/include/Message.h	/^    static void to_json(nlohmann::json &j, const Message &msg)$/;"	f	line:33	language:C++	namespace:entangld	signature:(nlohmann::json &j, const Message &msg)
-transmit	index.js	/^    transmit(func) {$/;"	M	line:715	language:JavaScript
-transmit	libraries/unix/include/Datastore.h	/^            static inline void transmit(remote_t *remote, const Message &msg)$/;"	f	line:147	language:C++	class:entangld::Datastore	access:protected	signature:(remote_t *remote, const Message &msg)
-tree	index.js	/^              tree : tree,$/;"	P	line:886	language:JavaScript
-type	index.js	/^              type : operation_type,$/;"	P	line:885	language:JavaScript
-type	index.js	/^        type : "event",$/;"	P	line:127	language:JavaScript
-type	index.js	/^        type : "subscribe",$/;"	P	line:110	language:JavaScript
-type	index.js	/^        type: "get",$/;"	P	line:58	language:JavaScript
-type	index.js	/^        type: "unsubscribe",$/;"	P	line:142	language:JavaScript
-type	index.js	/^        type: "value",$/;"	P	line:74	language:JavaScript
-type	index.js	/^        type: type,$/;"	P	line:94	language:JavaScript
-type	libraries/unix/include/Message.h	/^            std::string type;       \/**< Message type. @see Datastore::receive *\/$/;"	m	line:22	language:C++	class:entangld::Message	access:public
-unsubscribe	index.js	/^    static unsubscribe(uuid) {$/;"	M	line:140	language:JavaScript
-unsubscribe	index.js	/^    unsubscribe(path_or_uuid) {$/;"	M	line:1166	language:JavaScript
-unsubscribe	libraries/unix/src/Datastore.cpp	/^    int Datastore::unsubscribe(std::string path, std::string uuid)$/;"	f	line:183	language:C++	class:entangld::Datastore	signature:(std::string path, std::string uuid)
-unsubscribe_tree	index.js	/^    unsubscribe_tree(path) {$/;"	M	line:1205	language:JavaScript
-upstream	index.js	/^            upstream : (this.upstream === null ? null : true),$/;"	M	line:367	language:JavaScript
-upstream	index.js	/^            upstream : upstream,$/;"	P	line:1107	language:JavaScript
-uuid	index.js	/^            uuid : uuid,$/;"	P	line:1108	language:JavaScript
-uuid	index.js	/^        uuid : uuid$/;"	P	line:130	language:JavaScript
-uuid	index.js	/^        uuid : uuid$/;"	P	line:144	language:JavaScript
-uuid	index.js	/^        uuid : uuid,$/;"	P	line:112	language:JavaScript
-uuid	libraries/unix/include/Message.h	/^            std::string uuid;       \/**< Unique identifier for request tracking. *\/$/;"	m	line:24	language:C++	class:entangld::Message	access:public
-uuid1	test/subscriptions.js	/^        let uuid1 = s.subscribe("path2.B.some_data", () => {count += 1});$/;"	F	line:251	language:JavaScript
-uuid1	test/subscriptions.js	/^        let uuid1 = s.subscribe("some_data", () => {count += 1});$/;"	F	line:220	language:JavaScript
-uuid2	test/subscriptions.js	/^        let uuid2 = a.subscribe("path3.B.some_data", () => {count += 1})$/;"	F	line:252	language:JavaScript
-uuid2	test/subscriptions.js	/^        let uuid2 = s.subscribe("some_data", () => {count += 1});$/;"	F	line:221	language:JavaScript
-uuids	index.js	/^        const uuids = subscriptions.map(s => s.uuid);$/;"	F	line:1243	language:JavaScript
-value	index.js	/^              value : data,$/;"	P	line:887	language:JavaScript
-value	index.js	/^        value : get_params,$/;"	P	line:60	language:JavaScript
-value	index.js	/^        value : value,$/;"	P	line:129	language:JavaScript
-value	index.js	/^        value : value,$/;"	P	line:76	language:JavaScript
-value	index.js	/^        value : value,$/;"	P	line:96	language:JavaScript
-value	index.js	/^    static value(get_msg, value) {$/;"	M	line:72	language:JavaScript
-value	libraries/unix/include/Message.h	/^            nlohmann::json value;   \/**< Message payload. *\/$/;"	m	line:25	language:C++	class:entangld::Message	access:public
-wait	test/circular.js	/^function wait (ms) {$/;"	F	line:3	language:JavaScript
-wait	test/sockets.js	/^function wait (ms) {$/;"	F	line:5	language:JavaScript
-while	index.js	/^    while(A.length && B.length){$/;"	M	line:557	language:JavaScript