The Apache Tomcat Servlet/JSP Container

Apache Tomcat 7

Version 7.0.37, Feb 12 2013
Apache Logo

Links

User Guide

Reference

Apache Tomcat Development

WebSocket How-To

Table of Contents
Overview

Tomcat provides support for WebSocket as defined by RFC 6455. This feature is not yet finalised and you are encouraged to provide feedback in the form of bug reports (via Bugzilla), suggested API changes (via the dev list) or other comments (again via the dev list).

Application development

The API used for application development has not yet been finalised. Rather than document something here that will quickly be out of date, please see the Javadoc for the org.apache.catalina.websocket package. The Javadoc pages are not included with Tomcat binary distributions. To view them locally you would have to download and install "Full documentation" distribution, or build it from sources. You can also read this on the Apache Tomcat web site. Start with the WebSocketServlet class.

There are also several example applications that demonstrate how the WebSocket API can be used. You'll need to look at both the client side html and the server side code.

Do keep in mind that the API is fluid and is likely to change, possibly significantly, between point releases. The documentation will be updated once the API is considered stable (unlikely to be until JSR 356 is complete).

Comments

Notice: This is not a Q&A section. The Apache Comments System is explained here. Comments should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic.

Questions on how to configure or use Apache Tomcat should be directed to our mailing lists. If you need help, ask on the users mailing list.


Copyright © 1999-2013, Apache Software Foundation