788 lines
44 KiB
HTML
788 lines
44 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/services/boss.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libctru
|
|
 <span id="projectnumber">v2.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">boss.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>BOSS service, see also: <a href="https://www.3dbrew.org/wiki/BOSS_Services">https://www.3dbrew.org/wiki/BOSS_Services</a>.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="boss_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbossContext.html">bossContext</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">BOSS context. <a href="structbossContext.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:a8d1917af6ca0f9217e8c45469c16fa8b"><td class="memItemLeft" align="right" valign="top"><a id="a8d1917af6ca0f9217e8c45469c16fa8b"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a8d1917af6ca0f9217e8c45469c16fa8b">bossTaskStatus</a> { <br />
|
|
  <b>BOSSTASKSTATUS_STARTED</b> = 0x2
|
|
, <br />
|
|
  <b>BOSSTASKSTATUS_ERROR</b> = 0x7
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a8d1917af6ca0f9217e8c45469c16fa8b"><td class="mdescLeft"> </td><td class="mdescRight">BOSS task status. <br /></td></tr>
|
|
<tr class="separator:a8d1917af6ca0f9217e8c45469c16fa8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f6b869f490eafd03cb0eb2c42d1201b"><td class="memItemLeft" align="right" valign="top"><a id="a0f6b869f490eafd03cb0eb2c42d1201b"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a0f6b869f490eafd03cb0eb2c42d1201b">bossNsDataHeaderInfoTypes</a> { <b>bossNsDataHeaderInfoType_ContentSize</b> = 0x3
|
|
}</td></tr>
|
|
<tr class="memdesc:a0f6b869f490eafd03cb0eb2c42d1201b"><td class="mdescLeft"> </td><td class="mdescRight">Type values for <a class="el" href="boss_8h.html#aba33abae121b5753b3cffa9bb9d13b0e" title="Gets header info for the specified NsDataId.">bossGetNsDataHeaderInfo()</a>. <br /></td></tr>
|
|
<tr class="separator:a0f6b869f490eafd03cb0eb2c42d1201b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfd491a7e4241dc9d3528d026cd54812"><td class="memItemLeft" align="right" valign="top"><a id="adfd491a7e4241dc9d3528d026cd54812"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#adfd491a7e4241dc9d3528d026cd54812">bossNsDataHeaderInfoTypeSizes</a> { <b>bossNsDataHeaderInfoTypeSize_ContentSize</b> = 0x4
|
|
}</td></tr>
|
|
<tr class="memdesc:adfd491a7e4241dc9d3528d026cd54812"><td class="mdescLeft"> </td><td class="mdescRight">Size of the output data for <a class="el" href="boss_8h.html#aba33abae121b5753b3cffa9bb9d13b0e" title="Gets header info for the specified NsDataId.">bossGetNsDataHeaderInfo()</a>. <br /></td></tr>
|
|
<tr class="separator:adfd491a7e4241dc9d3528d026cd54812"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a51a7ee69864f16c5b10a11e20ebadbc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a51a7ee69864f16c5b10a11e20ebadbc1">bossInit</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> programID, bool force_user)</td></tr>
|
|
<tr class="memdesc:a51a7ee69864f16c5b10a11e20ebadbc1"><td class="mdescLeft"> </td><td class="mdescRight">Initializes BOSS. <a href="boss_8h.html#a51a7ee69864f16c5b10a11e20ebadbc1">More...</a><br /></td></tr>
|
|
<tr class="separator:a51a7ee69864f16c5b10a11e20ebadbc1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0bc14e4abeafad9edc307dc7a2c0be0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#ad0bc14e4abeafad9edc307dc7a2c0be0">bossReinit</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> programID)</td></tr>
|
|
<tr class="memdesc:ad0bc14e4abeafad9edc307dc7a2c0be0"><td class="mdescLeft"> </td><td class="mdescRight">Run the InitializeSession service cmd. <a href="boss_8h.html#ad0bc14e4abeafad9edc307dc7a2c0be0">More...</a><br /></td></tr>
|
|
<tr class="separator:ad0bc14e4abeafad9edc307dc7a2c0be0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d39838a77aa70d0c49655bea527688f"><td class="memItemLeft" align="right" valign="top"><a id="a7d39838a77aa70d0c49655bea527688f"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a7d39838a77aa70d0c49655bea527688f">bossExit</a> (void)</td></tr>
|
|
<tr class="memdesc:a7d39838a77aa70d0c49655bea527688f"><td class="mdescLeft"> </td><td class="mdescRight">Exits BOSS. <br /></td></tr>
|
|
<tr class="separator:a7d39838a77aa70d0c49655bea527688f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af062df1ed184ae92c0fea54e56a01a9b"><td class="memItemLeft" align="right" valign="top"><a id="af062df1ed184ae92c0fea54e56a01a9b"></a>
|
|
<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#af062df1ed184ae92c0fea54e56a01a9b">bossGetSessionHandle</a> (void)</td></tr>
|
|
<tr class="memdesc:af062df1ed184ae92c0fea54e56a01a9b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the BOSS session handle. <br /></td></tr>
|
|
<tr class="separator:af062df1ed184ae92c0fea54e56a01a9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96574119e6fa095aec99f6bac0fadfea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a96574119e6fa095aec99f6bac0fadfea">bossSetStorageInfo</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> extdataID, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> boss_size, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> mediaType)</td></tr>
|
|
<tr class="memdesc:a96574119e6fa095aec99f6bac0fadfea"><td class="mdescLeft"> </td><td class="mdescRight">Set the content data storage location. <a href="boss_8h.html#a96574119e6fa095aec99f6bac0fadfea">More...</a><br /></td></tr>
|
|
<tr class="separator:a96574119e6fa095aec99f6bac0fadfea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d8c516ed9331ee157e2583443bb960a"><td class="memItemLeft" align="right" valign="top"><a id="a6d8c516ed9331ee157e2583443bb960a"></a>
|
|
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a6d8c516ed9331ee157e2583443bb960a">bossUnregisterStorage</a> (void)</td></tr>
|
|
<tr class="memdesc:a6d8c516ed9331ee157e2583443bb960a"><td class="mdescLeft"> </td><td class="mdescRight">Unregister the content data storage location, which includes unregistering the BOSS-session programID with BOSS. <br /></td></tr>
|
|
<tr class="separator:a6d8c516ed9331ee157e2583443bb960a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adda61987644ad6ba87f4cf69090dfcdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#adda61987644ad6ba87f4cf69090dfcdb">bossRegisterTask</a> (const char *taskID, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> unk0, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> unk1)</td></tr>
|
|
<tr class="memdesc:adda61987644ad6ba87f4cf69090dfcdb"><td class="mdescLeft"> </td><td class="mdescRight">Register a task. <a href="boss_8h.html#adda61987644ad6ba87f4cf69090dfcdb">More...</a><br /></td></tr>
|
|
<tr class="separator:adda61987644ad6ba87f4cf69090dfcdb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9021bd11848da0af58dff1fc4c75ad4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#ac9021bd11848da0af58dff1fc4c75ad4">bossSendProperty</a> (<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> PropertyID, const void *buf, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size)</td></tr>
|
|
<tr class="memdesc:ac9021bd11848da0af58dff1fc4c75ad4"><td class="mdescLeft"> </td><td class="mdescRight">Send a property. <a href="boss_8h.html#ac9021bd11848da0af58dff1fc4c75ad4">More...</a><br /></td></tr>
|
|
<tr class="separator:ac9021bd11848da0af58dff1fc4c75ad4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad540935924ca6ed4e9014ccb2f0bc0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#aad540935924ca6ed4e9014ccb2f0bc0b">bossDeleteNsData</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> NsDataId)</td></tr>
|
|
<tr class="memdesc:aad540935924ca6ed4e9014ccb2f0bc0b"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the content file for the specified NsDataId. <a href="boss_8h.html#aad540935924ca6ed4e9014ccb2f0bc0b">More...</a><br /></td></tr>
|
|
<tr class="separator:aad540935924ca6ed4e9014ccb2f0bc0b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba33abae121b5753b3cffa9bb9d13b0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#aba33abae121b5753b3cffa9bb9d13b0e">bossGetNsDataHeaderInfo</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> NsDataId, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> type, void *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size)</td></tr>
|
|
<tr class="memdesc:aba33abae121b5753b3cffa9bb9d13b0e"><td class="mdescLeft"> </td><td class="mdescRight">Gets header info for the specified NsDataId. <a href="boss_8h.html#aba33abae121b5753b3cffa9bb9d13b0e">More...</a><br /></td></tr>
|
|
<tr class="separator:aba33abae121b5753b3cffa9bb9d13b0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b3fbe675e9798b0e575c5eedcb6d788"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a5b3fbe675e9798b0e575c5eedcb6d788">bossReadNsData</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> NsDataId, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> offset, void *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *transfer_total, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *unk_out)</td></tr>
|
|
<tr class="memdesc:a5b3fbe675e9798b0e575c5eedcb6d788"><td class="mdescLeft"> </td><td class="mdescRight">Reads data from the content for the specified NsDataId. <a href="boss_8h.html#a5b3fbe675e9798b0e575c5eedcb6d788">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b3fbe675e9798b0e575c5eedcb6d788"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92fba4c5efe92a052c1f2feed3086cda"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a92fba4c5efe92a052c1f2feed3086cda">bossStartTaskImmediate</a> (const char *taskID)</td></tr>
|
|
<tr class="memdesc:a92fba4c5efe92a052c1f2feed3086cda"><td class="mdescLeft"> </td><td class="mdescRight">Starts a task soon after running this command. <a href="boss_8h.html#a92fba4c5efe92a052c1f2feed3086cda">More...</a><br /></td></tr>
|
|
<tr class="separator:a92fba4c5efe92a052c1f2feed3086cda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:affcdefc8c0ea7c04af3429ee4bb062e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#affcdefc8c0ea7c04af3429ee4bb062e3">bossStartBgImmediate</a> (const char *taskID)</td></tr>
|
|
<tr class="memdesc:affcdefc8c0ea7c04af3429ee4bb062e3"><td class="mdescLeft"> </td><td class="mdescRight">Similar to bossStartTaskImmediate? <a href="boss_8h.html#affcdefc8c0ea7c04af3429ee4bb062e3">More...</a><br /></td></tr>
|
|
<tr class="separator:affcdefc8c0ea7c04af3429ee4bb062e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d9ec5b11a976033da50bc98e85d9715"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a9d9ec5b11a976033da50bc98e85d9715">bossDeleteTask</a> (const char *taskID, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> unk)</td></tr>
|
|
<tr class="memdesc:a9d9ec5b11a976033da50bc98e85d9715"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a task by using CancelTask and UnregisterTask internally. <a href="boss_8h.html#a9d9ec5b11a976033da50bc98e85d9715">More...</a><br /></td></tr>
|
|
<tr class="separator:a9d9ec5b11a976033da50bc98e85d9715"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f6498cd076b685455b7ce71b499e80c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a0f6498cd076b685455b7ce71b499e80c">bossGetTaskState</a> (const char *taskID, <a class="el" href="types_8h.html#a9e382f207c65ca13ab4ae98363aeda80">s8</a> inval, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *status, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *out1, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out2)</td></tr>
|
|
<tr class="memdesc:a0f6498cd076b685455b7ce71b499e80c"><td class="mdescLeft"> </td><td class="mdescRight">Returns task state. <a href="boss_8h.html#a0f6498cd076b685455b7ce71b499e80c">More...</a><br /></td></tr>
|
|
<tr class="separator:a0f6498cd076b685455b7ce71b499e80c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09dd791d42c55a259516107aa072cb9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a09dd791d42c55a259516107aa072cb9b">bossGetTaskProperty0</a> (const char *taskID, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out)</td></tr>
|
|
<tr class="memdesc:a09dd791d42c55a259516107aa072cb9b"><td class="mdescLeft"> </td><td class="mdescRight">This loads the current state of PropertyID 0x0 for the specified task. <a href="boss_8h.html#a09dd791d42c55a259516107aa072cb9b">More...</a><br /></td></tr>
|
|
<tr class="separator:a09dd791d42c55a259516107aa072cb9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a18a7541eb4ff0ba8340bfe8177c22671"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a18a7541eb4ff0ba8340bfe8177c22671">bossSetupContextDefault</a> (<a class="el" href="structbossContext.html">bossContext</a> *ctx, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> seconds_interval, const char *url)</td></tr>
|
|
<tr class="memdesc:a18a7541eb4ff0ba8340bfe8177c22671"><td class="mdescLeft"> </td><td class="mdescRight">Setup a BOSS context with the default config. <a href="boss_8h.html#a18a7541eb4ff0ba8340bfe8177c22671">More...</a><br /></td></tr>
|
|
<tr class="separator:a18a7541eb4ff0ba8340bfe8177c22671"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a251f950dae769145729b0a8699c30dc3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="boss_8h.html#a251f950dae769145729b0a8699c30dc3">bossSendContextConfig</a> (<a class="el" href="structbossContext.html">bossContext</a> *ctx)</td></tr>
|
|
<tr class="memdesc:a251f950dae769145729b0a8699c30dc3"><td class="mdescLeft"> </td><td class="mdescRight">Sends the config stored in the context. <a href="boss_8h.html#a251f950dae769145729b0a8699c30dc3">More...</a><br /></td></tr>
|
|
<tr class="separator:a251f950dae769145729b0a8699c30dc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>BOSS service, see also: <a href="https://www.3dbrew.org/wiki/BOSS_Services">https://www.3dbrew.org/wiki/BOSS_Services</a>. </p>
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
|
<a id="aad540935924ca6ed4e9014ccb2f0bc0b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad540935924ca6ed4e9014ccb2f0bc0b">◆ </a></span>bossDeleteNsData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossDeleteNsData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>NsDataId</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deletes the content file for the specified NsDataId. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">NsDataId</td><td>NsDataId </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a7">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d9ec5b11a976033da50bc98e85d9715"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d9ec5b11a976033da50bc98e85d9715">◆ </a></span>bossDeleteTask()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossDeleteTask </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>taskID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>unk</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deletes a task by using CancelTask and UnregisterTask internally. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">taskID</td><td>BOSS taskID. </td></tr>
|
|
<tr><td class="paramname">unk</td><td>Unknown, usually zero? </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a6">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba33abae121b5753b3cffa9bb9d13b0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba33abae121b5753b3cffa9bb9d13b0e">◆ </a></span>bossGetNsDataHeaderInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossGetNsDataHeaderInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>NsDataId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets header info for the specified NsDataId. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">NsDataId</td><td>NsDataId </td></tr>
|
|
<tr><td class="paramname">type</td><td>Type of data to load. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>Output buffer. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Output buffer size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a15">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a09dd791d42c55a259516107aa072cb9b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a09dd791d42c55a259516107aa072cb9b">◆ </a></span>bossGetTaskProperty0()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossGetTaskProperty0 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>taskID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This loads the current state of PropertyID 0x0 for the specified task. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">taskID</td><td>BOSS taskID. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f6498cd076b685455b7ce71b499e80c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f6498cd076b685455b7ce71b499e80c">◆ </a></span>bossGetTaskState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossGetTaskState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>taskID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a9e382f207c65ca13ab4ae98363aeda80">s8</a> </td>
|
|
<td class="paramname"><em>inval</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>status</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>out1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> * </td>
|
|
<td class="paramname"><em>out2</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns task state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">taskID</td><td>BOSS taskID. </td></tr>
|
|
<tr><td class="paramname">inval</td><td>Unknown, normally 0? </td></tr>
|
|
<tr><td class="paramname">status</td><td>Output status, see bossTaskStatus. </td></tr>
|
|
<tr><td class="paramname">out1</td><td>Output field. </td></tr>
|
|
<tr><td class="paramname">out2</td><td>Output field. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a13">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a51a7ee69864f16c5b10a11e20ebadbc1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a51a7ee69864f16c5b10a11e20ebadbc1">◆ </a></span>bossInit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>programID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>force_user</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes BOSS. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">programID</td><td>programID to use, 0 for the current process. Only used when BOSSP is available without *hax payload. </td></tr>
|
|
<tr><td class="paramname">force_user</td><td>When true, just use bossU instead of trying to initialize with bossP first. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a4">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b3fbe675e9798b0e575c5eedcb6d788"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b3fbe675e9798b0e575c5eedcb6d788">◆ </a></span>bossReadNsData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossReadNsData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>NsDataId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>offset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>transfer_total</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>unk_out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads data from the content for the specified NsDataId. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">NsDataId</td><td>NsDataId </td></tr>
|
|
<tr><td class="paramname">offset</td><td>Offset in the content. </td></tr>
|
|
<tr><td class="paramname">buffer</td><td>Output buffer. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Output buffer size. </td></tr>
|
|
<tr><td class="paramname">transfer_total</td><td>Optional output actual read size, can be NULL. </td></tr>
|
|
<tr><td class="paramname">unk_out</td><td>Optional unknown output, can be NULL. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a16">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adda61987644ad6ba87f4cf69090dfcdb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adda61987644ad6ba87f4cf69090dfcdb">◆ </a></span>bossRegisterTask()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossRegisterTask </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>taskID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> </td>
|
|
<td class="paramname"><em>unk0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> </td>
|
|
<td class="paramname"><em>unk1</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Register a task. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">taskID</td><td>BOSS taskID. </td></tr>
|
|
<tr><td class="paramname">unk0</td><td>Unknown, usually zero. </td></tr>
|
|
<tr><td class="paramname">unk1</td><td>Unknown, usually zero. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a11">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad0bc14e4abeafad9edc307dc7a2c0be0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad0bc14e4abeafad9edc307dc7a2c0be0">◆ </a></span>bossReinit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossReinit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>programID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Run the InitializeSession service cmd. </p>
|
|
<p>This is mainly for changing the programID associated with the current BOSS session. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">programID</td><td>programID to use, 0 for the current process. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a251f950dae769145729b0a8699c30dc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a251f950dae769145729b0a8699c30dc3">◆ </a></span>bossSendContextConfig()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossSendContextConfig </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structbossContext.html">bossContext</a> * </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sends the config stored in the context. </p>
|
|
<p>Used before registering a task. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname"><a class="el" href="structbossContext.html" title="BOSS context.">bossContext</a></td><td>BOSS context. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a9">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9021bd11848da0af58dff1fc4c75ad4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9021bd11848da0af58dff1fc4c75ad4">◆ </a></span>bossSendProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossSendProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td>
|
|
<td class="paramname"><em>PropertyID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>buf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send a property. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">PropertyID</td><td>PropertyID </td></tr>
|
|
<tr><td class="paramname">buf</td><td>Input buffer data. </td></tr>
|
|
<tr><td class="paramname">size</td><td>Buffer size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96574119e6fa095aec99f6bac0fadfea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96574119e6fa095aec99f6bac0fadfea">◆ </a></span>bossSetStorageInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossSetStorageInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>extdataID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>boss_size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> </td>
|
|
<td class="paramname"><em>mediaType</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the content data storage location. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">extdataID</td><td>u64 extdataID, must have the high word set to the shared-extdata value when it's for NAND. </td></tr>
|
|
<tr><td class="paramname">boss_size</td><td>Probably the max size in the extdata which BOSS can use. </td></tr>
|
|
<tr><td class="paramname">mediaType</td><td>Roughly the same as FS mediatype. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a18a7541eb4ff0ba8340bfe8177c22671"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18a7541eb4ff0ba8340bfe8177c22671">◆ </a></span>bossSetupContextDefault()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void bossSetupContextDefault </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structbossContext.html">bossContext</a> * </td>
|
|
<td class="paramname"><em>ctx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>seconds_interval</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>url</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Setup a BOSS context with the default config. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname"><a class="el" href="structbossContext.html" title="BOSS context.">bossContext</a></td><td>BOSS context. </td></tr>
|
|
<tr><td class="paramname">seconds_interval</td><td>Interval in seconds for running the task automatically. </td></tr>
|
|
<tr><td class="paramname">url</td><td>Task URL. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a8">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="affcdefc8c0ea7c04af3429ee4bb062e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#affcdefc8c0ea7c04af3429ee4bb062e3">◆ </a></span>bossStartBgImmediate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossStartBgImmediate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>taskID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Similar to bossStartTaskImmediate? </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">taskID</td><td>BOSS taskID. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a92fba4c5efe92a052c1f2feed3086cda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92fba4c5efe92a052c1f2feed3086cda">◆ </a></span>bossStartTaskImmediate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> bossStartTaskImmediate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>taskID</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Starts a task soon after running this command. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">taskID</td><td>BOSS taskID. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2boss_2source_2main_8c-example.html#a12">network/boss/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|