nn::boss Namespace

Description

Namespace for the BOSS API.

Classes

nn::boss::NsaDownloadAction 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.)
nn::boss::NsData Class for representing NS data. Use for NS data operations (such as reading).
nn::boss::NsDataIdList Class for representing NS data ID lists. Use this to do such things as get a list of NS data to process.
nn::boss::StepIdList 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.)
nn::boss::Task Class for representing tasks. Use this to do such things as register or unregister a task, or for task operations.
nn::boss::TaskActionBase Base class for task actions. There is no reason for an application to directly generate an instance of this class.
nn::boss::TaskAction 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.
nn::boss::TaskError Class for representing task errors. Use this to get task error information.
nn::boss::TaskIdList Class for representing task ID lists. Use this to do such things as get a list of registered tasks.
nn::boss::TaskOption 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.)
nn::boss::TaskPolicy Class for representing task policies. Use this to do such things as set the policy information used when registering a task.
nn::boss::TaskStatus Class for representing task statuses. Use this to do such things as get the status of a task.

Enumerated Types

PositionBase Constants that indicate the position of file read/writes.
PropertyType Constants specifying properties.
SchedulingPolicy Constants specifying scheduling policies.
TaskPermission Constants specifying task permissions.
TaskPriority Constants specifying task priorities.
Action Constants specifying task actions.
ExecOption Constants specifying task execution options.
TaskStateCode Constants specifying task status codes.
TaskServiceStatus Constants specifying task service statuses.
HeaderInfoType Constants indicating the types of NSD header information obtained.
FileDescriptor Constants specifying task action file paths.
DataType Constants indicating data types. (Not Used)
enumApKind Constants indicating application ID types.
ApInfoType Constants indicating an access point's identifier type.
ResultCode Function result codes. Set as the description for bossResult, and used as the return value for boss functions.

Constants

S DATA_TYPE_ALL NSD data type.
S DATA_TYPE_APPDATA Data type for applications.
S DATA_TYPE_ANNOUNCEMENT Data type for announcements.
S DATA_TYPE_SUBBANNER Data type for sub-banners.
S MAX_FILEPATH_LENGTH BOSS system constant.
S MAX_URL_LENGTH Maximum URL length.
S MAX_HTTP_HEADER_LABEL Maximum length of HTTP header labels.
S MAX_HTTP_HEADER_VALUE Maximum length of HTTP header values.
S MAX_HTTP_HEADER Maximum number of headers that can be registered.
S MAX_ROOT_CA Maximum number of independent root CA certificates that can be registered.
S MAX_CLIENT_CERT Maximum number of independent client certificates that can be registered.
S TASK_ID_LENGTH The maximum number of task IDs, including zero-terminated strings.
S MAX_ERROR_MESSAGE Maximum number of characters in an error message.
S MAX_APPLICATION_ID Maximum number of application IDs that can be registered.
S MAX_TASK_ID Maximum number of task IDs that can be registered.
S MAX_STEP_ID Maximum number of task steps that can be registered to one task.
S CURRENT_STEP_ID ID of the currently running task step.
S DEFAULT_STEP_ID Task step ID when step ID is not specified.
S U32_CANNOT_GET_DATA Return value for functions that return u32 when they cannot get a value.
S MAX_LASTMODIFIED_LENGTH Maximum number of characters in the HTTP communication at the time it was updated.
S UNLIMITED_COUNT Specifies an unlimited count.

Functions

Initialize Initializes the library.
Finalize Closes the library.
RegisterPrivateRootCa Registers a private HTTPS root certificate to the library. Calling this function when another root certificate is already set causes an error.
RegisterPrivateClientCert 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.
RegisterTask Registers a task to the library.
UnregisterTask Unregisters a task previously registered to the library.
ReconfigureTask Updates the policy of a task previously registered to the library.
GetTaskIdList Gets a list of registered task IDs.
GetStepIdList Gets a list of all steps for the specified registered task.
RegisterStorage Registers BOSS storage used by BOSSD for NADL tasks and other purposes. NS data cannot be downloaded if no storage is registered.
UnregisterStorage Unregisters registered BOSS storage.
GetNewArrivalFlag Checks if new NS content has been downloaded.
GetNewArrivalEvent Registers an event to be signaled when new NS content is received.
SetOptoutFlag Sets the OptoutFlag.
GetOptoutFlag Gets the OptoutFlag.
GetNsDataIdList Gets a list of NS content for the specified data type.
GetOwnNsDataIdList 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.
GetNewDataNsDataIdList Gets a list of newly arrived NS content. The new arrival flag is cleared if this function is used to get all lists.
GetOwnNewDataNsDataIdList 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.
NN_DEFINE_RESULT_FUNC_LSM Result definition indicating that the policy information pointer was NULL.
NN_DEFINE_RESULT_CONST_LSM Result definition indicating that the task option pointer was NULL.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL