com.liulishuo.filedownloader.util

Class FileDownloadSerialQueue

java.lang.Object

com.liulishuo.filedownloader.util.FileDownloadSerialQueue

public class FileDownloadSerialQueue
extends java.lang.Object

The serial queue, what used to dynamically increase tasks, and tasks in the queue will automatically start download one by one.

Constructor Summary

Constructors

Constructor and Description
FileDownloadSerialQueue()
FileDownloadSerialQueue(com.liulishuo.okdownload.DownloadSerialQueue serialQueue, com.liulishuo.okdownload.UnifiedListenerManager listenerManager)

Method Summary

Modifier and Type	Method and Description
void	enqueue(BaseDownloadTask task) Enqueues the given task sometime in the serial queue.
int	getWaitingTaskCount() Get the count of tasks which is waiting on this queue.
int	getWorkingTaskId() Returns the identify of the working task, if there is task is working, you will receive DownloadSerialQueue.ID_INVALID.
void	pause() Pause the queue.
void	resume() Resume the queue if the queue is paused.
java.util.List<BaseDownloadTask>	shutdown() Attempts to stop the working task, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDownloadSerialQueue

public FileDownloadSerialQueue()

FileDownloadSerialQueue

public FileDownloadSerialQueue(@NonNull
                               com.liulishuo.okdownload.DownloadSerialQueue serialQueue,
                               @NonNull
                               com.liulishuo.okdownload.UnifiedListenerManager listenerManager)

Method Detail

enqueue

public void enqueue(BaseDownloadTask task)

Enqueues the given task sometime in the serial queue. If the task is in the head of the serial queue, the task will be started automatically.

pause

public void pause()

Pause the queue.

See Also:

resume()

resume

public void resume()

Resume the queue if the queue is paused.

See Also:

pause()

getWorkingTaskId

public int getWorkingTaskId()

Returns the identify of the working task, if there is task is working, you will receive DownloadSerialQueue.ID_INVALID.

Returns:

the identify of the working task

getWaitingTaskCount

public int getWaitingTaskCount()

Get the count of tasks which is waiting on this queue.

Returns:

the count of waiting tasks on this queue.

shutdown

public java.util.List<BaseDownloadTask> shutdown()

Attempts to stop the working task, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution. These tasks are drained (removed) from the task queue upon return from this method.