Getting Started

Requirements

• Java 8
• JSR-356 Compliant Servlet Container, e.g. Tomcat 8, Jetty 9.1, etc.
• Lucee 5.1.3.18

Installation

The easiest way to install the extension is from the Lucee Admin. Navigate to the Extension Applications page in the Web or Server Admin, e.g. /lucee/admin/server.cfm?action=ext.applications. Click the Lucee Websockets Extension icon, and then on the next page click the Install button.

Next Steps

1. Write a Listener Component and implement the methods for the events that you wish to handle, e.g. onMessage(), onError(), etc.
2. Create an instance of the Listener Component
3. Register the Listener Component instance with an endpoint by calling the WebsocketRegister() function

Now simply connect a WebSocket Client (e.g. JavaScript WebSocket Client) to the registered endpoint, and send messages between the client and server.

See Also

• Echo Example
• Broadcast Example