netty-socketio Documentation

Netty-socketio is an open-source Java implementation of the Socket.IO server based on the Netty framework. Key features include:

• Protocol Support: Supports Socket.IO-client versions 1.x through 4.x.
• Transports: Supports both xhr-polling and websocket transports.
• Organization: Supports namespaces and rooms.
• Data Handling: Supports acknowledgments (ack) for received data.
• Security: Supports SSL.
• Scalability & Storage: Supports client stores (Memory, Hazelcast, or Redisson) and distributed broadcasting across multiple nodes using Redisson or Hazelcast.
• Integration: Supports OSGi, Spring, and contains Java module info for JPMS.
• Concurrency: Lock-free and thread-safe implementation with declarative handler configuration via annotations.

To use netty-socketio in your Java project, add the following dependency to your pom.xml file. Note that while the JAR is compatible with Java 8, building the module-info requires Java 11+.

<dependency>
 <groupId>com.corundumstudio.socketio</groupId>
 <artifactId>netty-socketio</artifactId>
 <version>2.0.13</version>
</dependency>