com.symphony.bdk.core.service.datafeed.impl

Class DatafeedLoopV2

java.lang.Object

com.symphony.bdk.core.service.datafeed.impl.DatafeedLoopV2

All Implemented Interfaces:

DatafeedLoop

@API(status=INTERNAL)
public class DatafeedLoopV2
extends java.lang.Object

A class for implementing the datafeed v2 loop service.

This service will be started by calling start()

At the beginning, the BDK bot will try to retrieve the list of datafeed to which it is listening. Since each bot should only listening to just one datafeed, the first datafeed in the list will be used by the bot to be listened to. If the retrieved list is empty, the BDK bot will create a new datafeed to listen.

The BDK bot will listen to this datafeed to get all the received real-time events.

If this datafeed becomes stale or faulty, the BDK bot will create the new one for listening.

This service will be stopped by calling stop()

If the datafeed service is stopped during a read datafeed call, it has to wait until the last read finish to be really stopped

Field Summary

Fields

Modifier and Type	Field and Description
protected com.symphony.bdk.http.api.ApiClient	apiClient
protected AuthSession	authSession
protected BdkConfig	bdkConfig
protected DatafeedApi	datafeedApi
protected RetryWithRecoveryBuilder	retryWithRecoveryBuilder

Constructor Summary

Constructors

Constructor and Description
DatafeedLoopV2(DatafeedApi datafeedApi, AuthSession authSession, BdkConfig config, UserV2 botInfo)

Method Summary

Modifier and Type	Method and Description
protected AckId	getAckId()
protected void	handleV4EventList(java.util.List<V4Event> events) Handle a received listener by using the subscribed RealTimeEventListener.
protected void	refresh()
void	start() Start the datafeed events service
void	stop() Stop the datafeed events service.
void	subscribe(RealTimeEventListener listener) The bot subscribes to a RealTimeEventListener
void	unsubscribe(RealTimeEventListener listener) The bot unsubscribes to a RealTimeEventListener

Methods inherited from class java.lang.Object

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

Field Detail

authSession

protected final AuthSession authSession

bdkConfig

protected final BdkConfig bdkConfig

retryWithRecoveryBuilder

protected final RetryWithRecoveryBuilder retryWithRecoveryBuilder

datafeedApi

protected DatafeedApi datafeedApi

apiClient

protected com.symphony.bdk.http.api.ApiClient apiClient

Constructor Detail

DatafeedLoopV2

public DatafeedLoopV2(DatafeedApi datafeedApi,
                      AuthSession authSession,
                      BdkConfig config,
                      UserV2 botInfo)

Method Detail

start

public void start()
           throws com.symphony.bdk.http.api.ApiException,
                  AuthUnauthorizedException

Start the datafeed events service

Throws:

com.symphony.bdk.http.api.ApiException

AuthUnauthorizedException

getAckId

protected AckId getAckId()

stop

public void stop()

Stop the datafeed events service. The datafeed service will be stopped after a small delay to finish the last read datafeed call.

subscribe

public void subscribe(RealTimeEventListener listener)

The bot subscribes to a RealTimeEventListener

Specified by:

subscribe in interface DatafeedLoop

Parameters:

listener - a Datafeed event listener to be subscribed

unsubscribe

public void unsubscribe(RealTimeEventListener listener)

The bot unsubscribes to a RealTimeEventListener

Specified by:

unsubscribe in interface DatafeedLoop

Parameters:

listener - a Datafeed event listener to be unsubscribed

handleV4EventList

protected void handleV4EventList(java.util.List<V4Event> events)

Handle a received listener by using the subscribed RealTimeEventListener.

Parameters:

events - List of Datafeed events to be handled

refresh

protected void refresh()
                throws AuthUnauthorizedException

Throws:

AuthUnauthorizedException