View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.websocket.server;
20  
21  import java.io.IOException;
22  
23  import org.eclipse.jetty.websocket.servlet.ServletUpgradeRequest;
24  import org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse;
25  
26  public interface WebSocketHandshake
27  {
28      /**
29       * Formulate a WebSocket upgrade handshake response.
30       * 
31       * @param request the request
32       * @param response the response
33       * @throws IOException if unable to handshake
34       */
35      public void doHandshakeResponse(ServletUpgradeRequest request, ServletUpgradeResponse response) throws IOException;
36  }