1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" /> 7 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::boss::Task</title> 51 </head> 52 <body> 53<h1><CODE>nn::boss::Task</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class Task</pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Class for representing tasks. Use this to do such things as register or unregister a task, or for task operations.</p><!-- write here --></div> 61 <a name="function" id="function"> 62<h2>Member Functions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> </td> 67 <th> 68<a href="../../../nn/boss/Task/Task.html"><CODE>Task</CODE></a> 69 </th> 70<td>Constructor.</td> 71 </tr> 72 <tr> 73<td width="100"> <span class="virtual_style" title="virtual">V</span> 74 </td> 75 <th> 76<a href="../../../nn/boss/Task/~Task.html"><CODE>~Task</CODE></a> 77 </th> 78<td>Destructor.</td> 79 </tr> 80 <tr> 81 <td width="100"> </td> 82 <th> 83<a href="../../../nn/boss/Task/Initialize.html"><CODE>Initialize</CODE></a> 84 </th> 85<td>Initializes the registered task with the specified task ID. This initialization makes it possible to reuse objects.</td> 86 </tr> 87 <tr> 88 <td width="100"> </td> 89 <th> 90<a href="../../../nn/boss/Task/UpdateInterval.html"><CODE>UpdateInterval</CODE></a> 91 </th> 92<td>Updates the execution interval for a task after registration. This can be changed even after a task has been instructed to start executing.</td> 93 </tr> 94 <tr> 95 <td width="100"> </td> 96 <th> 97<a href="../../../nn/boss/Task/UpdateIntervalWithSec.html"><CODE>UpdateIntervalWithSec</CODE></a> 98 </th> 99<td>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.</td> 100 </tr> 101 <tr> 102 <td width="100"> </td> 103 <th> 104<a href="../../../nn/boss/Task/UpdateCount.html"><CODE>UpdateCount</CODE></a> 105 </th> 106<td>Updates the execution count for a task after registration. This can be changed even after a task has been instructed to start executing.</td> 107 </tr> 108 <tr> 109 <td width="100"> </td> 110 <th> 111<a href="../../../nn/boss/Task/GetInterval.html"><CODE>GetInterval</CODE></a> 112 </th> 113<td>Gets the execution interval. The units are hours. This can be changed even after a task has been instructed to start executing.</td> 114 </tr> 115 <tr> 116 <td width="100"> </td> 117 <th> 118<a href="../../../nn/boss/Task/GetIntervalSec.html"><CODE>GetIntervalSec</CODE></a> 119 </th> 120<td>Gets the execution interval. The units are seconds.</td> 121 </tr> 122 <tr> 123 <td width="100"> </td> 124 <th> 125<a href="../../../nn/boss/Task/GetCount.html"><CODE>GetCount</CODE></a> 126 </th> 127<td>Gets the execution count.</td> 128 </tr> 129 <tr> 130 <td width="100"> </td> 131 <th> 132<a href="../../../nn/boss/Task/GetServiceStatus.html"><CODE>GetServiceStatus</CODE></a> 133 </th> 134<td>Gets the service status of a task.</td> 135 </tr> 136 <tr> 137 <td width="100"> </td> 138 <th> 139<a href="../../../nn/boss/Task/Start.html"><CODE>Start</CODE></a> 140 </th> 141<td>Starts a task.</td> 142 </tr> 143 <tr> 144 <td width="100"> </td> 145 <th> 146<a href="../../../nn/boss/Task/StartImmediate.html"><CODE>StartImmediate</CODE></a> 147 </th> 148<td>Starts a task immediately. This can only be called after infrastructure connections are enabled.</td> 149 </tr> 150 <tr> 151 <td width="100"> </td> 152 <th> 153<a href="../../../nn/boss/Task/Cancel.html"><CODE>Cancel</CODE></a> 154 </th> 155<td>Cancels a running task.</td> 156 </tr> 157 <tr> 158 <td width="100"> </td> 159 <th> 160<a href="../../../nn/boss/Task/WaitFinish.html"><CODE>WaitFinish</CODE></a> 161 </th> 162<td>Waits for a task to finish within the specified time. This is the same as <a href="../../../nn/boss/Task/WaitFinish.html"><CODE>WaitFinish</CODE></a> except that it also has a timeout feature.</td> 163 </tr> 164 <tr> 165 <td width="100"> </td> 166 <th> 167<a href="../../../nn/boss/Task/GetState.html"><CODE>GetState</CODE></a> 168 </th> 169<td>Gets the task state.</td> 170 </tr> 171 <tr> 172 <td width="100"> </td> 173 <th> 174<a href="../../../nn/boss/Task/GetHttpStatusCode.html"><CODE>GetHttpStatusCode</CODE></a> 175 </th> 176<td>Gets the communication error code.</td> 177 </tr> 178 <tr> 179 <td width="100"> </td> 180 <th> 181<a href="../../../nn/boss/Task/GetCommErrorCode.html"><CODE>GetCommErrorCode</CODE></a> 182 </th> 183<td>This is the old (deprecated) name for <CODE>nn::boss::GetHttpStatusCode</CODE>. Avoid using this: it only exists for compatibility.</td> 184 </tr> 185 <tr> 186 <td width="100"> </td> 187 <th> 188<a href="../../../nn/boss/Task/GetResult.html"><CODE>GetResult</CODE></a> 189 </th> 190<td>Gets the task result code.</td> 191 </tr> 192 <tr> 193 <td width="100"> </td> 194 <th> 195<a href="../../../nn/boss/Task/GetStateDetail.html"><CODE>GetStateDetail</CODE></a> 196 </th> 197<td>Gets the task status.</td> 198 </tr> 199 <tr> 200 <td width="100"> </td> 201 <th> 202<a href="../../../nn/boss/Task/GetStatus.html"><CODE>GetStatus</CODE></a> 203 </th> 204<td>This is the old (deprecated) name for <CODE>nn::boss::GetStateDetail</CODE>. Avoid using this: it only exists for compatibility.</td> 205 </tr> 206 <tr> 207 <td width="100"> </td> 208 <th> 209<a href="../../../nn/boss/Task/GetError.html"><CODE>GetError</CODE></a> 210 </th> 211<td>Gets the task error state.</td> 212 </tr> 213 <tr> 214 <td width="100"> </td> 215 <th> 216<a href="../../../nn/boss/Task/GetInfo.html"><CODE>GetInfo</CODE></a> 217 </th> 218<td>Gets information about a registered task.</td> 219 </tr> 220 <tr> 221 <td width="100"> </td> 222 <th> 223<a href="../../../nn/boss/Task/GetTaskId.html"><CODE>GetTaskId</CODE></a> 224 </th> 225<td>Gets the task ID.</td> 226 </tr> </table> 227 </div> 228 </a> 229<h2>Revision History</h2> 230 <div class="section"> 231 <dl class="history"> 232 <dt>2010/09/16</dt> 233<dd>Initial version.<br /> 234 </dd> 235 </dl> 236 </div> 237 <hr><p>CONFIDENTIAL</p></body> 238</html>