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

Class AbstractAckIdEventLoop

java.lang.Object

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

All Implemented Interfaces:

DatafeedLoop

Direct Known Subclasses:

DatafeedLoopV2, DatahoseLoopImpl

@API(status=INTERNAL)
public abstract class AbstractAckIdEventLoop
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected String	ackId
protected final AuthSession	authSession
protected final com.symphony.bdk.core.config.model.BdkConfig	bdkConfig
protected final UserV2	botInfo
protected DatafeedApi	datafeedApi
protected static final String	INITIAL_ACK_ID	Initial ack ID value when starting the loop
protected final AtomicBoolean	started

Constructor Summary

Constructors

Constructor	Description
AbstractAckIdEventLoop(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 Void	readAndHandleEvents()
protected abstract V5EventList	readEvents()
protected void	refresh()
protected abstract 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 java.lang.Object

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

Field Details

INITIAL_ACK_ID

protected static final String INITIAL_ACK_ID

Initial ack ID value when starting the loop

See Also:

• Constant Field Values

ackId

protected String ackId

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

AbstractAckIdEventLoop

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

Method Details

readAndHandleEvents

protected Void readAndHandleEvents()
                            throws com.symphony.bdk.http.api.ApiException

Throws:

com.symphony.bdk.http.api.ApiException

readEvents

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

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

runLoop

protected abstract void runLoop()
                         throws Throwable

Throws:

Throwable

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