Package co.arago.hiro.client.websocket

Class EventWebSocket

java.lang.Object

co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

co.arago.hiro.client.websocket.EventWebSocket

All Implemented Interfaces:

java.lang.AutoCloseable

public class EventWebSocket
extends AuthenticatedWebSocketHandler

The handler for Event WebSocket.

See Also:

API Documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventWebSocket.Builder
static class	EventWebSocket.Conf<T extends EventWebSocket.Conf<T>>
protected class	EventWebSocket.InternalEventListener	Listener class for Event WebSockets.

Nested classes/interfaces inherited from class co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

AuthenticatedWebSocketHandler.InternalListener, AuthenticatedWebSocketHandler.Status

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	API_NAME

Fields inherited from class co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

apiName, endpoint, fragment, headers, internalListener, maxRetries, name, protocol, query, reconnectOnFailedSend, status, tokenAPIHandler, webSocketRequestTimeout

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventWebSocket(EventWebSocket.Conf<?> builder)	Protected Constructor.

Method Summary

Modifier and Type	Method	Description
void	addEventsFilter(EventsFilter filter)
void	clearEventsFilter()
void	close()
static EventWebSocket.Conf<?>	newBuilder(TokenAPIHandler tokenAPIHandler, EventWebSocketListener eventWebSocketListener)	Get a EventWebSocket.Builder for EventWebSocket.
void	removeEventsFilter(java.lang.String filterId)
void	subscribeScope(java.lang.String scopeId)

Methods inherited from class co.arago.hiro.client.websocket.AuthenticatedWebSocketHandler

backoff, closeWebSocket, createWebSocket, restartWebSocket, send, start

Methods inherited from class java.lang.Object

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

Field Detail

API_NAME

public static final java.lang.String API_NAME

See Also:

Constant Field Values

Constructor Detail

EventWebSocket

protected EventWebSocket(EventWebSocket.Conf<?> builder)

Protected Constructor. Use newBuilder(TokenAPIHandler, EventWebSocketListener).

Parameters:

builder - The EventWebSocket.Builder to use.

Method Detail

newBuilder

public static EventWebSocket.Conf<?> newBuilder(TokenAPIHandler tokenAPIHandler,
                                                EventWebSocketListener eventWebSocketListener)

Get a EventWebSocket.Builder for EventWebSocket.

Parameters:

tokenAPIHandler - The API handler for this websocket.

eventWebSocketListener - The listener for this websocket.

Returns:

The EventWebSocket.Builder for EventWebSocket.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class AuthenticatedWebSocketHandler

addEventsFilter

public void addEventsFilter(EventsFilter filter)
                     throws HiroException,
                            java.io.IOException,
                            java.lang.InterruptedException

Throws:

HiroException

java.io.IOException

java.lang.InterruptedException

removeEventsFilter

public void removeEventsFilter(java.lang.String filterId)
                        throws HiroException,
                               java.io.IOException,
                               java.lang.InterruptedException

Throws:

HiroException

java.io.IOException

java.lang.InterruptedException

clearEventsFilter

public void clearEventsFilter()
                       throws HiroException,
                              java.io.IOException,
                              java.lang.InterruptedException

Throws:

HiroException

java.io.IOException

java.lang.InterruptedException

subscribeScope

public void subscribeScope(java.lang.String scopeId)
                    throws HiroException,
                           java.io.IOException,
                           java.lang.InterruptedException

Throws:

HiroException

java.io.IOException

java.lang.InterruptedException