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</title> 51 </head> 52 <body> 53 <h1><CODE>nn::boss</CODE> Namespace</h1> 54 <h2>Description</h2> 55 <div class="section"> 56 <p>Namespace for the BOSS API.</p><!-- write here --></div> 57 <a name="class" id="class"> 58 <h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <th> 63 <a href="../../nn/boss/NsaDownloadAction/Overview.html"><CODE>nn::boss::NsaDownloadAction</CODE></a> 64 </th> 65 <td>Class for representing NADL tasks. Use this to do such things as register NADL tasks. (* There are notes regarding use with SDK version 0.13.)</td> 66 </tr> 67 <tr> 68 <th> 69 <a href="../../nn/boss/NsData/Overview.html"><CODE>nn::boss::NsData</CODE></a> 70 </th> 71 <td>Class for representing NS data. Use for NS data operations (such as reading).</td> 72 </tr> 73 <tr> 74 <th> 75 <a href="../../nn/boss/NsDataIdList/Overview.html"><CODE>nn::boss::NsDataIdList</CODE></a> 76 </th> 77 <td>Class for representing NS data ID lists. Use this to do such things as get a list of NS data to process.</td> 78 </tr> 79 <tr> 80 <th> 81 <a href="../../nn/boss/StepIdList/Overview.html"><CODE>nn::boss::StepIdList</CODE></a> 82 </th> 83 <td>Class for representing task step ID lists. Use this to do such things as get a list of task steps for a task. (The task step feature is not currently supported.)</td> 84 </tr> 85 <tr> 86 <th> 87 <a href="../../nn/boss/Task/Overview.html"><CODE>nn::boss::Task</CODE></a> 88 </th> 89 <td>Class for representing tasks. Use this to do such things as register or unregister a task, or for task operations.</td> 90 </tr> 91 <tr> 92 <th> 93 <a href="../../nn/boss/TaskActionBase/Overview.html"><CODE>nn::boss::TaskActionBase</CODE></a> 94 </th> 95 <td>Base class for task actions. There is no reason for an application to directly generate an instance of this class.</td> 96 </tr> 97 <tr> 98 <th> 99 <a href="../../nn/boss/TaskAction/Overview.html"><CODE>nn::boss::TaskAction</CODE></a> 100 </th> 101 <td>Class for representing task actions. This is the base class for specific task action classes such as NADL tasks. You can also directly generate an instance and use it to get information about task actions for a specific task.</td> 102 </tr> 103 <tr> 104 <th> 105 <a href="../../nn/boss/TaskError/Overview.html"><CODE>nn::boss::TaskError</CODE></a> 106 </th> 107 <td>Class for representing task errors. Use this to get task error information.</td> 108 </tr> 109 <tr> 110 <th> 111 <a href="../../nn/boss/TaskIdList/Overview.html"><CODE>nn::boss::TaskIdList</CODE></a> 112 </th> 113 <td>Class for representing task ID lists. Use this to do such things as get a list of registered tasks.</td> 114 </tr> 115 <tr> 116 <th> 117 <a href="../../nn/boss/TaskOption/Overview.html"><CODE>nn::boss::TaskOption</CODE></a> 118 </th> 119 <td>Class for representing task options. Use this to do such things as set the option information used when registering a task. (The task option feature is not currently supported.)</td> 120 </tr> 121 <tr> 122 <th> 123 <a href="../../nn/boss/TaskPolicy/Overview.html"><CODE>nn::boss::TaskPolicy</CODE></a> 124 </th> 125 <td>Class for representing task policies. Use this to do such things as set the policy information used when registering a task.</td> 126 </tr> 127 <tr> 128 <th> 129 <a href="../../nn/boss/TaskStatus/Overview.html"><CODE>nn::boss::TaskStatus</CODE></a> 130 </th> 131 <td>Class for representing task statuses. Use this to do such things as get the status of a task.</td> 132 </tr> 133 </table> 134 </div> 135 </a> <a name="enum" id="enum"> 136 <h2>Enumerated Types</h2> 137 <div class="section"> 138 <table class="members"> 139 <tr> 140 <td width="100"> </td> 141 <th> 142 <a href="../../nn/boss/PositionBase.html"><CODE>PositionBase</CODE></a> 143 </th> 144 <td>Constants that indicate the position of file read/writes.</td> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149 <a href="../../nn/boss/PropertyType.html"><CODE>PropertyType</CODE></a> 150 </th> 151 <td>Constants specifying properties.</td> 152 </tr> 153 <tr> 154 <td width="100"> </td> 155 <th> 156 <a href="../../nn/boss/SchedulingPolicy.html"><CODE>SchedulingPolicy</CODE></a> 157 </th> 158 <td>Constants specifying scheduling policies.</td> 159 </tr> 160 <tr> 161 <td width="100"> </td> 162 <th> 163 <a href="../../nn/boss/TaskPermission.html"><CODE>TaskPermission</CODE></a> 164 </th> 165 <td>Constants specifying task permissions.</td> 166 </tr> 167 <tr> 168 <td width="100"> </td> 169 <th> 170 <a href="../../nn/boss/TaskPriority.html"><CODE>TaskPriority</CODE></a> 171 </th> 172 <td>Constants specifying task priorities.</td> 173 </tr> 174 <tr> 175 <td width="100"> </td> 176 <th> 177 <a href="../../nn/boss/Action.html"><CODE>Action</CODE></a> 178 </th> 179 <td>Constants specifying task actions.</td> 180 </tr> 181 <tr> 182 <td width="100"> </td> 183 <th> 184 <a href="../../nn/boss/ExecOption.html"><CODE>ExecOption</CODE></a> 185 </th> 186 <td>Constants specifying task execution options.</td> 187 </tr> 188 <tr> 189 <td width="100"> </td> 190 <th> 191 <a href="../../nn/boss/TaskStateCode.html"><CODE>TaskStateCode</CODE></a> 192 </th> 193 <td>Constants specifying task status codes.</td> 194 </tr> 195 <tr> 196 <td width="100"> </td> 197 <th> 198 <a href="../../nn/boss/TaskServiceStatus.html"><CODE>TaskServiceStatus</CODE></a> 199 </th> 200 <td>Constants specifying task service statuses.</td> 201 </tr> 202 <tr> 203 <td width="100"> </td> 204 <th> 205 <a href="../../nn/boss/HeaderInfoType.html"><CODE>HeaderInfoType</CODE></a> 206 </th> 207 <td>Constants indicating the types of NSD header information obtained.</td> 208 </tr> 209 <tr> 210 <td width="100"> </td> 211 <th> 212 <a href="../../nn/boss/FileDescriptor.html"><CODE>FileDescriptor</CODE></a> 213 </th> 214 <td>Constants specifying task action file paths.</td> 215 </tr> 216 <tr> 217 <td width="100"> </td> 218 <th> 219 <a href="../../nn/boss/DataType.html"><CODE>DataType</CODE></a> 220 </th> 221 <td>Constants indicating data types. (Not Used)</td> 222 </tr> 223 <tr> 224 <td width="100"> </td> 225 <th> 226 <a href="../../nn/boss/enumApKind.html"><CODE>enumApKind</CODE></a> 227 </th> 228 <td>Constants indicating application ID types.</td> 229 </tr> 230 <tr> 231 <td width="100"> </td> 232 <th> 233 <a href="../../nn/boss/ApInfoType.html">ApInfoType</a> 234 </th> 235 <td>Constants indicating an access point's identifier type.</td> 236 </tr> 237 <tr> 238 <td width="100"> </td> 239 <th> 240 <a href="../../nn/boss/ResultCode.html"><CODE>ResultCode</CODE></a> 241 </th> 242 <td>Function result codes. Set as the <CODE>description</CODE> for <CODE>bossResult</CODE>, and used as the return value for <CODE>boss</CODE> functions.</td> 243 </tr> </table> 244 </div> 245 </a> <a name="constant" id="constant"> 246 <h2>Constants</h2> 247 <div class="section"> 248 <table class="members"> 249 <tr> 250 <td width="100"> 251 <span class="static_style" title="static">S</span> 252 </td> 253 <th> 254 <span class="argument"><a href="./DATA_TYPE_ALL.html"><CODE>DATA_TYPE_ALL</CODE></a></span> 255 </th> 256 <td>NSD data type.</td> 257 </tr> 258 <tr> 259 <td width="100"> 260 <span class="static_style" title="static">S</span> 261 </td> 262 <th> 263 <span class="argument"><a href="./DATA_TYPE_APPDATA.html"><CODE>DATA_TYPE_APPDATA</CODE></a></span> 264 </th> 265 <td>Data type for applications.</td> 266 </tr> 267 <tr> 268 <td width="100"> 269 <span class="static_style" title="static">S</span> 270 </td> 271 <th> 272 <span class="argument"><a href="./DATA_TYPE_ANNOUNCEMENT.html"><CODE>DATA_TYPE_ANNOUNCEMENT</CODE></a></span> 273 </th> 274 <td>Data type for announcements.</td> 275 </tr> 276 <tr> 277 <td width="100"> 278 <span class="static_style" title="static">S</span> 279 </td> 280 <th> 281 <span class="argument"><a href="./DATA_TYPE_SUBBANNER.html"><CODE>DATA_TYPE_SUBBANNER</CODE></a></span> 282 </th> 283 <td>Data type for sub-banners.</td> 284 </tr> 285 <tr> 286 <td width="100"> 287 <span class="static_style" title="static">S</span> 288 </td> 289 <th> 290 <span class="argument"><a href="./MAX_FILEPATH_LENGTH.html"><CODE>MAX_FILEPATH_LENGTH</CODE></a></span> 291 </th> 292 <td>BOSS system constant.</td> 293 </tr> 294 <tr> 295 <td width="100"> 296 <span class="static_style" title="static">S</span> 297 </td> 298 <th> 299 <span class="argument"><a href="./MAX_URL_LENGTH.html"><CODE>MAX_URL_LENGTH</CODE></a></span> 300 </th> 301 <td>Maximum URL length.</td> 302 </tr> 303 <tr> 304 <td width="100"> 305 <span class="static_style" title="static">S</span> 306 </td> 307 <th> 308 <span class="argument"><a href="./MAX_HTTP_HEADER_LABEL.html"><CODE>MAX_HTTP_HEADER_LABEL</CODE></a></span> 309 </th> 310 <td>Maximum length of HTTP header labels.</td> 311 </tr> 312 <tr> 313 <td width="100"> 314 <span class="static_style" title="static">S</span> 315 </td> 316 <th> 317 <span class="argument"><a href="./MAX_HTTP_HEADER_VALUE.html"><CODE>MAX_HTTP_HEADER_VALUE</CODE></a></span> 318 </th> 319 <td>Maximum length of HTTP header values.</td> 320 </tr> 321 <tr> 322 <td width="100"> 323 <span class="static_style" title="static">S</span> 324 </td> 325 <th> 326 <span class="argument"><a href="./MAX_HTTP_HEADER.html"><CODE>MAX_HTTP_HEADER</CODE></a></span> 327 </th> 328 <td>Maximum number of headers that can be registered.</td> 329 </tr> 330 <tr> 331 <td width="100"> 332 <span class="static_style" title="static">S</span> 333 </td> 334 <th> 335 <span class="argument"><a href="./MAX_ROOT_CA.html"><CODE>MAX_ROOT_CA</CODE></a></span> 336 </th> 337 <td>Maximum number of independent root CA certificates that can be registered.</td> 338 </tr> 339 <tr> 340 <td width="100"> 341 <span class="static_style" title="static">S</span> 342 </td> 343 <th> 344 <span class="argument"><a href="./MAX_CLIENT_CERT.html"><CODE>MAX_CLIENT_CERT</CODE></a></span> 345 </th> 346 <td>Maximum number of independent client certificates that can be registered.</td> 347 </tr> 348 <tr> 349 <td width="100"> 350 <span class="static_style" title="static">S</span> 351 </td> 352 <th> 353 <span class="argument"><a href="./TASK_ID_LENGTH.html"><CODE>TASK_ID_LENGTH</CODE></a></span> 354 </th> 355 <td>The maximum number of task IDs, including zero-terminated strings.</td> 356 </tr> 357 <tr> 358 <td width="100"> 359 <span class="static_style" title="static">S</span> 360 </td> 361 <th> 362 <span class="argument"><a href="./MAX_ERROR_MESSAGE.html"><CODE>MAX_ERROR_MESSAGE</CODE></a></span> 363 </th> 364 <td>Maximum number of characters in an error message.</td> 365 </tr> 366 <tr> 367 <td width="100"> 368 <span class="static_style" title="static">S</span> 369 </td> 370 <th> 371 <span class="argument"><a href="./MAX_APPLICATION_ID.html"><CODE>MAX_APPLICATION_ID</CODE></a></span> 372 </th> 373 <td>Maximum number of application IDs that can be registered.</td> 374 </tr> 375 <tr> 376 <td width="100"> 377 <span class="static_style" title="static">S</span> 378 </td> 379 <th> 380 <span class="argument"><a href="./MAX_TASK_ID.html"><CODE>MAX_TASK_ID</CODE></a></span> 381 </th> 382 <td>Maximum number of task IDs that can be registered.</td> 383 </tr> 384 <tr> 385 <td width="100"> 386 <span class="static_style" title="static">S</span> 387 </td> 388 <th> 389 <span class="argument"><a href="./MAX_STEP_ID.html"><CODE>MAX_STEP_ID</CODE></a></span> 390 </th> 391 <td>Maximum number of task steps that can be registered to one task.</td> 392 </tr> 393 <tr> 394 <td width="100"> 395 <span class="static_style" title="static">S</span> 396 </td> 397 <th> 398 <span class="argument"><a href="./CURRENT_STEP_ID.html"><CODE>CURRENT_STEP_ID</CODE></a></span> 399 </th> 400 <td>ID of the currently running task step.</td> 401 </tr> 402 <tr> 403 <td width="100"> 404 <span class="static_style" title="static">S</span> 405 </td> 406 <th> 407 <span class="argument"><a href="./DEFAULT_STEP_ID.html"><CODE>DEFAULT_STEP_ID</CODE></a></span> 408 </th> 409 <td>Task step ID when step ID is not specified.</td> 410 </tr> 411 <tr> 412 <td width="100"> 413 <span class="static_style" title="static">S</span> 414 </td> 415 <th> 416 <span class="argument"><a href="./U32_CANNOT_GET_DATA.html"><CODE>U32_CANNOT_GET_DATA</CODE></a></span> 417 </th> 418 <td>Return value for functions that return <CODE>u32</CODE> when they cannot get a value.</td> 419 </tr> 420 <tr> 421 <td width="100"> 422 <span class="static_style" title="static">S</span> 423 </td> 424 <th> 425 <span class="argument"><a href="./MAX_LASTMODIFIED_LENGTH.html"><CODE>MAX_LASTMODIFIED_LENGTH</CODE></a></span> 426 </th> 427 <td>Maximum number of characters in the HTTP communication at the time it was updated.</td> 428 </tr> 429 <tr> 430 <td width="100"> 431 <span class="static_style" title="static">S</span> 432 </td> 433 <th> 434 <span class="argument"><a href="./UNLIMITED_COUNT.html"><CODE>UNLIMITED_COUNT</CODE></a></span> 435 </th> 436 <td>Specifies an unlimited count.</td> 437 </tr> </table> 438 </div> 439 </a> <a name="function" id="function"> 440 <h2>Functions</h2> 441 <div class="section"> 442 <table class="members"> 443 <tr> 444 <td width="100"> </td> 445 <th> 446 <a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> 447 </th> 448 <td>Initializes the library.</td> 449 </tr> 450 <tr> 451 <td width="100"> </td> 452 <th> 453 <a href="../../nn/boss/Finalize.html"><CODE>Finalize</CODE></a> 454 </th> 455 <td>Closes the library.</td> 456 </tr> 457 <tr> 458 <td width="100"> </td> 459 <th> 460 <a href="../../nn/boss/RegisterPrivateRootCa.html"><CODE>RegisterPrivateRootCa</CODE></a> 461 </th> 462 <td>Registers a private HTTPS root certificate to the library. Calling this function when another root certificate is already set causes an error.</td> 463 </tr> 464 <tr> 465 <td width="100"> </td> 466 <th> 467 <a href="../../nn/boss/RegisterPrivateClientCert.html"><CODE>RegisterPrivateClientCert</CODE></a> 468 </th> 469 <td>Registers a private HTTPS client certificate and private key to the library. Calling this function when another client certificate is already set causes an error.</td> 470 </tr> 471 <tr> 472 <td width="100"> </td> 473 <th> 474 <a href="../../nn/boss/RegisterTask.html"><CODE>RegisterTask</CODE></a> 475 </th> 476 <td>Registers a task to the library.</td> 477 </tr> 478 <tr> 479 <td width="100"> </td> 480 <th> 481 <a href="../../nn/boss/UnregisterTask.html"><CODE>UnregisterTask</CODE></a> 482 </th> 483 <td>Unregisters a task previously registered to the library.</td> 484 </tr> 485 <tr> 486 <td width="100"> </td> 487 <th> 488 <a href="../../nn/boss/ReconfigureTask.html"><CODE>ReconfigureTask</CODE></a> 489 </th> 490 <td>Updates the policy of a task previously registered to the library.</td> 491 </tr> 492 <tr> 493 <td width="100"> </td> 494 <th> 495 <a href="../../nn/boss/GetTaskIdList.html"><CODE>GetTaskIdList</CODE></a> 496 </th> 497 <td>Gets a list of registered task IDs.</td> 498 </tr> 499 <tr> 500 <td width="100"> </td> 501 <th> 502 <a href="../../nn/boss/GetStepIdList.html"><CODE>GetStepIdList</CODE></a> 503 </th> 504 <td>Gets a list of all steps for the specified registered task.</td> 505 </tr> 506 <tr> 507 <td width="100"> </td> 508 <th> 509 <a href="../../nn/boss/RegisterStorage.html"><CODE>RegisterStorage</CODE></a> 510 </th> 511 <td>Registers BOSS storage used by BOSSD for NADL tasks and other purposes. NS data cannot be downloaded if no storage is registered.</td> 512 </tr> 513 <tr> 514 <td width="100"> </td> 515 <th> 516 <a href="../../nn/boss/UnregisterStorage.html"><CODE>UnregisterStorage</CODE></a> 517 </th> 518 <td>Unregisters registered BOSS storage.</td> 519 </tr> 520 <tr> 521 <td width="100"> </td> 522 <th> 523 <a href="../../nn/boss/GetNewArrivalFlag.html"><CODE>GetNewArrivalFlag</CODE></a> 524 </th> 525 <td>Checks if new NS content has been downloaded.</td> 526 </tr> 527 <tr> 528 <td width="100"> </td> 529 <th> 530 <a href="../../nn/boss/GetNewArrivalEvent.html"><CODE>GetNewArrivalEvent</CODE></a> 531 </th> 532 <td>Registers an event to be signaled when new NS content is received.</td> 533 </tr> 534 <tr> 535 <td width="100"> </td> 536 <th> 537 <a href="../../nn/boss/SetOptoutFlag.html"><CODE>SetOptoutFlag</CODE></a> 538 </th> 539 <td>Sets the <CODE>OptoutFlag</CODE>.</td> 540 </tr> 541 <tr> 542 <td width="100"> </td> 543 <th> 544 <a href="../../nn/boss/GetOptoutFlag.html"><CODE>GetOptoutFlag</CODE></a> 545 </th> 546 <td>Gets the <CODE>OptoutFlag</CODE>.</td> 547 </tr> 548 <tr> 549 <td width="100"> </td> 550 <th> 551 <a href="../../nn/boss/GetNsDataIdList.html"><CODE>GetNsDataIdList</CODE></a> 552 </th> 553 <td>Gets a list of NS content for the specified data type.</td> 554 </tr> 555 <tr> 556 <td width="100"> </td> 557 <th> 558 <a href="../../nn/boss/GetOwnNsDataIdList.html"><CODE>GetOwnNsDataIdList</CODE></a> 559 </th> 560 <td>Gets a list of NS content excluding shared NSD. In other words, returns a list of NSD for just the calling application, even if there is shared NSD.</td> 561 </tr> 562 <tr> 563 <td width="100"> </td> 564 <th> 565 <a href="../../nn/boss/GetNewDataNsDataIdList.html"><CODE>GetNewDataNsDataIdList</CODE></a> 566 </th> 567 <td>Gets a list of newly arrived NS content. The new arrival flag is cleared if this function is used to get all lists.</td> 568 </tr> 569 <tr> 570 <td width="100"> </td> 571 <th> 572 <a href="../../nn/boss/GetOwnNewDataNsDataIdList.html"><CODE>GetOwnNewDataNsDataIdList</CODE></a> 573 </th> 574 <td>Gets a list of newly arrived NS content excluding shared NSD. In other words, returns a list of NSD for just the calling application, even if there is shared NSD.</td> 575 </tr> 576 <tr> 577 <td width="100"> </td> 578 <th> 579 <a href="../../nn/boss/NN_DEFINE_RESULT_FUNC_LSM.html"><CODE>NN_DEFINE_RESULT_FUNC_LSM</CODE></a> 580 </th> 581 <td>Result definition indicating that the policy information pointer was <CODE>NULL</CODE>.</td> 582 </tr> 583 <tr> 584 <td width="100"> </td> 585 <th> 586 <a href="../../nn/boss/NN_DEFINE_RESULT_CONST_LSM.html"><CODE>NN_DEFINE_RESULT_CONST_LSM</CODE></a> 587 </th> 588 <td>Result definition indicating that the task option pointer was <CODE>NULL</CODE>.</td> 589 </tr> </table> 590 </div> 591 </a> 592 <h2>Revision History</h2> 593 <div class="section"> 594 <dl class="history"> 595 <dt>2010/09/16</dt> 596 <dd>Initial version.<br /> 597 </dd> 598 </dl> 599 </div> 600 <hr><p>CONFIDENTIAL</p></body> 601</html>