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 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48<title>nn::boss::Task</title> 49 </head> 50 <body> 51<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/boss/Overview.html">boss</a>::Task</CODE> Class</h1> 52<h2>Syntax</h2> 53 <div class="section"> 54 <pre class="definition">class Task</pre> 55 </div> 56<h2>Description</h2> 57 <div class="section"> 58<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> 59 <a name="function" id="function"> 60<h2>Member Functions</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64 <td width="100"> </td> 65 <th> 66<a href="../../../nn/boss/Task/Task.html"><CODE>Task</CODE></a> 67 </th> 68<td>Constructor.</td> 69 </tr> 70 <tr> 71<td width="100"> <span class="virtual_style" title="virtual">V</span> 72 </td> 73 <th> 74<a href="../../../nn/boss/Task/~Task.html"><CODE>~Task</CODE></a> 75 </th> 76<td>Destructor.</td> 77 </tr> 78 <tr> 79 <td width="100"> </td> 80 <th> 81<a href="../../../nn/boss/Task/Initialize.html"><CODE>Initialize</CODE></a> 82 </th> 83<td>Initializes the registered task with the specified task ID. This initialization makes it possible to reuse objects.</td> 84 </tr> 85 <tr> 86 <td width="100"> </td> 87 <th> 88<a href="../../../nn/boss/Task/UpdateInterval.html"><CODE>UpdateInterval</CODE></a> 89 </th> 90<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> 91 </tr> 92 <tr> 93 <td width="100"> </td> 94 <th> 95<a href="../../../nn/boss/Task/UpdateIntervalWithSec.html"><CODE>UpdateIntervalWithSec</CODE></a> 96 </th> 97<td>[This is exclusively for debugging. Normal execution intervals are only approved if they are measured in hours. Use the <CODE><a href="../../../nn/boss/Task/UpdateInterval.html">UpdateInterval</a></CODE> function when you are not debugging. ] 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> 98 </tr> 99 <tr> 100 <td width="100"> </td> 101 <th> 102<a href="../../../nn/boss/Task/UpdateCount.html"><CODE>UpdateCount</CODE></a> 103 </th> 104<td>Updates the execution count for a task after task registration. This can be changed even after a task has been instructed to start executing.</td> 105 </tr> 106 <tr> 107 <td width="100"> </td> 108 <th> 109<a href="../../../nn/boss/Task/GetInterval.html"><CODE>GetInterval</CODE></a> 110 </th> 111<td>Gets the execution interval. The units are hours. This can be changed even after a task has been instructed to start executing.</td> 112 </tr> 113 <tr> 114 <td width="100"> </td> 115 <th> 116<a href="../../../nn/boss/Task/GetIntervalSec.html"><CODE>GetIntervalSec</CODE></a> 117 </th> 118<td>Gets the execution interval. The units are seconds.</td> 119 </tr> 120 <tr> 121 <td width="100"> </td> 122 <th> 123<a href="../../../nn/boss/Task/GetCount.html"><CODE>GetCount</CODE></a> 124 </th> 125<td>Gets the execution count for a task.</td> 126 </tr> 127 <tr> 128 <td width="100"> </td> 129 <th> 130<a href="../../../nn/boss/Task/GetServiceStatus.html"><CODE>GetServiceStatus</CODE></a> 131 </th> 132<td>Gets the service status of a task.</td> 133 </tr> 134 <tr> 135 <td width="100"> </td> 136 <th> 137<a href="../../../nn/boss/Task/Start.html"><CODE>Start</CODE></a> 138 </th> 139<td>Gives an instruction to start the task.</td> 140 </tr> 141 <tr> 142 <td width="100"> </td> 143 <th> 144<a href="../../../nn/boss/Task/StartImmediate.html"><CODE>StartImmediate</CODE></a> 145 </th> 146<td>Gives an instruction to start the task immediately. This function must only be called after infrastructure connections are enabled.</td> 147 </tr> 148 <tr> 149 <td width="100"> </td> 150 <th> 151<a href="../../../nn/boss/Task/StartBgImmediate.html"><CODE>StartBgImmediate</CODE></a> 152 </th> 153<td>Gives an instruction to start the task immediately in the background.</td> 154 </tr> 155 <tr> 156 <td width="100"> </td> 157 <th> 158<a href="../../../nn/boss/Task/Cancel.html"><CODE>Cancel</CODE></a> 159 </th> 160<td>Cancels a running task.</td> 161 </tr> 162 <tr> 163 <td width="100"> </td> 164 <th> 165<a href="../../../nn/boss/Task/WaitFinish.html"><CODE>WaitFinish</CODE></a> 166 </th> 167<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> 168 </tr> 169 <tr> 170 <td width="100"> </td> 171 <th> 172<a href="../../../nn/boss/Task/GetState.html"><CODE>GetState</CODE></a> 173 </th> 174<td>Gets the task state.</td> 175 </tr> 176 <tr> 177 <td width="100"> </td> 178 <th> 179<a href="../../../nn/boss/Task/GetHttpStatusCode.html"><CODE>GetHttpStatusCode</CODE></a> 180 </th> 181<td>Gets the communication error code.</td> 182 </tr> 183 <tr> 184 <td width="100"> </td> 185 <th> 186<a href="../../../nn/boss/Task/GetCommErrorCode.html"><CODE>GetCommErrorCode</CODE></a> 187 </th> 188<td>This is the old (deprecated) name for <CODE>nn::boss::GetHttpStatusCode</CODE>. Avoid using this: it only exists for compatibility.</td> 189 </tr> 190 <tr> 191 <td width="100"> </td> 192 <th> 193<a href="../../../nn/boss/Task/GetResult.html"><CODE>GetResult</CODE></a> 194 </th> 195<td>Gets the task result code.</td> 196 </tr> 197 <tr> 198 <td width="100"> </td> 199 <th> 200<a href="../../../nn/boss/Task/GetStateDetail.html"><CODE>GetStateDetail</CODE></a> 201 </th> 202<td>Gets the task status.</td> 203 </tr> 204 <tr> 205 <td width="100"> </td> 206 <th> 207<a href="../../../nn/boss/Task/GetStatus.html"><CODE>GetStatus</CODE></a> 208 </th> 209<td>This is the old (deprecated) name for <CODE>nn::boss::GetStateDetail</CODE>. Avoid using this: it only exists for compatibility.</td> 210 </tr> 211 <tr> 212 <td width="100"> </td> 213 <th> 214<a href="../../../nn/boss/Task/GetError.html"><CODE>GetError</CODE></a> 215 </th> 216<td>Gets the task error state.</td> 217 </tr> 218 <tr> 219 <td width="100"> </td> 220 <th> 221<a href="../../../nn/boss/Task/GetInfo.html"><CODE>GetInfo</CODE></a> 222 </th> 223<td>Gets information about a registered task.</td> 224 </tr> 225 <tr> 226 <td width="100"> </td> 227 <th> 228<a href="../../../nn/boss/Task/GetActivePriority.html"><CODE>GetActivePriority</CODE></a> 229 </th> 230<td>Gets the current task execution priority.</td> 231 </tr> 232 <tr> 233 <td width="100"> </td> 234 <th> 235<a href="../../../nn/boss/Task/SetQuery.html"><CODE>SetQuery</CODE></a> 236 </th> 237<td>Sets task query information.</td> 238 </tr> 239 <tr> 240 <td width="100"> </td> 241 <th> 242<a href="../../../nn/boss/Task/GetQuery.html"><CODE>GetQuery</CODE></a> 243 </th> 244<td>Gets task query information.</td> 245 </tr> 246 <tr> 247 <td width="100"> </td> 248 <th> 249<a href="../../../nn/boss/Task/GetTaskId.html"><CODE>GetTaskId</CODE></a> 250 </th> 251<td>Gets the task ID.</td> 252 </tr> </table> 253 </div> 254 </a> 255<h2>Revision History</h2> 256 <div class="section"> 257 <dl class="history"> 258 <dt>2010/09/16</dt> 259<dd>Initial version.<br /> 260 </dd> 261 </dl> 262 </div> 263 <hr><p>CONFIDENTIAL</p></body> 264</html> 265