NodeEventViewer/DESIGN at master · kingrichard2005/NodeEventViewer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76


Web Browsers

+---------+
| Client 1|
+---------+--+    JSON SUBSCRIBER     +-------------+            +----------------+
  | Client 2 |<======================>| Node Server |<==========>| DOCUMENT STORE |
  +----------+--+      API            +-------------+            +----------------+
    | Client N  |                           ||
	 +-----------+                           ||
	                                         || JSON SENDER
	                                         || API
														  ||
				                      +----------------+
										    | Event Source 1 |
											 +----------------+--+
											    | Event Source 2 |
												 +----------------+--+
												    | Event Source N |
													 +----------------+

Functional Block Descriptions

1. Clients

Clients are transient endpoints which may subscribe to one or more event
classes via the JSON SUBSCRIBER API. Once subscribed to an event channel,
Clients are sent Event Notifications. Event Notifications are described below.

2. Node Server

A Node Server manages transactions between one or more event sources, one or
more clients, and a document store.

3. Document Store

A document store stores Events sent from Event Sources and Event Actions sent
from Clients.

Data Object Descriptions

1. Subscription Requests/Responses

A JSON object which requests/responds to a request to subscribe to an event channel.

Properties

Application?
EventMajor, integer, A per-application identifier which classifies the event
to subscribe to.
EventMinor, integer, An application-specific identifier which categorizes the
event.
EventLevel?

2. Event Notifications

Event notifications are JSON objects which describe a single event.

Properties

Application?
EventMajor, integer, A per-application identifer which classifies the event.
EventMinor, integer, An application-specific identifier which categorizes the event.
EventLevel?
EventID, integer, An application-specific numeric identifier for an event.
EventMsg, string, An application-specific string describing the event.

3. Event Actions

EventIndex, integer, a number which uniquely identifies an event in the
document store.

EventAction, integer, a number corresponding to an action which modifies an
event in the document store.