com.box.androidsdk.content.utils

Class RealTimeServerConnection

java.lang.Object

com.box.androidsdk.content.utils.RealTimeServerConnection

All Implemented Interfaces:

BoxFutureTask.OnCompletedListener<BoxSimpleMessage>

public class RealTimeServerConnection
extends java.lang.Object
implements BoxFutureTask.OnCompletedListener<BoxSimpleMessage>

This class is used to monitor a long polling server connection, specifically the one used to check that a change has been made to a user's account.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RealTimeServerConnection.OnChangeListener An interface used to handle new events from the real time server connection.

Constructor Summary

Constructors

Constructor and Description
RealTimeServerConnection(BoxRequest getRealTimeServerRequest, RealTimeServerConnection.OnChangeListener changeListener, BoxSession session) Constructions a RealTimeServerConnection which will detect when the RealTimeServer indicates when a change has occurred.

Method Summary

Modifier and Type	Method and Description
BoxSimpleMessage	connect() Returns a message once a change has been detected or error occurs.
BoxRealTimeServer	getRealTimeServer()
BoxRequest	getRequest()
int	getTimesRetried()
protected void	handleResponse(BoxResponse<BoxSimpleMessage> response)
void	onCompleted(BoxResponse<BoxSimpleMessage> response)
java.util.concurrent.FutureTask<BoxSimpleMessage>	toTask()

Methods inherited from class java.lang.Object

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

Constructor Detail

RealTimeServerConnection

public RealTimeServerConnection(BoxRequest getRealTimeServerRequest,
                                RealTimeServerConnection.OnChangeListener changeListener,
                                BoxSession session)

Constructions a RealTimeServerConnection which will detect when the RealTimeServer indicates when a change has occurred.

Parameters:

getRealTimeServerRequest - A request that will generate a BoxRealTimeServer list. Currently this is only EventRealTimeServerRequest.

changeListener - A listener that will be notified when a change or exception occurs.

session - A session object to use for required network calls.

Method Detail

getRequest

public BoxRequest getRequest()

Returns:

the original request used to construct this object.

getTimesRetried

public int getTimesRetried()

Returns:

the number of times this class has retried connecting to the server.

getRealTimeServer

public BoxRealTimeServer getRealTimeServer()

Returns:

the information for the real time server this class is trying to connect to.

toTask

public java.util.concurrent.FutureTask<BoxSimpleMessage> toTask()

Returns:

create a future task which can be used to monitor the real time connection asynchronously.

connect

public BoxSimpleMessage connect()

Returns a message once a change has been detected or error occurs. Otherwise this method will continue reconnecting.

Returns:

A BoxSimpleMessage with a simple message indicating a change in the user's account.

handleResponse

protected void handleResponse(BoxResponse<BoxSimpleMessage> response)

Parameters:

response - BoxSimpleMessage response coming from doing a get call to a RealTimeServer.

onCompleted

public void onCompleted(BoxResponse<BoxSimpleMessage> response)

Specified by:

onCompleted in interface BoxFutureTask.OnCompletedListener<BoxSimpleMessage>

Parameters:

response - called with a response from the server connection call.