Copyright (c) 2010 Nathan Rajlich

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

Java WebSockets

This repository contains a simple WebSocket server and client implementation

in Java. The underlying classes use `ServerSocketChannel` and `SocketChannel`

objects, to allow 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, start the chat server (a WebSocketServer subclass):

cd example/

java ChatServer

Now that the server is started, we need to connect some clients. Run the

Java chat client (a WebSocketClient subclass):

java ChatClient

The chat client is a simple Swing GUI that allows you to send messages to

all other connected clients, and recieve 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 that supports the WebSocket API (currently Chrome 4, Safari

nightlies, Firefox nightlies).

Writing your own WebSocket Server

A WebSocketServer by itself doesn't do anything except establish socket

connections though HTTP. After that it's up to a subclass to add purpose.

Writing your own WebSocket Client

The WebSocketClient aims to simulate the WebSocket API

(<http://dev.w3.org/html5/websockets/>) as closely as possible.

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.