| # Apache Tomcat 7 Version 7.0.30, Sep 2 2012 |

Links Docs Home FAQ User Guide 1) Introduction 2) Setup 3) First webapp 4) Deployer 5) Manager 6) Realms and AAA 7) Security Manager 8) JNDI Resources 9) JDBC DataSources 10) Classloading 11) JSPs 12) SSL 13) SSI 14) CGI 15) Proxy Support 16) MBean Descriptor 17) Default Servlet 18) Clustering 19) Load Balancer 20) Connectors 21) Monitoring and Management 22) Logging 23) APR/Native 24) Virtual Hosting 25) Advanced IO 26) Additional Components 27) Mavenized 28) Security Considerations 29) Windows Service 30) Windows Authentication 31) Tomcat's JDBC Pool 32) WebSocket Reference Release Notes Configuration Tomcat Javadocs Servlet Javadocs JSP 2.2 Javadocs EL 2.2 Javadocs JK 1.2 Documentation Apache Tomcat Development Building Changelog Status Developers Architecture Functional Specs. | # WebSocket How-To
Table of Contents
Overview Application development
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).
Copyright © 1999-2012, Apache Software Foundation