Enonic XP web socket utility library

Dependencies

Add the repository and dependencies in your build.gradle file

repositories {
  maven { url 'https://jitpack.io' }
}

dependencies {
  include "com.enonic.xp:lib-portal:${xpVersion}"
  include "com.enonic.xp:lib-io:${xpVersion}"
  include "com.enonic.xp:lib-websocket:${xpVersion}"
  include "no.item:lib-xp-wsutil:2.0.0"
}

Documentation

Go here for documentation

Versions

2.0.0

• Turn of logging by setting no.item.wsUtils.printLog to false in the config file for the project using this lib.
• Upgraded to build on XP 7.5.0.
• Compatibility Enonic XP 7.5.0.

1.1.1

• Added getWsEvents method to improve reusability

1.0.0

• Initital release

Compatibility Enonic XP 6.4.0

Files included

src/
   |- main/
          |- resources/
                      |- assets/
                      |        |- clientws.js // Client side library
                      |- lib/
                            |- virtual.js // Virtual documentation file
                            |- wsUtils.js // Server side library

Hello sockets

Here is the shortest example for opening websocket communication in your project

<!-- Add these tags to your html for page part etc.. -->
<script src="mysite/_/service/com.my.app/websocket"></script>
<script src="mysite/_/asset/com.my.app/clientws.js"></script>

// Create a service called websocket
var ws = require('/lib/wsUtil');
ws.openWebsockets(exports);

// Create an asset called clientws.js
var clientWs = new ExpWS();
clientWs.connect();

Check the console/server logs to see that your connection is alive

License

This project is under the Apache 2.0 license. For more information please read LICENSE.txt

Author

Per Arne Drevland Consultant Item Consulting AS