From 79630de1f194e9edb0d1807b7d1841fbc5acd7ee Mon Sep 17 00:00:00 2001
From: Joakim Erdfelt
Date: Fri, 1 Mar 2013 09:31:29 -0700
Subject: 402148 - Update Javadoc for WebSocketServlet for new API

---
 .../jetty/websocket/servlet/WebSocketServlet.java  | 10 ++++---
 .../src/test/java/examples/MyExampleServlet.java   | 35 ++++++++++++++++++++++
 .../src/test/java/examples/MyExampleSocket.java    | 34 +++++++++++++++++++++
 3 files changed, 75 insertions(+), 4 deletions(-)
 create mode 100644 jetty-websocket/websocket-servlet/src/test/java/examples/MyExampleServlet.java
 create mode 100644 jetty-websocket/websocket-servlet/src/test/java/examples/MyExampleSocket.java

(limited to 'jetty-websocket/websocket-servlet/src')

diff --git a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketServlet.java b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketServlet.java
index 355accfbae..609a812625 100644
--- a/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketServlet.java
+++ b/jetty-websocket/websocket-servlet/src/main/java/org/eclipse/jetty/websocket/servlet/WebSocketServlet.java
@@ -42,15 +42,17 @@ import org.eclipse.jetty.websocket.api.annotations.WebSocket;
  * <pre>
  * package my.example;
  * 
- * import javax.servlet.http.HttpServletRequest;
- * import org.eclipse.jetty.websocket.WebSocket;
- * import org.eclipse.jetty.websocket.server.WebSocketServlet;
+ * import org.eclipse.jetty.websocket.servlet.WebSocketServlet;
+ * import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory;
  * 
  * public class MyEchoServlet extends WebSocketServlet
  * {
  *     &#064;Override
- *     public void registerWebSockets(WebSocketServerFactory factory)
+ *     public void configure(WebSocketServletFactory factory)
  *     {
+ *         // set a 10 second idle timeout
+ *         factory.getPolicy().setIdleTimeout(10000);
+ *         // register my socket
  *         factory.register(MyEchoSocket.class);
  *     }
  * }
diff --git a/jetty-websocket/websocket-servlet/src/test/java/examples/MyExampleServlet.java b/jetty-websocket/websocket-servlet/src/test/java/examples/MyExampleServlet.java
new file mode 100644
index 0000000000..b81559a754
--- /dev/null
+++ b/jetty-websocket/websocket-servlet/src/test/java/examples/MyExampleServlet.java
@@ -0,0 +1,35 @@
+//
+//  ========================================================================
+//  Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
+//  ------------------------------------------------------------------------
+//  All rights reserved. This program and the accompanying materials
+//  are made available under the terms of the Eclipse Public License v1.0
+//  and Apache License v2.0 which accompanies this distribution.
+//
+//      The Eclipse Public License is available at
+//      http://www.eclipse.org/legal/epl-v10.html
+//
+//      The Apache License v2.0 is available at
+//      http://www.opensource.org/licenses/apache2.0.php
+//
+//  You may elect to redistribute this code under either of these licenses.
+//  ========================================================================
+//
+
+package examples;
+
+import org.eclipse.jetty.websocket.servlet.WebSocketServlet;
+import org.eclipse.jetty.websocket.servlet.WebSocketServletFactory;
+
+@SuppressWarnings("serial")
+public class MyExampleServlet extends WebSocketServlet
+{
+    @Override
+    public void configure(WebSocketServletFactory factory)
+    {
+        // set a 10 second timeout
+        factory.getPolicy().setIdleTimeout(10000);
+        // register my socket
+        factory.register(MyExampleSocket.class);
+    }
+}
diff --git a/jetty-websocket/websocket-servlet/src/test/java/examples/MyExampleSocket.java b/jetty-websocket/websocket-servlet/src/test/java/examples/MyExampleSocket.java
new file mode 100644
index 0000000000..cffefaa6c8
--- /dev/null
+++ b/jetty-websocket/websocket-servlet/src/test/java/examples/MyExampleSocket.java
@@ -0,0 +1,34 @@
+//
+//  ========================================================================
+//  Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
+//  ------------------------------------------------------------------------
+//  All rights reserved. This program and the accompanying materials
+//  are made available under the terms of the Eclipse Public License v1.0
+//  and Apache License v2.0 which accompanies this distribution.
+//
+//      The Eclipse Public License is available at
+//      http://www.eclipse.org/legal/epl-v10.html
+//
+//      The Apache License v2.0 is available at
+//      http://www.opensource.org/licenses/apache2.0.php
+//
+//  You may elect to redistribute this code under either of these licenses.
+//  ========================================================================
+//
+
+package examples;
+
+import org.eclipse.jetty.websocket.api.WebSocketAdapter;
+
+/**
+ * Example WebSocket, simple echo
+ */
+public class MyExampleSocket extends WebSocketAdapter
+{
+    @Override
+    public void onWebSocketText(String message)
+    {
+        // Echo message back, asynchronously
+        getSession().getRemote().sendStringByFuture(message);
+    }
+}
-- 
cgit v1.2.3