com.hannesdorfmann.httpkit.threading

Class PriorityThreadPoolHttpExecutor

java.lang.Object

com.hannesdorfmann.httpkit.threading.PriorityThreadPoolHttpExecutor

All Implemented Interfaces:

HttpExecutor, HttpTask.HttpTaskCanceledListener, HttpTask.HttpTaskFinishedListener, HttpTask.HttpTaskPriorityChangedListener, HttpTask.HttpTaskStartedListner

public class PriorityThreadPoolHttpExecutor
extends Object
implements HttpExecutor, HttpTask.HttpTaskStartedListner, HttpTask.HttpTaskFinishedListener, HttpTask.HttpTaskCanceledListener, HttpTask.HttpTaskPriorityChangedListener

This HttpExecutor executes the HttpTask, that contain a HttpRequest, with an ThreadPoolExecutor and uses a PriorityBlockingQueue as queue for tasks. That means, that tasks were executed according the Comparable natural order (the least task is the head of the queue). The HttpRequest.getPriority() is used for the priority queue. If two tasks have the same priority the creation timestamp of an HttpRequest gets considered as the next criterion for ordering.

Author:

Hannes Dorfmann

Constructor Summary

Constructors

Constructor and Description
PriorityThreadPoolHttpExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelAllOfOwner(Object owner) Cancel all HttpRequests of this owner
void	onHttpTaskCanceled(HttpTask<?> task) Called when an HttpRequest has been canceled, so the corresponding HttpTask gets canceled too.
void	onHttpTaskFailed(HttpTask<?> httpTask, Exception exception) Called to inform, that a {@link HttpClientTasHttpClientTaskete, because an error (exception) has been thrown
void	onHttpTaskPriorityChanged(HttpTask<?> task, int newPriority) Called when the HttpRequest has changed his priority, so the HttpTask depends on the HttpRequest priority
void	onHttpTaskStarted(HttpTask<?> task) This method gets called when an HttpTask has started right now
void	onHttpTaskSuccessful(HttpTask<?> httpTask, HttpResponse response) Called to inform, that a HttpClientTask has finished successfully
boolean	submitTask(HttpTask<?> task) Add a task to the HttpExecutor.

Methods inherited from class java.lang.Object

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

Constructor Detail

PriorityThreadPoolHttpExecutor

public PriorityThreadPoolHttpExecutor()

Method Detail

submitTask

public boolean submitTask(HttpTask<?> task)

Description copied from interface: HttpExecutor

Add a task to the HttpExecutor. The scheduler will then execute this task. The time when the task gets executed depends on the concrete HttpExecutor implementation

Specified by:

submitTask in interface HttpExecutor

Returns:

onHttpTaskSuccessful

public void onHttpTaskSuccessful(HttpTask<?> httpTask,
                        HttpResponse response)

Description copied from interface: HttpTask.HttpTaskFinishedListener

Called to inform, that a HttpClientTask has finished successfully

Specified by:

onHttpTaskSuccessful in interface HttpTask.HttpTaskFinishedListener

Parameters:

httpTask - The HttpClientTaHttpClientTasksponse {@link HttpResponse}

onHttpTaskFailed

public void onHttpTaskFailed(HttpTask<?> httpTask,
                    Exception exception)

Description copied from interface: HttpTask.HttpTaskFinishedListener

Called to inform, that a {@link HttpClientTasHttpClientTaskete, because an error (exception) has been thrown

Specified by:

onHttpTaskFailed in interface HttpTask.HttpTaskFinishedListener

Parameters:

httpTask - HttpClientTaskk HttpClientTask}

exception - The Exception that has caused the failure

onHttpTaskStarted

public void onHttpTaskStarted(HttpTask<?> task)

Description copied from interface: HttpTask.HttpTaskStartedListner

This method gets called when an HttpTask has started right now

Specified by:

onHttpTaskStarted in interface HttpTask.HttpTaskStartedListner

Parameters:

task - The HttpTask that has started right now

onHttpTaskPriorityChanged

public void onHttpTaskPriorityChanged(HttpTask<?> task,
                             int newPriority)

Description copied from interface: HttpTask.HttpTaskPriorityChangedListener

Called when the HttpRequest has changed his priority, so the HttpTask depends on the HttpRequest priority

Specified by:

onHttpTaskPriorityChanged in interface HttpTask.HttpTaskPriorityChangedListener

Parameters:

task - The HttpTask

newPriority - The new priority

onHttpTaskCanceled

public void onHttpTaskCanceled(HttpTask<?> task)

Description copied from interface: HttpTask.HttpTaskCanceledListener

Called when an HttpRequest has been canceled, so the corresponding HttpTask gets canceled too.

Specified by:

onHttpTaskCanceled in interface HttpTask.HttpTaskCanceledListener

cancelAllOfOwner

public void cancelAllOfOwner(Object owner)

Description copied from interface: HttpExecutor

Cancel all HttpRequests of this owner

Specified by:

cancelAllOfOwner in interface HttpExecutor