entangld 2.1.6 → 2.2.0

package/README.hbs

@@ -145,6 +145,7 @@ Any object can store values.  And a Map can store values keyed to objects.  But
 - Have your store synchronized with multiple data sources (other stores)?
 - Over a network?
 - Subscribe to events within the datastore?
+- Support subscription wildcards?
 
 ## Notes
 

package/README.md

@@ -145,6 +145,7 @@ Any object can store values.  And a Map can store values keyed to objects.  But
 - Have your store synchronized with multiple data sources (other stores)?
 - Over a network?
 - Subscribe to events within the datastore?
+- Support subscription wildcards?
 
 ## Notes
 
@@ -191,7 +192,8 @@ downstream datastores do not necessarilly have access to the upstream store
 structure, and so cannot generally construct upstream paths. This means that
 the <code>.path</code> attribute is a <code>tree</code> relative to the upstream datastore, and
 the upstream path can be reconstructed as:</p>
-<pre><code class="language-javascript"> &gt; upstream._namespaces.get(downstream) + &quot;.&quot; + msg.path;</code></pre>
+<pre><code class="language-javascript"> &gt; upstream._namespaces.get(downstream) + &quot;.&quot; + msg.path;
+</code></pre>
 <p>Since <code>unsubscribe</code> messages can pass either upstream or downstream, the notion
 of a path is ill-defined, and so unsubscribe messages should have their <code>.path</code>
 attributes set to undefined or null.</p>
@@ -306,7 +308,7 @@ Construct subscribe message
 | Param | Type | Description |
 | --- | --- | --- |
 | tree | <code>string</code> | the path (relative to the downstream datastore) |
-| uuid | <code>Uuid</code> | the subscription uuid |
+| uuid | <code>uuidv4</code> | the subscription uuid |
 
 <a name="Entangld_Message.event"></a>
 
@@ -320,7 +322,7 @@ Create an `event` message to return data to subscribe callbacks
 | --- | --- | --- |
 | path | <code>string</code> | the path (relative to the downstream store) |
 | value | <code>\*</code> | the updated datastore value at the path |
-| uuid | <code>Uuid</code> | the uuid of the subscribe being triggered |
+| uuid | <code>uuidv4</code> | the uuid of the subscribe being triggered |
 
 <a name="Entangld_Message.unsubscribe"></a>
 
@@ -374,7 +376,7 @@ Constructor
 | --- | --- | --- |
 | obj | <code>Object</code> | the configuration object |
 | obj.path | <code>string</code> | the datastore path (relative to this datastore)                             of the subscription |
