com.amazonaws.mobileconnectors.geo.tracker

Class TrackingPublisher

java.lang.Object

com.amazonaws.mobileconnectors.geo.tracker.TrackingPublisher

public class TrackingPublisher
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TrackingPublisher(AmazonLocationClient locationClient, java.lang.String deviceId, java.lang.String trackerName)
TrackingPublisher(AmazonLocationClient locationClient, java.lang.String deviceId, java.lang.String trackerName, int workerPoolSize, long publishIntervalMillis, int batchSize, TrackingListener listener)
TrackingPublisher(AmazonLocationClient locationClient, java.lang.String deviceId, java.lang.String trackerName, java.util.concurrent.ScheduledExecutorService scheduledExecutorService, long publishIntervalMillis, int batchSize, TrackingListener listener)

Method Summary

Modifier and Type	Method and Description
void	enqueue(android.location.Location location) Adds a location to the location queue.
void	forceFlush() Force pending locations in the location queue to be batched and sent to the location service.
int	pendingBatches() Checks the number of batches waiting to be sent to the location service.
int	pendingPositionUpdates() Checks the number of position updates waiting to be batched.
void	shutdown() Stops the publisher from publishing.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackingPublisher

public TrackingPublisher(AmazonLocationClient locationClient,
                         java.lang.String deviceId,
                         java.lang.String trackerName)

TrackingPublisher

public TrackingPublisher(AmazonLocationClient locationClient,
                         java.lang.String deviceId,
                         java.lang.String trackerName,
                         int workerPoolSize,
                         long publishIntervalMillis,
                         int batchSize,
                         TrackingListener listener)

TrackingPublisher

public TrackingPublisher(AmazonLocationClient locationClient,
                         java.lang.String deviceId,
                         java.lang.String trackerName,
                         java.util.concurrent.ScheduledExecutorService scheduledExecutorService,
                         long publishIntervalMillis,
                         int batchSize,
                         TrackingListener listener)

Method Detail

enqueue

public void enqueue(android.location.Location location)

Adds a location to the location queue. If the location causes the batch size to be exceeded, this will trigger the locations to be flushed from the location queue into a batch request which will eventually be sent to the location service.

Parameters:

location - - Location reported by the Android OS.

shutdown

public void shutdown()

Stops the publisher from publishing. Should be used when terminating the object.

pendingPositionUpdates

public int pendingPositionUpdates()

Checks the number of position updates waiting to be batched.

Returns:

Number of position updates in the position queue.

pendingBatches

public int pendingBatches()

Checks the number of batches waiting to be sent to the location service.

Returns:

Number of pending batches.

forceFlush

public void forceFlush()

Force pending locations in the location queue to be batched and sent to the location service. This method should only be invoked in the event that a final flush of locations needs to be performed (During a shutdown for example)