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