-| obj.uuid | <code>Uuid</code> | the uuid of the subscription chain |
+| obj.uuid | <code>uuidv4</code> | the uuid of the subscription chain |
 | obj.callback | <code>function</code> | the callback function, with signature (path, value),                               where path is relative to this datastore |
 | obj.downstream | [<code>Entangld</code>](#Entangld) \| <code>null</code> | the downstream datastore (if any)                                          associated with this subscription |
 | obj.upstream | [<code>Entangld</code>](#Entangld) \| <code>null</code> | the upstream datastore (if any)                                          associated with this subscription |
@@ -496,7 +498,7 @@ Check if a provided uuid matches this uuid
 
 | Param | Type | Description |
 | --- | --- | --- |
-| uuid | <code>Uuid</code> | a uuid string to check against |
+| uuid | <code>uuidv4</code> | a uuid string to check against |
 
 <a name="Subscription+is_beneath"></a>
 
@@ -552,7 +554,7 @@ Synchronized Event Store
     * [.push(path, data, [limit])](#Entangld+push)
     * [.set(path, data, [operation_type], [params])](#Entangld+set)
     * [.get(path, [params])](#Entangld+get) ⇒ <code>Promise</code>
-    * [.subscribe(path, func, [every])](#Entangld+subscribe) ⇒ <code>Uuid</code>
+    * [.subscribe(path, func, [every])](#Entangld+subscribe) ⇒ <code>uuidv4</code>
     * [.subscribed_to(subscription)](#Entangld+subscribed_to) ⇒ <code>Boolean</code>
     * [.unsubscribe(path_or_uuid)](#Entangld+unsubscribe) ⇒ <code>number</code>
     * [.unsubscribe_tree(path)](#Entangld+unsubscribe_tree)
@@ -720,7 +722,7 @@ recursion and may be expensive.
 
 <a name="Entangld+subscribe"></a>
 
-### entangld.subscribe(path, func, [every]) ⇒ <code>Uuid</code>
+### entangld.subscribe(path, func, [every]) ⇒ <code>uuidv4</code>
 Subscribe to change events for a path
 
 If objects at or below this path change, you will get a callback
@@ -753,7 +755,7 @@ subscriptions can be checked to see if they are `pass through` type via
 the getter `sub.is_pass_through`.
 
 **Kind**: instance method of [<code>Entangld</code>](#Entangld)  
-**Returns**: <code>Uuid</code> - - the uuid of the subscription  
+**Returns**: <code>uuidv4</code> - - the uuid of the subscription  
 **Throws**:
 
 - <code>TypeError</code> if path is not a string.
@@ -761,7 +763,7 @@ the getter `sub.is_pass_through`.
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| path | <code>string</code> |  | the path to watch. |
+| path | <code>string</code> |  | the path to watch.  Use of '*' is allowed as a wildcard (e.g. "system.*") |
 | func | <code>function</code> |  | the callback - will be of the form (path, value). |
 | [every] | <code>number</code> \| <code>null</code> | <code></code> | the number of `set` messages to wait before calling callback |
 
@@ -797,7 +799,7 @@ and only want one of them to be removed, you must provide the uuid instead.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| path_or_uuid | <code>String</code> \| <code>Uuid</code> | the path (or uuid) to unwatch. |
+| path_or_uuid | <code>String</code> \| <code>uuidv4</code> | the path (or uuid) to unwatch. |
 
 <a name="Entangld+unsubscribe_tree"></a>
 

package/index.js

@@ -337,7 +337,7 @@ class Subscription {
      * @return {Boolean} - true if the subscription is beneath the path
      */
     is_beneath(path) {
-        return is_beneath(this.path, path)
+        return is_beneath(this.path, path, 'a');
     }
 
     /**
@@ -347,7 +347,7 @@ class Subscription {
      * @return {Boolean} - true if the subscription is beneath the path
      */
     is_above(path) {
-        return is_beneath(path, this.path);
+        return is_beneath(path, this.path, 'b');
     }
 
     /**
@@ -539,10 +539,11 @@ function partial_copy(o, max_depth) {
  *
  * @private
  * @param {string} a the string tested for "insideness"
- * @param {string} b the string tested for "outsideness"
+ * @param {string} b the string tested for "outsideness" (wildcard '*' allowed)
+ * @param {string} [allow_wildcard = false] allow wildcards, one of ('a', 'b', false).  Default is false (no wildcard allowed)
  * @return boolean
  */
-function is_beneath(a, b) {
+function is_beneath(a, b, allow_wildcard=false) {
 
     // Everything is beneath the top ("")
     if(b==="") return true;
@@ -553,10 +554,33 @@ function is_beneath(a, b) {
     let A=a.split(".");
     let B=b.split(".");
 
-    // A is not beneath B if any part is not the same
-    while(A.length && B.length){
+    // A is not beneath B if any part is not the same.  Check for this.
+    switch (allow_wildcard) {
 
-        if(A.shift()!=B.shift()) return false;
+        case "a":
+            // Allow wildcard in A
+            while(A.length && B.length){
+
+                let A_part=A.shift();
+                if(A_part!=B.shift() && A_part != "*") return false;
+            }
+            break;
+
+        case "b":
+            // Allow wildcard in B
+            while(A.length && B.length){
+
+                let B_part=B.shift();
+                if(B_part!=A.shift() && B_part != "*") return false;
+            }
+            break;
+        
+        default:
+            // No wildcards allowed
+            while(A.length && B.length){
+                    
+               if(A.shift()!=B.shift()) return false;
+            }
     }
 
     // A is not beneath B if B is longer
@@ -1057,7 +1081,7 @@ class Entangld extends EventEmitter {
      * subscriptions can be checked to see if they are `pass through` type via
      * the getter `sub.is_pass_through`.
      *
-     * @param {string} path the path to watch.
+     * @param {string} path the path to watch.  Use of '*' is allowed as a wildcard (e.g. "system.*")
      * @param {function} func the callback - will be of the form (path, value).
      * @param {number|null} [every=null] the number of `set` messages to wait before calling callback
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "entangld",
-  "version": "2.1.6",
+  "version": "2.2.0",
   "description": "Synchronized key-value stores with RPCs and events",
   "main": "index.js",
   "jshintConfig": {

package/test/events.js

@@ -18,6 +18,29 @@ describe("Events",()=>{
     a.transmit((msg, store)=>store.receive(msg, a));
     b.transmit((msg, store)=>store.receive(msg, b));
 
+
+    // Original tests were written with globals and are thus not independent.  I'm adding (JLS 2023-02-21) some "clean" scaffolding.
+    // TODO - we should eventually rewrite tests to use these new objects.
+    let A,B,S;
+    beforeEach(()=>{
+
+        S=new Entangld();
+        A=new Entangld();
+        B=new Entangld();
+
+        S.attach("a",A);
+        S.attach("b",B);
+
+        A.attach("parent", S);
+        B.attach("parent", S);
+
+        S.transmit((msg, store)=>store.receive(msg, S));
+        A.transmit((msg, store)=>store.receive(msg, A));
+        B.transmit((msg, store)=>store.receive(msg, B));
+        
+    });
+
+
     it("Subscribe to local event (exact)", (done)=>{
 
         s.subscribe("my.own.event",(path, val)=>{
@@ -53,6 +76,22 @@ describe("Events",()=>{
         a.set("system.voltage",21);
     });
 
+    it("Subscribe to remote event (wildcard)", (done)=>{
+
+        S.subscribe("a.*.voltage",(path, val)=>{
+
+            assert.strictEqual(path,"a.system.voltage");
+            assert.strictEqual(val, 21);
+
+            // Check for proper internals
+            assert.strictEqual(s._subscriptions.length,1);
+            assert.strictEqual(a._subscriptions.length,1);
+            done();
+        });
+
+        A.set("system.voltage",21);
+    });
+
     it("Subscribe to remote event (descendant of subscribed path also triggers event)", (done)=>{
 
         s.subscribe("a.flowers.roses",(path, val)=>{

package/test/single.js

@@ -0,0 +1,48 @@
+const Entangld=require("../index.js");
+const assert=require("assert");
+
+
+describe("Events",()=>{
+
+
+    // Original tests were written with globals and are thus not independent.  I'm adding (JLS 2023-02-21) some "clean" scaffolding.
+    // TODO - we should eventually rewrite tests to use these new objects.
+    let A,B,S;
+    beforeEach(()=>{
+
+        S=new Entangld();
+        A=new Entangld();
+        B=new Entangld();
+
+        S.attach("a",A);
+        S.attach("b",B);
+
+        A.attach("parent", S);
+        B.attach("parent", S);
+
+        S.transmit((msg, store)=>store.receive(msg, S));
+        A.transmit((msg, store)=>store.receive(msg, A));
+        B.transmit((msg, store)=>store.receive(msg, B));
+        
+    });
+
+
+
+    it("Subscribe to remote event (wildcard)", (done)=>{
+
+        S.subscribe("a.*.voltage",(path, val)=>{
+
+            assert.strictEqual(path,"a.system.voltage");
+            assert.strictEqual(val, 21);
+
+            // Check for proper internals
+            assert.strictEqual(S._subscriptions.length,1);
+            assert.strictEqual(A._subscriptions.length,1);
+            done();
+        });
+
+        A.set("system.voltage",21);
+    });
+
+
+});

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