Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A barebones WebSocket client and server implementation written in 100% Java.

tag: v0.5

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 dist
Octocat-spinner-32 doc
Octocat-spinner-32 example
Octocat-spinner-32 src
Octocat-spinner-32 .gitignore
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.markdown
Octocat-spinner-32 build.xml
README.markdown

Java WebSockets

This repository contains a barebones WebSocket server and client implementation written in 100% Java. The implementation supports both the older draft 75, and current draft 76. The underlying classes use the Java ServerSocketChannel and SocketChannel classes, which allows for a non-blocking event-driven model (similar to the WebSocket API for web browsers).

Running the Example

There's a simple chat server and client example located in the example folder. First, compile the example classes and JAR file: ant

Then, start the chat server (a WebSocketServer subclass): java -cp example:dist/WebSocket.jar ChatServer

Now that the server is started, we need to connect some clients. Run the Java chat client (a WebSocketClient subclass): java -cp example:dist/WebSocket.jar ChatClient

The chat client is a simple Swing GUI application that allows you to send messages to all other connected clients, and receive messages from others in a text box.

There's also a simple HTML file chat client chat.html, which can be opened by any browser. If the browser natively supports the WebSocket API, then it's implementation will be used, otherwise it will fall back to a Flash-based WebSocket Implementation.

Writing your own WebSocket Server

The net.tootallnate.websocket.WebSocketServer abstract class implements the server-side of the WebSocket Protocol. A WebSocket server by itself doesn't do anything except establish socket connections though HTTP. After that it's up to your subclass to add purpose.

Writing your own WebSocket Client

The net.tootallnate.websocket.WebSocketClient abstract class can connect to valid WebSocket servers. The constructor expects a valid ws:// URI to connect to. Important events onOpen, onClose, and onMessage get fired throughout the life of the WebSocketClient, and must be implemented in your subclass.

License

Everything found in this repo is licensed under an MIT license. See the LICENSE file for specifics.

Something went wrong with that request. Please try again.