Differences

This shows you the differences between two versions of the page.

--- f1x:architecture [2025/02/09 08:45] – [Terminology] arie
+++ f1x:architecture [2025/03/02 05:22] (current) – [Terminology] arie
@@ Line 7: / Line 7: @@
   * Site - F1x node installation
   * Identity - public/private keypair
-  * Realm - set of objects signed by Identity private key
+  * RealmID - hash of Identity public key
-  * Shard - Code (Handler) or Data with unique ID.
+  * Realm - set of objects that are related to an Identity. All shards in realm have the same realm ID. \\ Likely to be implemented as git repository, for its strong builtin sync and reconciliation feautures.
-      * has fields: name and kind
+  * Object - contains fields of Object or Code (Handler) kind with unique name ~ObjectID
+      * mandatory fields: name, kind
       * Data shards have _handler
       * Code shards have _code attribute
-      * Handler PubSub has method listener_SOMENAME and callback_SOMENAME. The callback method of Handler is called if result of the corresponding listener method changed. Internal logic migh intentionally call listener method to invoke subscribed callbacks.
+      * Handler PubSub has method listener_SOMENAME and callback_SOMENAME. The callback method of Handler is called if result of the corresponding listener method changed. Internal logic might intentionally call listener method to invoke subscribed callbacks.
-  * Handler - Code shard that knows to execute methods for given Object.
+      * version - used by reflectors and Router to facilitate subscriptions
-  * Handlers Set - Handlers published by the same Owner
+  * Shard - contains specific version of ObjectID kind with unique address ~ShardID
-  * Reflector - Mechanism to take referenced Shard, sign it and make available for peering
+  * Handler - Code shard that knows to execute methods for certain Object kind
+  * Handlers Set - Handlers published by the same Realm
+  * Reflector - Object sole purpose is to subscribe to a listener method of referenced PRIVATE Object. Has unique ReflectorID (likely amalgam of source ObjectID). On every change - new public shard (with updated version) is created, with the new result value is stored, the shard is signed and made available for external subscribers. \\ For security reasons, normal and published Shards have different location on disk.
   * Publish - procedure to create Reflector
-  * Router - Caching/Routing/Matching Server (CRMS) - intermediate server
+  * Subscription - Object of kind Subscription that specifies rules to invoke methods of other Objects.
-      * Router - keep track of objects its children sites are subscribed to, forward objects. Allows Sites to register as children based on IP
+      * Subscription to Reflector: specifies ObjectID→method to call on each new version of specific ReflectorID
+      * Subscription to Objects: specifies ObjectID→method to call on each new Object of kind "X" and possibly other conditions (like geo "Y", gender "G" or age range MIN/MAX) - used by [[:f1x:archtecture:attraction-proximity|Attraction/Proximity]]
+  * Router - Caching/Routing/Matching Server (CRMS) - intermediate server, usually sits on internal network or at ISP
+      * Router - keep track of objects its children realms are subscribed to, forwards objects. Allows Realms to register as children based on IP.
       * Cacher - cache frequently accessed objects
       * Matcher - [[:f1x:archtecture:attraction-proximity|Attraction/Proximity]] role
+  * Geo - Plus Code of [[https://en.wikipedia.org/wiki/Open_Location_Code|Open Location Code]] standard
 ==== Site ====
-Site is compute infrastructure that enables users to operate Identity Realms. It consists of events routing server and presentation (like web server).\\
+Site is compute infrastructure that enables users to operate Object Realms. It consists of events routing server and presentation (like web server). \\  \\ Web server (presentation) functionality:
-\\
-Web server (presentation) functionality:
-  * authenticate the single user (a site normally has one user, preferably with unique domain)
+  * authenticate the site user (a site normally has one user, preferably with unique domain)
   * communcate with core on objects CRUD
   * visualise and manage content in user-friendly way
@@ Line 42: / Line 47: @@
   * garbage collect "foreign" Shards that are not referenced anymore
+=== Data Shard ===
-=== Shard (Memo) ===
+Data Shard is on-disk representation of object with fields that has associated data handler (Code Shard), similarily to data and code separation in [[https://en.wikipedia.org/wiki/Object-oriented_programming|OOP]]. \\
+Code Shard methods is written in [[https://en.wikipedia.org/wiki/Lua_(programming_language)|Lua]] and is executed in sandbox. API methods to read and call referenced Objects allows writing sophisticated applications.
-Shard is data structure that has associated data handler, similarily to data and code separation in [[https://en.wikipedia.org/wiki/Object-oriented_programming|OOP]]. Code is written in [[https://en.wikipedia.org/wiki/Lua_(programming_language)|Lua]] and is executed in sandbox. API methods to read and call referenced Memos allows writing sophisticated applications.
+==== Published Shards ====
-==== Exported Folders ====
+Normal shards are accessible to Realm owner only. The owner might choose to publish methods of some objects using special "Reflector" objects. These also might be encrypted with public key of intended recipients, thus limiting who can see the content. \\  \\ Other option is publish whole Object, if it has "get_ahk" method, then it is published to DHT.
-Memos are stored into Folders in "Private" area, that is visible to owner only. User might choose to mark some folders as externally accessible, for others to be able to see them. Exported folders have mandatory "Epoch" and "Digital Signature". They also might be encrypted with public key of intended recipients, thus limiting who can see the content.
+===== Router =====
-===== pCache server =====
+Every Site is connected to one Router server. It discovesrs Routers by asking centralized "Router servers registry". It is publicly accessible and should be at PoP with good connectivity. The Router servers perform functions below:
-Every Site is connected to a pCache server. It might be discovered by asking centralized "pCache servers registry". It is publicly accessible and should be at location with good connectivity. The pCache servers perform functions below:
+  * retrieve list of subscriptions from realms under its control, send back matching Objects
+  * retrieve "exported" data from realms and share it to sites that request it. Cache the data.
-  * retrieve list of subscriptions from sites under its control, send back matching Memos
+  * receive notifications from children sites about new Shards, forward the Shards to other Routers, while prioritizing traffic
-  * retrieve "exported" data from sites and share it to sites that request it. Cache the data.
-  * receive notifications from children sites about data change, forward them to upstream pServers or other sites
 ==== Publish/Subscribe ====
-Frequently object want to know when something changes in other specific objects. To maintain encapsulation principle, this is done by "listener" methods. When other objects indicate desire to get notifications of a "listener" method, result of the method is remembered, together with list of "subscribed" object/methods. When Object wants to "notify" subscribers on a change, it invokes listener method that returns different value, thus causing methods of subscriber objects to be called.
+Frequently object want to know when something changes in other objects. To maintain encapsulation principle, this is done by "listener" methods. When other objects indicate desire to get notifications of a "listener" method, result of the method is remembered, together with list of "subscribed" object/methods. When Object wants to "notify" subscribers on a change, it invokes listener method that returns different value, thus causing methods of subscriber objects to be called.
 The subscribers might then recalculate a value, compare with threshold and raise nofification to user or alter return value of their own listeners, thus "publishing" a change.
@@ Line 78: / Line 83: @@
   * what is default measurement system of the owner? Imperial or standard
-  * get list of neighbours who know me:
+  * WHA? get list of neighbours who know me:
-      * find Memos of kind People and have homeAt geo and have Memo of kind Subscription where (site=me and kind Memo=Message)
+      * WHA? find Objects of kind People and have homeAt geo and have Memo of kind Subscription where (site=me and kind Memo=Message)
-      * remove ones that have distance between me and homeAt more than 100 m
+      * WHA? remove ones that have distance between me and homeAt more than 100 m
 Stored queries (subscriptions) also use jq to find matching Memos: TBD How?