View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2012 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.client;
20  
21  import java.io.IOException;
22  import java.net.URI;
23  import java.util.concurrent.Future;
24  
25  import org.eclipse.jetty.websocket.api.WebSocketPolicy;
26  import org.eclipse.jetty.websocket.client.masks.Masker;
27  import org.eclipse.jetty.websocket.common.events.EventDriver;
28  
29  public interface WebSocketClient
30  {
31      public Future<ClientUpgradeResponse> connect(URI websocketUri) throws IOException;
32  
33      public WebSocketClientFactory getFactory();
34  
35      public Masker getMasker();
36  
37      public WebSocketPolicy getPolicy();
38  
39      public ClientUpgradeRequest getUpgradeRequest();
40  
41      public ClientUpgradeResponse getUpgradeResponse();
42  
43      public EventDriver getWebSocket();
44  
45      public URI getWebSocketUri();
46  
47      public void setMasker(Masker masker);
48  }