nn::boss::Task Class

Syntax

class Task

Description

Class for representing tasks. Use this to do such things as register or unregister a task, or for task operations.

Member Functions

Task Constructor.
V ~Task Destructor.
Initialize Initializes the registered task with the specified task ID. This initialization makes it possible to reuse objects.
UpdateInterval Updates the execution interval for a task after registration. This can be changed even after a task has been instructed to start executing.
UpdateIntervalWithSec Updates the execution interval for a task after registration. The units are seconds. This can be changed even after a task has been instructed to start executing.
UpdateCount Updates the execution count for a task after registration. This can be changed even after a task has been instructed to start executing.
GetInterval Gets the execution interval. The units are hours. This can be changed even after a task has been instructed to start executing.
GetIntervalSec Gets the execution interval. The units are seconds.
GetCount Gets the execution count.
GetServiceStatus Gets the service status of a task.
Start Starts a task.
StartImmediate Starts a task immediately. This can only be called after infrastructure connections are enabled.
Cancel Cancels a running task.
WaitFinish Waits for a task to finish within the specified time. This is the same as WaitFinish except that it also has a timeout feature.
GetState Gets the task state.
GetHttpStatusCode Gets the communication error code.
GetCommErrorCode This is the old (deprecated) name for nn::boss::GetHttpStatusCode. Avoid using this: it only exists for compatibility.
GetResult Gets the task result code.
GetStateDetail Gets the task status.
GetStatus This is the old (deprecated) name for nn::boss::GetStateDetail. Avoid using this: it only exists for compatibility.
GetError Gets the task error state.
GetInfo Gets information about a registered task.
GetTaskId Gets the task ID.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL