org.realityforge.gwt.websockets.client

Class WebSocket

java.lang.Object

org.realityforge.gwt.websockets.client.WebSocket

public abstract class WebSocket
extends java.lang.Object

The WebSocket class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebSocket.BinaryType The types of data the WebSocket can receive.
static interface	WebSocket.Factory The factory used for creating WebSocket instances.
static class	WebSocket.ReadyState The states of the WebSocket.

Constructor Summary

Constructors

Constructor and Description
WebSocket()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close the WebSocket and stop receiving MessageEvents.
void	close(short code) Close the WebSocket with specified code and stop receiving MessageEvents.
abstract void	close(short code, java.lang.String reason) Close the WebSocket with specified code and reason, and stop receiving MessageEvents.
abstract void	connect(java.lang.String url, java.lang.String... protocols) Connect the WebSocket to the specified url, passing specified protocols.
static boolean	deregister(WebSocket.Factory factory) Deregister factory if the specified factory is the registered factory.
abstract WebSocket.BinaryType	getBinaryType() Return the type of the binary messages that the WebSocket will receive.
abstract int	getBufferedAmount() Return the amount buffered on underlying WebSocket.
abstract java.lang.String	getExtensions() Return the extensions that the underlying WebSocket is connected using.
WebSocketListener	getListener() Return the listener associated with the WebSocket.
abstract java.lang.String	getProtocol() Return the protocol used by the underlying WebSocket.
abstract WebSocket.ReadyState	getReadyState() Return the state of the WebSocket.
abstract java.lang.String	getURL() Return the url that the underlying WebSOcket is connected to.
abstract boolean	isConnected()
static boolean	isSupported()
static WebSocket	newWebSocketIfSupported() Create a WebSocket if supported by the platform.
protected void	onClose(boolean wasClean, int code, java.lang.String reason) Fire a Close event.
protected void	onError() Fire an Error event.
protected void	onMessage(ArrayBuffer data) Fire a Message event.
protected void	onMessage(java.lang.String data) Fire a Message event.
protected void	onOpen() Fire a Connected event.
static void	register(WebSocket.Factory factory) Register a factory to be used to construct WebSocket instances.
abstract void	send(ArrayBuffer data) Send some ArrayBuffer data across the WebSocket.
abstract void	send(ArrayBufferView data) Send some ArrayBufferView data across the WebSocket.
abstract void	send(java.lang.String data) Send some string data across the WebSocket.
abstract void	setBinaryType(WebSocket.BinaryType binaryType) Set the type of the binary messages that the WebSocket will receive.
void	setListener(WebSocketListener listener) Set the listener to receive messages from the WebSocket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebSocket

public WebSocket()

Method Detail

newWebSocketIfSupported

public static WebSocket newWebSocketIfSupported()

Create a WebSocket if supported by the platform. This method will use the registered factory to create the WebSocket instance.

Returns:

a WebSocket instance, if supported by the platform, null otherwise.

isSupported

public static boolean isSupported()

Returns:

true if newWebSocketIfSupported() will return a non-null value, false otherwise.

register

public static void register(@Nonnull
                            WebSocket.Factory factory)

Register a factory to be used to construct WebSocket instances. This is not usually used as the built in browser based factory will be detected and used if available. The register method is typically used by test frameworks.

Parameters:

factory - the factory to register.

deregister

public static boolean deregister(@Nonnull
                                 WebSocket.Factory factory)

Deregister factory if the specified factory is the registered factory.

Parameters:

factory - the factory to deregister.

Returns:

true if able to deregister, false otherwise.

connect

public abstract void connect(@Nonnull
                             java.lang.String url,
                             @Nonnull
                             java.lang.String... protocols)
                      throws java.lang.IllegalStateException

Connect the WebSocket to the specified url, passing specified protocols.

Parameters:

url - the url to open.

Throws:

java.lang.IllegalStateException - if the WebSocket is already open.

close

public abstract void close()
                    throws java.lang.IllegalStateException

Close the WebSocket and stop receiving MessageEvents.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

close

public final void close(short code)
                 throws java.lang.IllegalStateException

Close the WebSocket with specified code and stop receiving MessageEvents.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

close

public abstract void close(short code,
                           @Nullable
                           java.lang.String reason)
                    throws java.lang.IllegalStateException

Close the WebSocket with specified code and reason, and stop receiving MessageEvents.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

isConnected

public abstract boolean isConnected()

Returns:

true if the WebSocket is connected, false otherwise.

send

public abstract void send(@Nonnull
                          java.lang.String data)
                   throws java.lang.IllegalStateException

Send some string data across the WebSocket.

Parameters:

data - the data to send.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

send

public abstract void send(@Nonnull
                          ArrayBuffer data)
                   throws java.lang.IllegalStateException

Send some ArrayBuffer data across the WebSocket.

Parameters:

data - the data to send.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

send

public abstract void send(@Nonnull
                          ArrayBufferView data)
                   throws java.lang.IllegalStateException

Send some ArrayBufferView data across the WebSocket.

Parameters:

data - the data to send.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

getBufferedAmount

public abstract int getBufferedAmount()
                               throws java.lang.IllegalStateException

Return the amount buffered on underlying WebSocket.

Returns:

the amount buffered on underlying WebSocket.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

getProtocol

public abstract java.lang.String getProtocol()
                                      throws java.lang.IllegalStateException

Return the protocol used by the underlying WebSocket.

Returns:

the protocol used by the underlying WebSocket.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

getURL

public abstract java.lang.String getURL()
                                 throws java.lang.IllegalStateException

Return the url that the underlying WebSOcket is connected to.

Returns:

the url that the underlying WebSOcket is connected to.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

getExtensions

public abstract java.lang.String getExtensions()
                                        throws java.lang.IllegalStateException

Return the extensions that the underlying WebSocket is connected using.

Returns:

the extensions that the underlying WebSocket is connected using.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

getReadyState

public abstract WebSocket.ReadyState getReadyState()

Return the state of the WebSocket.

Returns:

the state of the WebSocket.

setBinaryType

public abstract void setBinaryType(@Nonnull
                                   WebSocket.BinaryType binaryType)
                            throws java.lang.IllegalStateException

Set the type of the binary messages that the WebSocket will receive. Note: At this stage only ARRAYBUFFER is supported.

Parameters:

binaryType - the type of the binary messages that the WebSocket will receive.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

getBinaryType

public abstract WebSocket.BinaryType getBinaryType()
                                            throws java.lang.IllegalStateException

Return the type of the binary messages that the WebSocket will receive.

Returns:

the type of the binary messages that the WebSocket will receive.

Throws:

java.lang.IllegalStateException - if the WebSocket is not open.

getListener

@Nonnull
public final WebSocketListener getListener()

Return the listener associated with the WebSocket.

Returns:

the listener associated with the WebSocket.

setListener

public final void setListener(@Nullable
                              WebSocketListener listener)

Set the listener to receive messages from the WebSocket.

Parameters:

listener - the listener to receive messages from the WebSocket.

onOpen

protected final void onOpen()

Fire a Connected event.

onClose

protected final void onClose(boolean wasClean,
                             int code,
                             @Nullable
                             java.lang.String reason)

Fire a Close event.

onMessage

protected final void onMessage(java.lang.String data)

Fire a Message event.

onMessage

protected final void onMessage(ArrayBuffer data)

Fire a Message event.

onError

protected final void onError()

Fire an Error event.