Package com.iland.core.web.sdk.connection

Class WebSocketClient

java.lang.Object

com.iland.core.web.sdk.connection.WebSocketClient

public class WebSocketClient
extends Object

Web Socket Client.

Author:

Nick Kasprzak

Constructor Summary

Constructors

Constructor	Description
WebSocketClient(String companyId, OAuthConnection connection)

Method Summary

Modifier and Type	Method	Description
SocketSubscription	consumeEvents(Consumer<EventResponse> consumer)	Assign a event consumer to a web socket and get back a socket subscription.
SocketSubscription	consumeEvents(Consumer<EventResponse> consumer, EventFilter eventFilter)	Assign a event consumer to a web socket with custom filtering for events and get back a socket subscription.
SocketSubscription	consumeEvents(Consumer<EventResponse> consumer, Set<EventTypeResponse> eventTypes)	Assign a event consumer to a web socket with filtering for event types and get back a socket subscription.
SocketSubscription	consumeTasks(Consumer<com.iland.core.web.rest.response.task.TaskResponse> consumer)	Assign a task consumer to a web socket and get back a socket subscription.
SocketSubscription	consumeTasks(Consumer<com.iland.core.web.rest.response.task.TaskResponse> consumer, TaskFilter taskFilter)	Assign a task consumer to a web socket with custom filtering for tasks and get back a socket subscription

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocketClient

public WebSocketClient(String companyId,
 OAuthConnection connection)

Method Details

consumeEvents

public SocketSubscription consumeEvents(Consumer<EventResponse> consumer)

Assign a event consumer to a web socket and get back a socket subscription.

Parameters:

consumer - Consumer of EventResponse callback function

Returns:

SocketSubscription socket subscription

consumeEvents

public SocketSubscription consumeEvents(Consumer<EventResponse> consumer,
 Set<EventTypeResponse> eventTypes)

Assign a event consumer to a web socket with filtering for event types and get back a socket subscription.

Parameters:

consumer - Consumer of EventResponse callback function

eventTypes - Set of EventTypeResponse event type

Returns:

SocketSubscription socket subscription

consumeEvents

public SocketSubscription consumeEvents(Consumer<EventResponse> consumer,
 EventFilter eventFilter)

Assign a event consumer to a web socket with custom filtering for events and get back a socket subscription.

Parameters:

consumer - Consumer of EventResponse callback function

eventFilter - EventFilter event filter

Returns:

WebSocketClient socket subscription

consumeTasks

public SocketSubscription consumeTasks(Consumer<com.iland.core.web.rest.response.task.TaskResponse> consumer)

Assign a task consumer to a web socket and get back a socket subscription.

Parameters:

consumer - Consumer of TaskResponse callback function

Returns:

SocketSubscription socket subscription

consumeTasks

public SocketSubscription consumeTasks(Consumer<com.iland.core.web.rest.response.task.TaskResponse> consumer,
 TaskFilter taskFilter)

Assign a task consumer to a web socket with custom filtering for tasks and get back a socket subscription

Parameters:

consumer - Consumer of TaskResponse callback function

taskFilter - Optional of TaskFilter task filter

Returns:

SocketSubscription socket subscription