Class WebSocketServer
Version 1.0
Modified 15-JAN-2025 13:23:34.00
 The WebSocketServer object defines a web socket server on a proview node.

 The existence of a WebSocketServer object in a node will cause a
 server process (GdhWebSocketServer) to start, which provides the HTML5/javascript
 interface with information from the realtime database.

See also



RtBody attributes pwr_sClass_WebSocketServer
String80 Description   Optional description.
Int32 MaxConnections   Max number of web connections to the GdhServer process
Int32 CurrentConnections   Number of current connection to the GdhServer process
Array of String80 EventSelectList   A message created by an ASup or DSup object gets the
same identity as the supervised object. Messages
produced in an application by means of mh_ApplMessage
(see Proview Programmer's Reference Manual) get an
identity according to the calling parameter EventName.

SelectList specifies the hierarchies from which
messages are to be sent to the user. Up to 20 different
hierarchies can be specified. If messages from e.g. a
Watchdog object in a node will be received, then the
name of the node will be specified.

Note! If the SelectList is left blank no message at all is
sent to the user.
EventTypeMask EventSelectType   Specifies the type of events that are sent to the user.
If no type is specified, all types av events are sent.
UInt32 MaxNoOfAlarms   Specifies the maximum number of contemporary alarms in
the user's alarm list.
The number should exceed the maximum number of
concurrent alarms in the system.
If the limit is exceeded, alarms might be lost.
UInt32 MaxNoOfEvents   Specifies the maximum number of contemporary events in
the user's event list, i.e. the skyline of the events.
When the number of events exceeds MaxNoOfEvents the
oldest event disappears from the list.
To this list events are sent from the message handler
in respective node. In each node the message handler
has its own skyline of events (also named MaxNoOfEvents)
defined by a MessageHandler object. In principle, the
User object's skyline of events should be selected as å
MaxNoOfEvents, added up over MaxNoOfEvents in the
MessageHandler objects in all nodes throughout the
PROVIEW/R system, or make it simple and assign the
attribute e.g. 200.


Template Object
MaxConnections 50
MaxNoOfAlarms 200
MaxNoOfEvents 500


Attributes detail


Description Attribute
Klass Attribute
Typ String80
Flags
Kropp RtBody
 Optional description.

MaxConnections Attribute
Klass Attribute
Typ Int32
Flags
Kropp RtBody
 Max number of concurrent connections to the GdhServer process.
 Every graph-applet that is displayed, opens a link to the GdhServer
 process. If MaxConnections is exceeded, the connect request will
 be rejected.

CurrentConnections Attribute
Klass Attribute
Typ Int32
Flags STATE | INVISIBLE
Kropp RtBody
 Number of current connections to the GdhSever process.
 Every graph-applet opens a link to the GdhServer process. The current
 number of links is displayed in this attribute.

EventSelectList Attribute
Klass Attribute
Typ Array of String80
Flags ARRAY
Elements 40
Kropp RtBody
 A message created by an ASup or DSup object gets the
 same identity as the supervised object. Messages
 produced in an application by means of mh_ApplMessage
 (see Proview Programmer's Reference Manual) get an
 identity according to the calling parameter EventName.

 SelectList specifies the hierarchies from which
 messages are to be sent to the user. Up to 20 different
 hierarchies can be specified. If messages from e.g. a
 Watchdog object in a node will be received, then the
 name of the node will be specified.

 Note! If the SelectList is left blank no message at all is
 sent to the user.

EventSelectType Attribute
Klass Attribute
Typ EventTypeMask
Flags
Kropp RtBody
 Specifies the type of events that are sent to the user.
 If no type is specified, all types av events are sent.

MaxNoOfAlarms Attribute
Klass Attribute
Typ UInt32
Flags
Kropp RtBody
 Specifies the maximum number of contemporary alarms in
 the user's alarm list.
 The number should exceed the maximum number of
 concurrent alarms in the system.
 If the limit is exceeded, alarms might be lost.

MaxNoOfEvents Attribute
Klass Attribute
Typ UInt32
Flags
Kropp RtBody
 Specifies the maximum number of contemporary events in
 the user's event list, i.e. the skyline of the events.
 When the number of events exceeds MaxNoOfEvents the
 oldest event disappears from the list.
 To this list events are sent from the message handler
 in respective node. In each node the message handler
 has its own skyline of events (also named MaxNoOfEvents)
 defined by a MessageHandler object. In principle, the
 User object's skyline of events should be selected as å
 MaxNoOfEvents, added up over MaxNoOfEvents in the
 MessageHandler objects in all nodes throughout the
 PROVIEW/R system, or make it simple and assign the
 attribute e.g. 200.