mkarkowski/nope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

fixing names

Browse Source
This commit is contained in:
Martin Karkowski 2021-08-04 14:57:28 +02:00
parent 36f346cea1
commit 37039ded61
4 changed files with 201 additions and 221 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

208
modules/mod-Publish-And-Subscribe-System/README.md
View File

@ -2,19 +2,18 @@
The Pub-Sub-System is a basic Publish and Subscribe System. A Pub-Sub System consists of 3 Main Elements: The Pub-Sub-System is a basic Publish and Subscribe System. A Pub-Sub System consists of 3 Main Elements:
* Publishers - Publishers
* Subscribers - Subscribers
* Broker - Broker
Whereas Publishers publishes data on a given Topic, Subscribers receives updates of the data of a subscribed Topic. Topics are used as a Base to share data. For instance, if a Sensor publishes its value on the Topic `Room1.Temperature` every subscribtion which subscribes to `Room1` or `Room1.Temperature` will receive the updated Value. By unsubscribing, a Subscriber doesn't receive Updates anymore. Thereby, the Publish-and-Subscribe mechanism ensure, a loose coupleing between the Elements and scalability. Whereas Publishers publishes data on a given Topic, Subscribers receives updates of the data of a subscribed Topic. Topics are used as a Base to share data. For instance, if a Sensor publishes its value on the Topic `Room1.Temperature` every subscribtion which subscribes to `Room1` or `Room1.Temperature` will receive the updated Value. By unsubscribing, a Subscriber doesn't receive Updates anymore. Thereby, the Publish-and-Subscribe mechanism ensure, a loose coupleing between the Elements and scalability.
Summarized Attributes of a Pub-Sub-System Summarized Attributes of a Pub-Sub-System
* A Publisher doesn't know its subscribers - A Publisher doesn't know its subscribers
* A Subscriber doesn't kown the Publisher(s) - A Subscriber doesn't kown the Publisher(s)
* Different Publishers are able to Publish data on the same Topic - Different Publishers are able to Publish data on the same Topic
* Broker are responsible for sharing data and subscriptions etc. - Broker are responsible for sharing data and subscriptions etc.
--- ---
@ -22,11 +21,11 @@ Summarized Attributes of a Pub-Sub-System
The Basic Pub-Sub-System which is based on a Binary Tree-Model. For Instance, there are Publishers for the following Topics: The Basic Pub-Sub-System which is based on a Binary Tree-Model. For Instance, there are Publishers for the following Topics:
* `Root.Topic1` - `Root.Topic1`
* `Root.Topic2` - `Root.Topic2`
* `Root.Topic2.Part1` - `Root.Topic2.Part1`
* `Root.Topic2.Part2` - `Root.Topic2.Part2`
* `Root.Topic2.Part3` - `Root.Topic2.Part3`
Thereby the **Tree** is build up like that. Thereby the **Tree** is build up like that.
@ -42,31 +41,31 @@ Thereby the **Tree** is build up like that.
(Part3) (Part3)
``` ```
Data of Topics are shared only to its '*Super-Topics*' and '*Child-Topics*' (see the Examples) Data of Topics are shared only to its '_Super-Topics_' and '_Child-Topics_' (see the Examples)
### Example 1 - Publishing data on `Root/Topic2` ### Example 1 - Publishing data on `Root/Topic2`
If a Publisher of the Topic `Root.Topic2` publishes an update, the Subscribe of the following Topics receives an update. If a Publisher of the Topic `Root.Topic2` publishes an update, the Subscribe of the following Topics receives an update.
* `Root` - `Root`
* `Root.Topic2` - `Root.Topic2`
* `Root.Topic2.Part1` - `Root.Topic2.Part1`
* `Root.Topic2.Part2` - `Root.Topic2.Part2`
* `Root.Topic2.Part3` - `Root.Topic2.Part3`
Thereby each element gets the new Data in the following format: Thereby each element gets the new Data in the following format:
> **Example-Data:** `{ Part1 : 1, Part2 : 'test', Part3 : 1.337 }` is published on the Topic `Root/Topic2` > **Example-Data:** `{ Part1 : 1, Part2 : 'test', Part3 : 1.337 }` is published on the Topic `Root/Topic2`
| Topic | Received Data of the Subscription in ***JSON-Notation***| | Topic | Received Data of the Subscription in **_JSON-Notation_** |
| ---- | ---- | | --------------------- | ---------------------------------------------------------------------------------------- |
| `Root` | `{ Topic1: 'someData', Topic2 : { Part1 : 1, Part2 : 'test', Part3 : [1.337, 1.338] } }` | | `Root` | `{ Topic1: 'someData', Topic2 : { Part1 : 1, Part2 : 'test', Part3 : [1.337, 1.338] } }` |
| `Root.Topic2` | `{ Part1 : 1, Part2 : 'test', Part3 : 1.337 }` | | `Root.Topic2` | `{ Part1 : 1, Part2 : 'test', Part3 : 1.337 }` |
| `Root.Topic2.Part1` | `1` | | `Root.Topic2.Part1` | `1` |
| `Root.Topic2.Part2` | `'test'` | | `Root.Topic2.Part2` | `'test'` |
| `Root.Topic2.Part3` | `[1.337, 1.338]` | | `Root.Topic2.Part3` | `[1.337, 1.338]` |
| `Root.Topic2.Part3.0` | `1.337` | | `Root.Topic2.Part3.0` | `1.337` |
| `Root.Topic2.Part3.1` | `1.338` | | `Root.Topic2.Part3.1` | `1.338` |
> Subscriber of the Topic `Root.Topic1` doesn't receive Updates. > Subscriber of the Topic `Root.Topic1` doesn't receive Updates.
@ -74,21 +73,21 @@ Thereby each element gets the new Data in the following format:
If a Publisher of the Topic `Root.Topic2.Part3` publishes an update, the Subscribe of the following Topics receives an update. If a Publisher of the Topic `Root.Topic2.Part3` publishes an update, the Subscribe of the following Topics receives an update.
* `Root` - `Root`
* `Root.Topic2` - `Root.Topic2`
* `Root.Topic2.Part3` - `Root.Topic2.Part3`
Thereby each element gets the new Data in the following format: Thereby each element gets the new Data in the following format:
> **Example-Data:** `[1234, 1.338]` is published on the Topic `Root.Topic2.Part3` > **Example-Data:** `[1234, 1.338]` is published on the Topic `Root.Topic2.Part3`
| Topic | Received Data of the Subscription in ***JSON-Notation***| | Topic | Received Data of the Subscription in **_JSON-Notation_** |
| ---- | ---- | | --------------------- | --------------------------------------------------------------------------------------- |
| `Root` | `{ Topic1: 'someData', Topic2 : { Part1 : 1, Part2 : 'test', Part3 : [1234, 1.338] } }` | | `Root` | `{ Topic1: 'someData', Topic2 : { Part1 : 1, Part2 : 'test', Part3 : [1234, 1.338] } }` |
| `Root.Topic2` | `{ Part1 : 1, Part2 : 'test', Part3 : [1234, 1.338] }` | | `Root.Topic2` | `{ Part1 : 1, Part2 : 'test', Part3 : [1234, 1.338] }` |
| `Root.Topic2.Part3` | `[1234, 1.338]` | | `Root.Topic2.Part3` | `[1234, 1.338]` |
| `Root.Topic2.Part3.0` | `1234` | | `Root.Topic2.Part3.0` | `1234` |
| `Root.Topic2.Part3.1` | `1.338` No Update will be Pusblished, cause the value didn't change | | `Root.Topic2.Part3.1` | `1.338` No Update will be Pusblished, cause the value didn't change |
> Subscriber of the Topic `Root.Topic1`, `Root.Topic2.Part1`, `Root.Topic2.Part3.1` and `Root.Topic2.Part2` doesn't receive Updates, cause their values didn't change. > Subscriber of the Topic `Root.Topic1`, `Root.Topic2.Part1`, `Root.Topic2.Part3.1` and `Root.Topic2.Part2` doesn't receive Updates, cause their values didn't change.
@ -98,10 +97,10 @@ Thereby each element gets the new Data in the following format:
The Pub-Sub-System is build up with a Base-Node-Container. This Container is responsible to create (if necessary) new Topics on which a Subscription could be subscribe or data could be published. Based on all available Subscriptions published Data send to the corresponding Subscriptions. The Pub-Sub-System is build up with a Base-Node-Container. This Container is responsible to create (if necessary) new Topics on which a Subscription could be subscribe or data could be published. Based on all available Subscriptions published Data send to the corresponding Subscriptions.
* No multiple Pub-Sub-Systems at a Time, otherwise an exception is thrown. - No multiple Pub-Sub-Systems at a Time, otherwise an exception is thrown.
* **Subscribers must unsubscribe** if the should not listening any more. For Instance pause/deactivate or dispose an specific Object. (use the `unregister` function of a Subscribtion) - **Subscribers must unsubscribe** if the should not listening any more. For Instance pause/deactivate or dispose an specific Object. (use the `unregister` function of a Subscribtion)
* Subscriptions could be activated again by calling `register` - Subscriptions could be activated again by calling `register`
* Subscriptions are automatically active. - Subscriptions are automatically active.
--- ---
@ -109,7 +108,6 @@ The Pub-Sub-System is build up with a Base-Node-Container. This Container is res
Observables allow a simple integration of attributes of an object. Therefore the `IObserveable<T>` interface is used. Observables allow a simple integration of attributes of an object. Therefore the `IObserveable<T>` interface is used.
### Example - Integrate an Observable ### Example - Integrate an Observable
To use an Observable the following code must be used, where as `TYPE` describes the data type like `number`, `string`, etc. To use an Observable the following code must be used, where as `TYPE` describes the data type like `number`, `string`, etc.
@ -123,43 +121,40 @@ Furthermore the Class containing the observable attribute **must** implement the
```typescript ```typescript
/** Import the Pub-Sub-System (Path must be adapted) */ /** Import the Pub-Sub-System (Path must be adapted) */
import * as PUBSUB from 'Pub-Sub-System/assembly/manual-assembly'; import * as PUBSUB from "Pub-Sub-System/assembly/manual-assembly";
/** Define a Class containing an observable @see attribute_01 */ /** Define a Class containing an observable @see attribute_01 */
@injectable() @injectable()
class TestClass implements IContainsObservables { class TestClass implements IContainsObservables {
/** Values of the IOnlineValues - Interface */ /** Values of the IOnlineValues - Interface */
path: string = ''; path: string = "";
offeredTopics: Map<string, GenericObservable<any>> ; offeredTopics: Map<string, GenericObservable<any>>;
/**
* Defining the Attribute which should be integrated into the Publish
* and Subscribe System. The value should be a 'number'
*
* @type {PUBSUB.Observer<number>}
* @memberof TestClass
*/
@inject(PUBSUB.TYPES.Observable)
public attribute_01: PUBSUB.Observable<number>;
/** /**
* Defining the Attribute which should be integrated into the Publish * Creates an instance of TestClass.
* and Subscribe System. The value should be a 'number' * @memberof TestClass
* */
* @type {PUBSUB.Observer<number>} constructor() {
* @memberof TestClass /** Set a Values - That must be done during the construction */
*/ this.path = "";
@inject(PUBSUB.TYPES.Observable) this.offeredTopics = new Map<string, GenericObservable<any>>();
public attribute_01: PUBSUB.Observable<number>; }
/**
* Creates an instance of TestClass.
* @memberof TestClass
*/
constructor() {
/** Set a Values - That must be done during the construction */
this.path = '';
this.offeredTopics = new Map<string, GenericObservable<any>>();
}
} }
``` ```
### Working with Observables ### Working with Observables
By default oberserables publish their content on an automatically generated Topic. This topic could be adapted and read with the `path` - attibute of an Observable. By default observables publish their content on an automatically generated Topic. This topic could be adapted and read with the `path` - attibute of an Observable.
```typescript ```typescript
@ -171,24 +166,23 @@ To subscribe to changes of an obserable simply use the metho `subscribe`. You ca
The Following Parameters are used: The Following Parameters are used:
| Param | Type | Default | Description | | Param | Type | Default | Description |
| --- | --- | --- | --- | | ------ | ---------------------------------------------------------- | -------- | -------------------------------------------------- |
| func | [<code>subscriptionCallback</code>](#subscriptionCallback) | | Function which is called when new Datas are pushed | | func | [<code>subscriptionCallback</code>](#subscriptionCallback) | | Function which is called when new Datas are pushed |
| [mode] | `'sync'` \ `'immediate'` | `'sync'`| Mode of the Subscription | | [mode] | `'sync'` \ `'immediate'` | `'sync'` | Mode of the Subscription |
**Returns**: <code>ISubscription</code> - The corresponding Subscription **Returns**: <code>ISubscription</code> - The corresponding Subscription
whereas the <code>subscriptionCallback</code> is defined as: whereas the <code>subscriptionCallback</code> is defined as:
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | ----------- | ------------------- | --------------------------------------------- |
| content | <code>any</code> | The new Data | | content | <code>any</code> | The new Data |
| [topic] | <code>string</code> | The Topic on which the Data where from | | [topic] | <code>string</code> | The Topic on which the Data where from |
| [timeStamp] | <code>number</code> | The timeStamp on which the data where changed | | [timeStamp] | <code>number</code> | The timeStamp on which the data where changed |
**Returns** - <code>void</code> **Returns** - <code>void</code>
##### Example ##### Example
```typescript ```typescript
@ -197,15 +191,13 @@ const _test = new TestClass();
/** Subscribe to changes of the attribute */ /** Subscribe to changes of the attribute */
_test.attribute_01.subscribe((_num, _topic) => { _test.attribute_01.subscribe((_num, _topic) => {
console.log('subscription on', _topic, '. Value changed to:', _num); console.log("subscription on", _topic, ". Value changed to:", _num);
}, 'sync'); }, "sync");
/** Change the Value of the observable => Subscription will be triggered */ /** Change the Value of the observable => Subscription will be triggered */
_test.attribute_01.value = 1337; _test.attribute_01.value = 1337;
``` ```
#### Changing Values and reading values #### Changing Values and reading values
The value of an observable could be changed with the `value` attribute of an observable The value of an observable could be changed with the `value` attribute of an observable
@ -221,38 +213,41 @@ _test.attribute_01.value = 1337;
const _aVar = _test.attribute_01.value; const _aVar = _test.attribute_01.value;
``` ```
### Sample Application ### Sample Application
```typescript ```typescript
import { Builder } from '../../mod-Assembly-Builder/src/Container-Builder.FileLoader'; import { Builder } from "../../mod-Assembly-Builder/src/Container-Builder.FileLoader";
import { DESCRIPTION, PubSubSystem } from '../assembly/manual-assembly'; import { DESCRIPTION, PubSubSystem } from "../assembly/manual-assembly";
Builder.instance.addElements(DESCRIPTION.PROVIDED_CLASSES) Builder.instance.addElements(DESCRIPTION.PROVIDED_CLASSES);
Builder.instance.addActivationHandler(DESCRIPTION.ACTIVATIONHANDLERS); Builder.instance.addActivationHandler(DESCRIPTION.ACTIVATIONHANDLERS);
Builder.load(); Builder.load();
Builder.on('loaded', () => { Builder.on("loaded", () => {
// Create a Publish and Subscribe System
const _pubSub = Builder.instance.container.get<PubSubSystem>(
DESCRIPTION.TYPES.PubSubSystem
);
// Create a Publish and Subscribe System // Create a Subscription on the topic: "test.topic"
const _pubSub = Builder.instance.container.get<PubSubSystem>(DESCRIPTION.TYPES.PubSubSystem); const _sub = _pubSub.createSubscription<any>(
"test.topic",
(_data, _topic, _timestamp) => {
console.log("received with inform", _data);
}
);
// Create a Subscription on the topic: "test.topic" // Create a Publisher and Publish "1" on a Subtopic
const _sub = _pubSub.createSubscription<any>('test.topic', (_data, _topic, _timestamp) => { _pubSub.createPublisher<number>("test.topic.child").publishData(1);
console.log('received with inform', _data); _pubSub.createPublisher<number>("test.topic").publishData(2);
});
// Create a Publisher and Publish "1" on a Subtopic // Change the Subscription Mode.
_pubSub.createPublisher<number>('test.topic.child').publishData(1); _sub.options.mode = ["direct"];
_pubSub.createPublisher<number>('test.topic').publishData(2);
// Change the Subscription Mode.
_sub.options.mode = ['direct'];
// The following Subscription will be now ignored
_pubSub.createPublisher<number>('test.topic.child').publishData(3);
_pubSub.createPublisher<number>('test.topic').publishData(4);
// The following Subscription will be now ignored
_pubSub.createPublisher<number>("test.topic.child").publishData(3);
_pubSub.createPublisher<number>("test.topic").publishData(4);
}); });
``` ```
@ -278,8 +273,3 @@ Calling Subscription of root._test.attribute_01 the 3'th time. Value changed to
plublish 1336 on _test.attribute_01 plublish 1336 on _test.attribute_01
Calling Subscription of root._test.attribute_01 the 4'th time. Value changed to: 1336 Calling Subscription of root._test.attribute_01 the 4'th time. Value changed to: 1336
``` ```

208
modules/pub-sub/README.md
View File

@ -2,19 +2,18 @@
The Pub-Sub-System is a basic Publish and Subscribe System. A Pub-Sub System consists of 3 Main Elements: The Pub-Sub-System is a basic Publish and Subscribe System. A Pub-Sub System consists of 3 Main Elements:
* Publishers - Publishers
* Subscribers - Subscribers
* Broker - Broker
Whereas Publishers publishes data on a given Topic, Subscribers receives updates of the data of a subscribed Topic. Topics are used as a Base to share data. For instance, if a Sensor publishes its value on the Topic `Room1.Temperature` every subscribtion which subscribes to `Room1` or `Room1.Temperature` will receive the updated Value. By unsubscribing, a Subscriber doesn't receive Updates anymore. Thereby, the Publish-and-Subscribe mechanism ensure, a loose coupleing between the Elements and scalability. Whereas Publishers publishes data on a given Topic, Subscribers receives updates of the data of a subscribed Topic. Topics are used as a Base to share data. For instance, if a Sensor publishes its value on the Topic `Room1.Temperature` every subscribtion which subscribes to `Room1` or `Room1.Temperature` will receive the updated Value. By unsubscribing, a Subscriber doesn't receive Updates anymore. Thereby, the Publish-and-Subscribe mechanism ensure, a loose coupleing between the Elements and scalability.
Summarized Attributes of a Pub-Sub-System Summarized Attributes of a Pub-Sub-System
* A Publisher doesn't know its subscribers - A Publisher doesn't know its subscribers
* A Subscriber doesn't kown the Publisher(s) - A Subscriber doesn't kown the Publisher(s)
* Different Publishers are able to Publish data on the same Topic - Different Publishers are able to Publish data on the same Topic
* Broker are responsible for sharing data and subscriptions etc. - Broker are responsible for sharing data and subscriptions etc.
--- ---
@ -22,11 +21,11 @@ Summarized Attributes of a Pub-Sub-System
The Basic Pub-Sub-System which is based on a Binary Tree-Model. For Instance, there are Publishers for the following Topics: The Basic Pub-Sub-System which is based on a Binary Tree-Model. For Instance, there are Publishers for the following Topics:
* `Root.Topic1` - `Root.Topic1`
* `Root.Topic2` - `Root.Topic2`
* `Root.Topic2.Part1` - `Root.Topic2.Part1`
* `Root.Topic2.Part2` - `Root.Topic2.Part2`
* `Root.Topic2.Part3` - `Root.Topic2.Part3`
Thereby the **Tree** is build up like that. Thereby the **Tree** is build up like that.
@ -42,31 +41,31 @@ Thereby the **Tree** is build up like that.
(Part3) (Part3)
``` ```
Data of Topics are shared only to its '*Super-Topics*' and '*Child-Topics*' (see the Examples) Data of Topics are shared only to its '_Super-Topics_' and '_Child-Topics_' (see the Examples)
### Example 1 - Publishing data on `Root/Topic2` ### Example 1 - Publishing data on `Root/Topic2`
If a Publisher of the Topic `Root.Topic2` publishes an update, the Subscribe of the following Topics receives an update. If a Publisher of the Topic `Root.Topic2` publishes an update, the Subscribe of the following Topics receives an update.
* `Root` - `Root`
* `Root.Topic2` - `Root.Topic2`
* `Root.Topic2.Part1` - `Root.Topic2.Part1`
* `Root.Topic2.Part2` - `Root.Topic2.Part2`
* `Root.Topic2.Part3` - `Root.Topic2.Part3`
Thereby each element gets the new Data in the following format: Thereby each element gets the new Data in the following format:
> **Example-Data:** `{ Part1 : 1, Part2 : 'test', Part3 : 1.337 }` is published on the Topic `Root/Topic2` > **Example-Data:** `{ Part1 : 1, Part2 : 'test', Part3 : 1.337 }` is published on the Topic `Root/Topic2`
| Topic | Received Data of the Subscription in ***JSON-Notation***| | Topic | Received Data of the Subscription in **_JSON-Notation_** |
| ---- | ---- | | --------------------- | ---------------------------------------------------------------------------------------- |
| `Root` | `{ Topic1: 'someData', Topic2 : { Part1 : 1, Part2 : 'test', Part3 : [1.337, 1.338] } }` | | `Root` | `{ Topic1: 'someData', Topic2 : { Part1 : 1, Part2 : 'test', Part3 : [1.337, 1.338] } }` |
| `Root.Topic2` | `{ Part1 : 1, Part2 : 'test', Part3 : 1.337 }` | | `Root.Topic2` | `{ Part1 : 1, Part2 : 'test', Part3 : 1.337 }` |
| `Root.Topic2.Part1` | `1` | | `Root.Topic2.Part1` | `1` |
| `Root.Topic2.Part2` | `'test'` | | `Root.Topic2.Part2` | `'test'` |
| `Root.Topic2.Part3` | `[1.337, 1.338]` | | `Root.Topic2.Part3` | `[1.337, 1.338]` |
| `Root.Topic2.Part3.0` | `1.337` | | `Root.Topic2.Part3.0` | `1.337` |
| `Root.Topic2.Part3.1` | `1.338` | | `Root.Topic2.Part3.1` | `1.338` |
> Subscriber of the Topic `Root.Topic1` doesn't receive Updates. > Subscriber of the Topic `Root.Topic1` doesn't receive Updates.
@ -74,21 +73,21 @@ Thereby each element gets the new Data in the following format:
If a Publisher of the Topic `Root.Topic2.Part3` publishes an update, the Subscribe of the following Topics receives an update. If a Publisher of the Topic `Root.Topic2.Part3` publishes an update, the Subscribe of the following Topics receives an update.
* `Root` - `Root`
* `Root.Topic2` - `Root.Topic2`
* `Root.Topic2.Part3` - `Root.Topic2.Part3`
Thereby each element gets the new Data in the following format: Thereby each element gets the new Data in the following format:
> **Example-Data:** `[1234, 1.338]` is published on the Topic `Root.Topic2.Part3` > **Example-Data:** `[1234, 1.338]` is published on the Topic `Root.Topic2.Part3`
| Topic | Received Data of the Subscription in ***JSON-Notation***| | Topic | Received Data of the Subscription in **_JSON-Notation_** |
| ---- | ---- | | --------------------- | --------------------------------------------------------------------------------------- |
| `Root` | `{ Topic1: 'someData', Topic2 : { Part1 : 1, Part2 : 'test', Part3 : [1234, 1.338] } }` | | `Root` | `{ Topic1: 'someData', Topic2 : { Part1 : 1, Part2 : 'test', Part3 : [1234, 1.338] } }` |
| `Root.Topic2` | `{ Part1 : 1, Part2 : 'test', Part3 : [1234, 1.338] }` | | `Root.Topic2` | `{ Part1 : 1, Part2 : 'test', Part3 : [1234, 1.338] }` |
| `Root.Topic2.Part3` | `[1234, 1.338]` | | `Root.Topic2.Part3` | `[1234, 1.338]` |
| `Root.Topic2.Part3.0` | `1234` | | `Root.Topic2.Part3.0` | `1234` |
| `Root.Topic2.Part3.1` | `1.338` No Update will be Pusblished, cause the value didn't change | | `Root.Topic2.Part3.1` | `1.338` No Update will be Pusblished, cause the value didn't change |
> Subscriber of the Topic `Root.Topic1`, `Root.Topic2.Part1`, `Root.Topic2.Part3.1` and `Root.Topic2.Part2` doesn't receive Updates, cause their values didn't change. > Subscriber of the Topic `Root.Topic1`, `Root.Topic2.Part1`, `Root.Topic2.Part3.1` and `Root.Topic2.Part2` doesn't receive Updates, cause their values didn't change.
@ -98,10 +97,10 @@ Thereby each element gets the new Data in the following format:
The Pub-Sub-System is build up with a Base-Node-Container. This Container is responsible to create (if necessary) new Topics on which a Subscription could be subscribe or data could be published. Based on all available Subscriptions published Data send to the corresponding Subscriptions. The Pub-Sub-System is build up with a Base-Node-Container. This Container is responsible to create (if necessary) new Topics on which a Subscription could be subscribe or data could be published. Based on all available Subscriptions published Data send to the corresponding Subscriptions.
* No multiple Pub-Sub-Systems at a Time, otherwise an exception is thrown. - No multiple Pub-Sub-Systems at a Time, otherwise an exception is thrown.
* **Subscribers must unsubscribe** if the should not listening any more. For Instance pause/deactivate or dispose an specific Object. (use the `unregister` function of a Subscribtion) - **Subscribers must unsubscribe** if the should not listening any more. For Instance pause/deactivate or dispose an specific Object. (use the `unregister` function of a Subscribtion)
* Subscriptions could be activated again by calling `register` - Subscriptions could be activated again by calling `register`
* Subscriptions are automatically active. - Subscriptions are automatically active.
--- ---
@ -109,7 +108,6 @@ The Pub-Sub-System is build up with a Base-Node-Container. This Container is res
Observables allow a simple integration of attributes of an object. Therefore the `IObserveable<T>` interface is used. Observables allow a simple integration of attributes of an object. Therefore the `IObserveable<T>` interface is used.
### Example - Integrate an Observable ### Example - Integrate an Observable
To use an Observable the following code must be used, where as `TYPE` describes the data type like `number`, `string`, etc. To use an Observable the following code must be used, where as `TYPE` describes the data type like `number`, `string`, etc.
@ -123,43 +121,40 @@ Furthermore the Class containing the observable attribute **must** implement the
```typescript ```typescript
/** Import the Pub-Sub-System (Path must be adapted) */ /** Import the Pub-Sub-System (Path must be adapted) */
import * as PUBSUB from 'Pub-Sub-System/assembly/manual-assembly'; import * as PUBSUB from "Pub-Sub-System/assembly/manual-assembly";
/** Define a Class containing an observable @see attribute_01 */ /** Define a Class containing an observable @see attribute_01 */
@injectable() @injectable()
class TestClass implements IContainsObservables { class TestClass implements IContainsObservables {
/** Values of the IOnlineValues - Interface */ /** Values of the IOnlineValues - Interface */
path: string = ''; path: string = "";
offeredTopics: Map<string, GenericObservable<any>> ; offeredTopics: Map<string, GenericObservable<any>>;
/**
* Defining the Attribute which should be integrated into the Publish
* and Subscribe System. The value should be a 'number'
*
* @type {PUBSUB.Observer<number>}
* @memberof TestClass
*/
@inject(PUBSUB.TYPES.Observable)
public attribute_01: PUBSUB.Observable<number>;
/** /**
* Defining the Attribute which should be integrated into the Publish * Creates an instance of TestClass.
* and Subscribe System. The value should be a 'number' * @memberof TestClass
* */
* @type {PUBSUB.Observer<number>} constructor() {
* @memberof TestClass /** Set a Values - That must be done during the construction */
*/ this.path = "";
@inject(PUBSUB.TYPES.Observable) this.offeredTopics = new Map<string, GenericObservable<any>>();
public attribute_01: PUBSUB.Observable<number>; }
/**
* Creates an instance of TestClass.
* @memberof TestClass
*/
constructor() {
/** Set a Values - That must be done during the construction */
this.path = '';
this.offeredTopics = new Map<string, GenericObservable<any>>();
}
} }
``` ```
### Working with Observables ### Working with Observables
By default oberserables publish their content on an automatically generated Topic. This topic could be adapted and read with the `path` - attibute of an Observable. By default observables publish their content on an automatically generated Topic. This topic could be adapted and read with the `path` - attibute of an Observable.
```typescript ```typescript
@ -171,24 +166,23 @@ To subscribe to changes of an obserable simply use the metho `subscribe`. You ca
The Following Parameters are used: The Following Parameters are used:
| Param | Type | Default | Description | | Param | Type | Default | Description |
| --- | --- | --- | --- | | ------ | ---------------------------------------------------------- | -------- | -------------------------------------------------- |
| func | [<code>subscriptionCallback</code>](#subscriptionCallback) | | Function which is called when new Datas are pushed | | func | [<code>subscriptionCallback</code>](#subscriptionCallback) | | Function which is called when new Datas are pushed |
| [mode] | `'sync'` \ `'immediate'` | `'sync'`| Mode of the Subscription | | [mode] | `'sync'` \ `'immediate'` | `'sync'` | Mode of the Subscription |
**Returns**: <code>ISubscription</code> - The corresponding Subscription **Returns**: <code>ISubscription</code> - The corresponding Subscription
whereas the <code>subscriptionCallback</code> is defined as: whereas the <code>subscriptionCallback</code> is defined as:
| Param | Type | Description | | Param | Type | Description |
| --- | --- | --- | | ----------- | ------------------- | --------------------------------------------- |
| content | <code>any</code> | The new Data | | content | <code>any</code> | The new Data |
| [topic] | <code>string</code> | The Topic on which the Data where from | | [topic] | <code>string</code> | The Topic on which the Data where from |
| [timeStamp] | <code>number</code> | The timeStamp on which the data where changed | | [timeStamp] | <code>number</code> | The timeStamp on which the data where changed |
**Returns** - <code>void</code> **Returns** - <code>void</code>
##### Example ##### Example
```typescript ```typescript
@ -197,15 +191,13 @@ const _test = new TestClass();
/** Subscribe to changes of the attribute */ /** Subscribe to changes of the attribute */
_test.attribute_01.subscribe((_num, _topic) => { _test.attribute_01.subscribe((_num, _topic) => {
console.log('subscription on', _topic, '. Value changed to:', _num); console.log("subscription on", _topic, ". Value changed to:", _num);
}, 'sync'); }, "sync");
/** Change the Value of the observable => Subscription will be triggered */ /** Change the Value of the observable => Subscription will be triggered */
_test.attribute_01.value = 1337; _test.attribute_01.value = 1337;
``` ```
#### Changing Values and reading values #### Changing Values and reading values
The value of an observable could be changed with the `value` attribute of an observable The value of an observable could be changed with the `value` attribute of an observable
@ -221,38 +213,41 @@ _test.attribute_01.value = 1337;
const _aVar = _test.attribute_01.value; const _aVar = _test.attribute_01.value;
``` ```
### Sample Application ### Sample Application
```typescript ```typescript
import { Builder } from '../../mod-Assembly-Builder/src/Container-Builder.FileLoader'; import { Builder } from "../../mod-Assembly-Builder/src/Container-Builder.FileLoader";
import { DESCRIPTION, PubSubSystem } from '../assembly/manual-assembly'; import { DESCRIPTION, PubSubSystem } from "../assembly/manual-assembly";
Builder.instance.addElements(DESCRIPTION.PROVIDED_CLASSES) Builder.instance.addElements(DESCRIPTION.PROVIDED_CLASSES);
Builder.instance.addActivationHandler(DESCRIPTION.ACTIVATIONHANDLERS); Builder.instance.addActivationHandler(DESCRIPTION.ACTIVATIONHANDLERS);
Builder.load(); Builder.load();
Builder.on('loaded', () => { Builder.on("loaded", () => {
// Create a Publish and Subscribe System
const _pubSub = Builder.instance.container.get<PubSubSystem>(
DESCRIPTION.TYPES.PubSubSystem
);
// Create a Publish and Subscribe System // Create a Subscription on the topic: "test.topic"
const _pubSub = Builder.instance.container.get<PubSubSystem>(DESCRIPTION.TYPES.PubSubSystem); const _sub = _pubSub.createSubscription<any>(
"test.topic",
(_data, _topic, _timestamp) => {
console.log("received with inform", _data);
}
);
// Create a Subscription on the topic: "test.topic" // Create a Publisher and Publish "1" on a Subtopic
const _sub = _pubSub.createSubscription<any>('test.topic', (_data, _topic, _timestamp) => { _pubSub.createPublisher<number>("test.topic.child").publishData(1);
console.log('received with inform', _data); _pubSub.createPublisher<number>("test.topic").publishData(2);
});
// Create a Publisher and Publish "1" on a Subtopic // Change the Subscription Mode.
_pubSub.createPublisher<number>('test.topic.child').publishData(1); _sub.options.mode = ["direct"];
_pubSub.createPublisher<number>('test.topic').publishData(2);
// Change the Subscription Mode.
_sub.options.mode = ['direct'];
// The following Subscription will be now ignored
_pubSub.createPublisher<number>('test.topic.child').publishData(3);
_pubSub.createPublisher<number>('test.topic').publishData(4);
// The following Subscription will be now ignored
_pubSub.createPublisher<number>("test.topic.child").publishData(3);
_pubSub.createPublisher<number>("test.topic").publishData(4);
}); });
``` ```
@ -278,8 +273,3 @@ Calling Subscription of root._test.attribute_01 the 3'th time. Value changed to
plublish 1336 on _test.attribute_01 plublish 1336 on _test.attribute_01
Calling Subscription of root._test.attribute_01 the 4'th time. Value changed to: 1336 Calling Subscription of root._test.attribute_01 the 4'th time. Value changed to: 1336
``` ```

2
modules/wamo/src/wamo.basemodule.module.ts
View File

@ -291,7 +291,7 @@ export class WaMOBaseModule
// create a PLC Connector: // create a PLC Connector:
_this._plc = await _this._dispatcher.generateInstance<PLC>({ _this._plc = await _this._dispatcher.generateInstance<PLC>({
identifier: ("wamo-" + _this.identifier + "-beckhoff-connector").toLowerCase(), identifier: ("wamo-" + beckhoffParams.plcName + "-beckhoff-connector").toLowerCase(),
params: beckhoffParams, params: beckhoffParams,
type: "BeckhoffPlc" type: "BeckhoffPlc"
}); });

4
modules/xetics-lean-connector/defaults/default.params.ts
View File

@ -1,2 +1,2 @@
export const DEFAULT_TOKEN = "Basic YXBpdXNlcjpkR1E2amdEc0ZKN21aaHZnM0FZZg=="; export const DEFAULT_TOKEN = "Basic YXBpdXNlcjo1VnR6dHM5NXVFNEpVNldpMzhpMg==";
export const DEFAULT_URI = "http://mes.demonstrator04.local/zema"; export const DEFAULT_URI = "http://mes.demonstrator04.local/release";