org.apidesign.html.json.spi

Interface WSTransfer<WebSocket>

Type Parameters:

WebSocket - internal implementation type representing the socket

public interface WSTransfer<WebSocket>

Interface for providers of WebSocket protocol. Register into a context in your own Contexts.Provider

Since:

0.5

Author:

Jaroslav Tulach

Method Summary

Methods

Modifier and Type	Method and Description
void	close(WebSocket socket) A request to close the socket.
WebSocket	open(String url, JSONCall callback) Initializes a web socket.
void	send(WebSocket socket, JSONCall data) Sends data to the server.

Method Detail

open

WebSocket open(String url,
             JSONCall callback)

Initializes a web socket. The callback object should have mostly empty values: JSONCall.isDoOutput() should be false and thus there should be no JSONCall.getMessage(). The method of connection JSONCall.getMethod() is "WebSocket". Once the connection is open call notifySuccess(null). When the server sends some data then, pass them to notifySuccess method as well. If there is an error call JSONCall.notifyError(java.lang.Throwable).

Parameters:

url - the URL to connect to

callback - a way to provide results back to the client

Returns:

your object representing the established web socket

send

void send(WebSocket socket,
        JSONCall data)

Sends data to the server. The most important value of the data parameter is JSONCall.getMessage(), rest can be ignored.

Parameters:

socket - internal representation of the socket

data - the message to be sent

close

void close(WebSocket socket)

A request to close the socket.

Parameters:

socket - internal representation of the socket