org.realityforge.gwt.websockets.client.event

Class EventBasedWebSocketListener

java.lang.Object

org.realityforge.gwt.websockets.client.event.EventBasedWebSocketListener

All Implemented Interfaces:

WebSocketListener

public class EventBasedWebSocketListener
extends java.lang.Object
implements WebSocketListener

An event based web socket listener.

Constructor Summary

Constructors

Constructor and Description
EventBasedWebSocketListener() Construct the listener using a SimpleEventBus.
EventBasedWebSocketListener(EventBus eventBus) Construct the listener using specified EventBus.

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addCloseHandler(CloseEvent.Handler handler) Add listener for close events.
HandlerRegistration	addErrorHandler(ErrorEvent.Handler handler) Add listener for error events.
HandlerRegistration	addMessageHandler(MessageEvent.Handler handler) Add listener for message events.
HandlerRegistration	addOpenHandler(OpenEvent.Handler handler) Add listener for open events.
void	onClose(WebSocket webSocket, boolean wasClean, int code, java.lang.String reason) Fire a Close event.
void	onError(WebSocket webSocket) Fire an Error event.
void	onMessage(WebSocket webSocket, ArrayBuffer data) Fire a Message event.
void	onMessage(WebSocket webSocket, java.lang.String data) Fire a Message event.
void	onOpen(WebSocket webSocket) Fire a Connected event.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBasedWebSocketListener

public EventBasedWebSocketListener()

Construct the listener using a SimpleEventBus.

EventBasedWebSocketListener

public EventBasedWebSocketListener(@Nonnull
                                   EventBus eventBus)

Construct the listener using specified EventBus.

Parameters:

eventBus - the event bus.

Method Detail

addOpenHandler

@Nonnull
public final HandlerRegistration addOpenHandler(@Nonnull
                                                         OpenEvent.Handler handler)

Add listener for open events.

Parameters:

handler - the event handler.

Returns:

the HandlerRegistration that manages the listener.

addCloseHandler

@Nonnull
public final HandlerRegistration addCloseHandler(@Nonnull
                                                          CloseEvent.Handler handler)

Add listener for close events.

Parameters:

handler - the event handler.

Returns:

the HandlerRegistration that manages the listener.

addMessageHandler

@Nonnull
public final HandlerRegistration addMessageHandler(@Nonnull
                                                            MessageEvent.Handler handler)

Add listener for message events.

Parameters:

handler - the event handler.

Returns:

the HandlerRegistration that manages the listener.

addErrorHandler

@Nonnull
public final HandlerRegistration addErrorHandler(@Nonnull
                                                          ErrorEvent.Handler handler)

Add listener for error events.

Parameters:

handler - the event handler.

Returns:

the HandlerRegistration that manages the listener.

onOpen

public final void onOpen(@Nonnull
                         WebSocket webSocket)

Fire a Connected event.

Specified by:

onOpen in interface WebSocketListener

onClose

public final void onClose(@Nonnull
                          WebSocket webSocket,
                          boolean wasClean,
                          int code,
                          @Nullable
                          java.lang.String reason)

Fire a Close event.

Specified by:

onClose in interface WebSocketListener

onMessage

public final void onMessage(@Nonnull
                            WebSocket webSocket,
                            @Nonnull
                            java.lang.String data)

Fire a Message event.

Specified by:

onMessage in interface WebSocketListener

onMessage

public final void onMessage(@Nonnull
                            WebSocket webSocket,
                            @Nonnull
                            ArrayBuffer data)

Fire a Message event.

Specified by:

onMessage in interface WebSocketListener

onError

public final void onError(@Nonnull
                          WebSocket webSocket)

Fire an Error event.

Specified by:

onError in interface WebSocketListener