2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4 * Copyright 2013-2014 Oracle and/or its affiliates. All rights reserved.
6 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.
7 * Other names may be trademarks of their respective owners.
9 * The contents of this file are subject to the terms of either the GNU
10 * General Public License Version 2 only ("GPL") or the Common
11 * Development and Distribution License("CDDL") (collectively, the
12 * "License"). You may not use this file except in compliance with the
13 * License. You can obtain a copy of the License at
14 * http://www.netbeans.org/cddl-gplv2.html
15 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
16 * specific language governing permissions and limitations under the
17 * License. When distributing the software, include this License Header
18 * Notice in each file and include the License file at
19 * nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
20 * particular file as subject to the "Classpath" exception as provided
21 * by Oracle in the GPL Version 2 section of the License file that
22 * accompanied this code. If applicable, add the following below the
23 * License Header, with the fields enclosed by brackets [] replaced by
24 * your own identifying information:
25 * "Portions Copyrighted [year] [name of copyright owner]"
29 * The Original Software is NetBeans. The Initial Developer of the Original
30 * Software is Oracle. Portions Copyright 2013-2014 Oracle. All Rights Reserved.
32 * If you wish your version of this file to be governed by only the CDDL
33 * or only the GPL Version 2, indicate your decision by adding
34 * "[Contributor] elects to include this software in this distribution
35 * under the [CDDL or GPL Version 2] license." If you do not indicate a
36 * single choice of license, a recipient has the option to distribute
37 * your version of this file under either the CDDL, the GPL Version 2 or
38 * to extend the choice of license to its licensees as provided above.
39 * However, if you add GPL Version 2 code and therefore, elected the GPL
40 * Version 2 license, then the option applies only if the new code is
41 * made subject to such option by the copyright holder.
43 package org.apidesign.html.json.spi;
45 import net.java.html.BrwsrCtx;
46 import org.apidesign.html.context.spi.Contexts.Provider;
48 /** Interface for providers of WebSocket protocol. Register into a
49 * {@link BrwsrCtx context} in your own {@link Provider}
51 * @author Jaroslav Tulach <jtulach@netbeans.org>
52 * @param <WebSocket> internal implementation type representing the socket
55 public interface WSTransfer<WebSocket> {
56 /** Initializes a web socket. The <code>callback</code> object should
57 * have mostly empty values: {@link JSONCall#isDoOutput()} should be
58 * <code>false</code> and thus there should be no {@link JSONCall#getMessage()}.
59 * The method of connection {@link JSONCall#getMethod()} is "WebSocket".
60 * Once the connection is open call {@link JSONCall#notifySuccess(java.lang.Object) notifySuccess(null)}.
61 * When the server sends some data then, pass them to
62 * {@link JSONCall#notifySuccess(java.lang.Object) notifySuccess} method
63 * as well. If there is an error call {@link JSONCall#notifyError(java.lang.Throwable)}.
65 * @param url the URL to connect to
66 * @param callback a way to provide results back to the client
67 * @return your object representing the established web socket
69 public WebSocket open(String url, JSONCall callback);
71 /** Sends data to the server. The most important value
72 * of the <code>data</code> parameter is {@link JSONCall#getMessage()},
73 * rest can be ignored.
75 * @param socket internal representation of the socket
76 * @param data the message to be sent
78 public void send(WebSocket socket, JSONCall data);
80 /** A request to close the socket.
81 * @param socket internal representation of the socket
83 public void close(WebSocket socket);