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

Class DatafeedLoopV2

java.lang.Object

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

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

All Implemented Interfaces:

DatafeedLoop

@API(status=INTERNAL)
public class DatafeedLoopV2
extends AbstractAckIdEventLoop

A class for implementing the datafeed v2 loop service.

This service will be started by calling DatafeedLoop.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 DatafeedLoop.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	Description
protected final AuthSession	authSession
protected final com.symphony.bdk.core.config.model.BdkConfig	bdkConfig
protected final UserV2	botInfo
protected DatafeedApi	datafeedApi
protected final AtomicBoolean	started

Fields inherited from class com.symphony.bdk.core.service.datafeed.impl.AbstractAckIdEventLoop

ackId, INITIAL_ACK_ID

Constructor Summary

Constructors

Constructor	Description
DatafeedLoopV2(DatafeedApi datafeedApi, AuthSession authSession, com.symphony.bdk.core.config.model.BdkConfig config, UserV2 botInfo)

Method Summary

Modifier and Type	Method	Description
protected void	handleV4EventList(List<V4Event> events)	Handle a received listener by using the subscribed RealTimeEventListener.
long	lastPullTimestamp()	The timestamp of the last successful pulling
protected V5EventList	readEvents()
protected void	refresh()
protected void	runLoop()
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 com.symphony.bdk.core.service.datafeed.impl.AbstractAckIdEventLoop

readAndHandleEvents

Methods inherited from class java.lang.Object

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

Field Details

authSession

protected final AuthSession authSession

bdkConfig

protected final com.symphony.bdk.core.config.model.BdkConfig bdkConfig

botInfo

protected final UserV2 botInfo

started

protected final AtomicBoolean started

datafeedApi

protected DatafeedApi datafeedApi

Constructor Details

DatafeedLoopV2

public DatafeedLoopV2(DatafeedApi datafeedApi,
 AuthSession authSession,
 com.symphony.bdk.core.config.model.BdkConfig config,
 UserV2 botInfo)

Method Details

runLoop

protected void runLoop()
                throws Throwable

Throws:

Throwable

readEvents

protected V5EventList readEvents()
                          throws com.symphony.bdk.http.api.ApiException

Specified by:

readEvents in class AbstractAckIdEventLoop

Throws:

com.symphony.bdk.http.api.ApiException

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

start

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

Start the datafeed events service

Specified by:

start in interface DatafeedLoop

Throws:

AuthUnauthorizedException

com.symphony.bdk.http.api.ApiException

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.

Specified by:

stop in interface DatafeedLoop

handleV4EventList

protected void handleV4EventList(@Nullable
 List<V4Event> events)
                          throws RequeueEventException

Handle a received listener by using the subscribed RealTimeEventListener.

Parameters:

events - List of Datafeed events to be handled

Throws:

RequeueEventException - Raised if a listener fails and the developer wants to explicitly not update the ack id.

refresh

protected void refresh()
                throws AuthUnauthorizedException

Throws:

AuthUnauthorizedException

lastPullTimestamp

public long lastPullTimestamp()

The timestamp of the last successful pulling

Specified by:

lastPullTimestamp in interface DatafeedLoop

Returns:

timestamp value in long