include code to provide options for Web-Clients to request feedback f…

[kaennchenstruggle]

Feature Addition

Description

Currently there is no path for (Web) Clients to request direct feedback from a module. This PR enables clients to wait for a feedback from the module or a definable number of instances of this module.

This is achieved by introducing the mmmrc_options object into the payload. mmmrc_options currently includes the following objects:

• wait - set to true if this feature should be enabled (mandatory)
• responsecount - number of feedbacks to wait for until feedback is returned (optional, default: 1)
• timeout - amount of ms to wait for all feedbacks until timeout is generated (optional, default 1000ms)

This module then sends a notification to the desired module's instances including the mmrc_options object from above, now adding a sub-object type=request and a sub-object id

The desired module responds with a sendNotification of type MMMRC_RESPONSE with a payload object response containing data to be transmitted and the object mmmrc_options now with type=response and the unchanged id.

Example code:

var dataobject={ "var1" : "value1", "var2"  : true };
this.sendNotification("MMMRC_RESPONSE", {'payload': { "response": dataobject, "mmmrc_options": { "type": "response", "id": mmmrc_options.id} }});

Once all feedbacks (see "responsecount" above) are collected or timeout has passed, this module returns data to the calling client.

Example return data:

{
  "payload": {
    "success": true,
    "responses": [
      {
        "var1" : "value_from_module_instance1",
        "var2" : true
      },{
        "var1" : "value_module_instance2",
        "var2" : true
      }
    ],
    "mmmrc_options": {
      "type": "response",
      "id": "IDlo5jkx4v154hah8oq",
      "timeout": 1000
    }
  }
}

Changelog

Requirements

none

Additional info

none, but feel free to ask :D

[github-actions]

This pull request has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.