JavaScript API to register websocket event listeners

[glassfishrobot]

I would like to note that in my view the current way to specify JavaScript callbacks for websocket events by referring to JavaScript functions by name isn't very nice. Especially because developers have to define callback functions in the global scope, which is considered as bad practice in modern JavaScript development.

What about something like this:

<f:websocket id="mySocket" channel="push" />

  <script type="application/javascript">
    // register callback using the client id
    jsf.push.addOnMessage('mySocket', function(message) {
      // process message
    });
  </script>

With this API developers won't have to define any global callback functions and they can even dynamically add more listeners at runtime if required. It is somehow similar to jsf.ajax.addOnEvent(), but would always refer to a specific <f:websocket> using the clientId.

Affected Versions

[2.3]

[glassfishrobot]

Reported by chkal

[glassfishrobot]

This issue was imported from java.net JIRA JAVASERVERFACES_SPEC_PUBLIC-1442

[glassfishrobot]

Closing this as this issue is migrated to jakartaee/faces#1442