https://github.com/isapir/lucee-websocket

Enables server WebSockets for Lucee via JSR-356 compliant servlet containers (e.g. Tomcat 8, Jetty 9.1, etc.)
https://github.com/isapir/lucee-websocket

java lucee lucee-server websocket-server websockets

Last synced: about 1 year ago
JSON representation

Enables server WebSockets for Lucee via JSR-356 compliant servlet containers (e.g. Tomcat 8, Jetty 9.1, etc.)

• Host: GitHub
• URL: https://github.com/isapir/lucee-websocket
• Owner: isapir
• License: lgpl-2.1
• Created: 2017-03-22T18:20:42.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-01-20T16:49:47.000Z (over 4 years ago)
• Last Synced: 2025-04-15T05:51:55.187Z (about 1 year ago)
• Topics: java, lucee, lucee-server, websocket-server, websockets
• Language: Java
• Homepage:
• Size: 63.5 KB
• Stars: 18
• Watchers: 7
• Forks: 6
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: License.txt

Awesome Lists containing this project

README

          
## Requirements

* Java 8

* JSR-356 Compliant Servlet Container, e.g. Tomcat 8, Jetty 9.1, etc.

* Lucee 5.1.3.18

## Installation 

## Update July 14th, 2017

Version 2.0.1 is out, and it fixes major issues but also adds to the installation process a bit.  The new installation process is as follows:

- If a previous version of the extension is installed -- Uninstall it

- Install the extension from the Admin or by downloading the `.lex` file and dropping it in the `deploy` directory

- Save the jar file `servlet-filter-utils-1.1.1.jar` to the classpath, e.g. if you're using Tomcat it can go into `{tomcat}/lib`, or if you're using Jetty then it can go into `{jetty}/lib/ext`

- Add the following snippet to your web deployment descriptor (web.xml), **be sure to modify the `url-pattern` to match your URLs that will used with WebSockets**:

```xml

        

    

      HttpSessionInitializerFilter

      net.twentyonesolutions.servlet.filter.HttpSessionInitializerFilter

    

    

      HttpSessionInitializerFilter

      

      /ws/*

    

```

- Restart the Servlet Container (e.g. Tomcat, Jetty, etc.)

### Breaking Change

The function `WebsocketRegister()` has been renamed to `WebsocketServer()`.  I hope to add a `WebsocketClient()` function soon so I wanted the names to make sense.

---

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.

## Getting Started

The WebSocket API is event driven, meaning that you register event handling methods (e.g. _onOpen()_, _onMessage()_, etc), and those are called when the corresponding events are triggered.

To configure a WebSocket endpoint call the function 

    WebsocketRegister(String endpoint, Component listener):ConnectionManager

    

Where `endpoint` is the URI for the incoming WebSocket connections, e.g. `/ws/chat/{channel}`, and the Component listener is a component that implements any of the event handling methods as specified in the [Listener Component API](../../wiki/Listener-Component-API).

    

This should only be done once, so you can do that in Application.cfc's onApplicationStart().

Each _endpoint_ has its own [ConnectionManager](../../wiki/ConnectionManager-API) object, which keeps track of all of the client WebSockets that are connected to that _endpoint_.  You can either store the _ConnectionManager_ in an Application scope variable, or retrieve it from a [WebSocket](wiki/WebSocket-API) object that is passed as as argument to some of the event handlers by calling the method _getConnectionManager()_ on that argument, i.e. `arguments.websocket.getConnectionManager()`.

## Documentation and Tutorials

Check the [WIKI](../../wiki) for reference and documentation

Watch Getting Started Video Tutorial at:

[![Getting Started with Lucee WebSockets](http://img.youtube.com/vi/r2s2kGQVZqg/0.jpg)](http://www.youtube.com/watch?v=r2s2kGQVZqg "Lucee WebSockets - Getting Started")

Watch Chat Server Example Video Tutorial at:

[![Chat Server Example Video](http://img.youtube.com/vi/rvB7PcNylVY/0.jpg)](http://www.youtube.com/watch?v=rvB7PcNylVY "Lucee WebSockets - Getting Started")

## Discussion

Please use [Lucee Websockets Extension on Lucee Dev](https://dev.lucee.org/t/lucee-websockets-extension/2067)

## Copyright / License

Copyright 2016-2017 Igal Sapir

This software is licensed under the Lesser GNU General Public License Version 2.1 (or later); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

[http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt)

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.