com.inductiveautomation.ignition.gateway.tasks

Interface TaskContext

public interface TaskContext

Created by colby.clegg on 5/6/2015.

Method Summary

Modifier and Type	Method and Description
GatewayContext	getGatewayContext()
void	reportStatusEvent(TaskStatusEvent event) This allows the task to report a "historical" status event that will be displayed on the task status page.
void	resumeTask() This function is used to resume tasks that have yielded execution, from inside the task.
void	updateCompletionPercent(double pct)
void	updateStatusMessage(java.lang.String message)
void	yieldExecution() Call this function to mark the task for continuation at a later point.

Method Detail

updateStatusMessage

void updateStatusMessage(java.lang.String message)

updateCompletionPercent

void updateCompletionPercent(double pct)

getGatewayContext

GatewayContext getGatewayContext()

resumeTask

void resumeTask()

This function is used to resume tasks that have yielded execution, from inside the task. This call will return quickly- and no more work should be done after calling it. Instead, as soon as possible, run() will be called on the task, and it can resume from where it was.

yieldExecution

void yieldExecution()

Call this function to mark the task for continuation at a later point. The task will be resumed when the resumeTask() function is called.

reportStatusEvent

void reportStatusEvent(TaskStatusEvent event)

This allows the task to report a "historical" status event that will be displayed on the task status page.