245 lines
37 KiB
HTML
245 lines
37 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/srv.h Source File</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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">srv.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="srv_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file srv.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief Service API.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/// Initializes the service API.</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="srv_8h.html#ab5a2d7fec1477e7bd90c0b91095c4842"> 8</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#ab5a2d7fec1477e7bd90c0b91095c4842">srvInit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/// Exits the service API.</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="srv_8h.html#a41a1b72e01488a9d26a94421164a971a"> 11</a></span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="srv_8h.html#a41a1b72e01488a9d26a94421164a971a">srvExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * @brief Makes srvGetServiceHandle non-blocking for the current thread (or blocking, the default), in case of unavailable (full) requested services.</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * @param blocking Whether srvGetServiceHandle should be non-blocking.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * srvGetServiceHandle will always block if the service hasn't been registered yet,</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * use srvIsServiceRegistered to check whether that is the case or not.</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="srv_8h.html#aa90a9a963933fd6b1cf94b9d255057b7"> 19</a></span> <span class="keywordtype">void</span> <a class="code" href="srv_8h.html#aa90a9a963933fd6b1cf94b9d255057b7">srvSetBlockingPolicy</a>(<span class="keywordtype">bool</span> nonBlocking);</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @brief Gets the current service API session handle.</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @return The current service API session handle.</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="srv_8h.html#aab6cdc04019fc64b219add4013e02b65"> 25</a></span> <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *<a class="code" href="srv_8h.html#aab6cdc04019fc64b219add4013e02b65">srvGetSessionHandle</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * @brief Retrieves a service handle, retrieving from the environment handle list if possible.</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * @param out Pointer to write the handle to.</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * @param name Name of the service.</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * @return 0 if no error occured,</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * 0xD8E06406 if the caller has no right to access the service,</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see @ref srvSetBlockingPolicy).</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="srv_8h.html#a640c3109cd4bfa4bd226fae6485c2c38"> 35</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a640c3109cd4bfa4bd226fae6485c2c38">srvGetServiceHandle</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* out, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/// Registers the current process as a client to the service API.</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="srv_8h.html#aef5578aec324fdb8bcff2c9c8e31cab5"> 38</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#aef5578aec324fdb8bcff2c9c8e31cab5">srvRegisterClient</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @brief Enables service notificatios, returning a notification semaphore.</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @param semaphoreOut Pointer to output the notification semaphore to.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="srv_8h.html#a41e92fda5c0478466bb1bc3883a7604a"> 44</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a41e92fda5c0478466bb1bc3883a7604a">srvEnableNotification</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* semaphoreOut);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @brief Registers the current process as a service.</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @param out Pointer to write the service handle to.</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param name Name of the service.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @param maxSessions Maximum number of sessions the service can handle.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="srv_8h.html#ac5af17995c0fedde9fafe17db2d58969"> 52</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#ac5af17995c0fedde9fafe17db2d58969">srvRegisterService</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* out, <span class="keyword">const</span> <span class="keywordtype">char</span>* name, <span class="keywordtype">int</span> maxSessions);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @brief Unregisters the current process as a service.</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @param name Name of the service.</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="srv_8h.html#a578c745aede0ed8af0541ca2dcb7fe23"> 58</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a578c745aede0ed8af0541ca2dcb7fe23">srvUnregisterService</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @brief Retrieves a service handle.</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @param out Pointer to output the handle to.</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @param name Name of the service.</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * * @return 0 if no error occured,</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * 0xD8E06406 if the caller has no right to access the service,</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see @ref srvSetBlockingPolicy).</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="srv_8h.html#a2f71bee85946cbfd06a963c1845fb617"> 68</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a2f71bee85946cbfd06a963c1845fb617">srvGetServiceHandleDirect</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* out, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @brief Registers a port.</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @param name Name of the port.</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * @param clientHandle Client handle of the port.</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="srv_8h.html#a0f4cb526f8f0164a463ad912f1e31d7f"> 75</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a0f4cb526f8f0164a463ad912f1e31d7f">srvRegisterPort</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> clientHandle);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @brief Unregisters a port.</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * @param name Name of the port.</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="srv_8h.html#a6f6b9bc5cbb88324dffbc8a6feda4cf8"> 81</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a6f6b9bc5cbb88324dffbc8a6feda4cf8">srvUnregisterPort</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * @brief Retrieves a port handle.</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * @param out Pointer to output the handle to.</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @param name Name of the port.</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="srv_8h.html#ad74922815e49b701024fbf75f33c016c"> 88</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#ad74922815e49b701024fbf75f33c016c">srvGetPort</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* out, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * @brief Waits for a port to be registered.</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * @param name Name of the port to wait for registration.</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="srv_8h.html#abba8cdb354ff1c96a7bed7ae01747608"> 94</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#abba8cdb354ff1c96a7bed7ae01747608">srvWaitForPortRegistered</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @brief Subscribes to a notification.</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @param notificationId ID of the notification.</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="srv_8h.html#a01146e340564cb9c4966ed190c080d63"> 100</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a01146e340564cb9c4966ed190c080d63">srvSubscribe</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId);</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @brief Unsubscribes from a notification.</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @param notificationId ID of the notification.</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="srv_8h.html#abcbdc28b99ab3a3a88cfcef53b870df8"> 106</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#abcbdc28b99ab3a3a88cfcef53b870df8">srvUnsubscribe</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId);</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @brief Receives a notification.</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @param notificationIdOut Pointer to output the ID of the received notification to.</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="srv_8h.html#afdf8849d19334d6587f8e8c50e6e0f11"> 112</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#afdf8849d19334d6587f8e8c50e6e0f11">srvReceiveNotification</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* notificationIdOut);</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * @brief Publishes a notification to subscribers.</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * @param notificationId ID of the notification.</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @param flags Flags to publish with. (bit 0 = only fire if not fired, bit 1 = do not report an error if there are more than 16 pending notifications)</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="srv_8h.html#aa7f9fb5af629f5c592100baf98ea57dc"> 119</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#aa7f9fb5af629f5c592100baf98ea57dc">srvPublishToSubscriber</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> flags);</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * @brief Publishes a notification to subscribers and retrieves a list of all processes that were notified.</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @param processIdCountOut Pointer to output the number of process IDs to.</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @param processIdsOut Pointer to output the process IDs to. Should have size "60 * sizeof(u32)".</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @param notificationId ID of the notification.</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="srv_8h.html#a16f6e1590d6143155d36e1b6f1df5a95"> 127</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a16f6e1590d6143155d36e1b6f1df5a95">srvPublishAndGetSubscriber</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* processIdCountOut, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>* processIdsOut, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId);</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @brief Checks whether a service is registered.</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * @param registeredOut Pointer to output the registration status to.</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @param name Name of the service to check.</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="srv_8h.html#a5bbf82393e861fa2d0bb8df277ee1338"> 134</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a5bbf82393e861fa2d0bb8df277ee1338">srvIsServiceRegistered</a>(<span class="keywordtype">bool</span>* registeredOut, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * @brief Checks whether a port is registered.</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * @param registeredOut Pointer to output the registration status to.</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @param name Name of the port to check.</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="srv_8h.html#a71d216fb01429eaa278d7eb8330dc7bc"> 141</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="srv_8h.html#a71d216fb01429eaa278d7eb8330dc7bc">srvIsPortRegistered</a>(<span class="keywordtype">bool</span>* registeredOut, <span class="keyword">const</span> <span class="keywordtype">char</span>* name);</div>
|
|
<div class="ttc" id="asrv_8h_html_a01146e340564cb9c4966ed190c080d63"><div class="ttname"><a href="srv_8h.html#a01146e340564cb9c4966ed190c080d63">srvSubscribe</a></div><div class="ttdeci">Result srvSubscribe(u32 notificationId)</div><div class="ttdoc">Subscribes to a notification.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a0f4cb526f8f0164a463ad912f1e31d7f"><div class="ttname"><a href="srv_8h.html#a0f4cb526f8f0164a463ad912f1e31d7f">srvRegisterPort</a></div><div class="ttdeci">Result srvRegisterPort(const char *name, Handle clientHandle)</div><div class="ttdoc">Registers a port.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a16f6e1590d6143155d36e1b6f1df5a95"><div class="ttname"><a href="srv_8h.html#a16f6e1590d6143155d36e1b6f1df5a95">srvPublishAndGetSubscriber</a></div><div class="ttdeci">Result srvPublishAndGetSubscriber(u32 *processIdCountOut, u32 *processIdsOut, u32 notificationId)</div><div class="ttdoc">Publishes a notification to subscribers and retrieves a list of all processes that were notified.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a2f71bee85946cbfd06a963c1845fb617"><div class="ttname"><a href="srv_8h.html#a2f71bee85946cbfd06a963c1845fb617">srvGetServiceHandleDirect</a></div><div class="ttdeci">Result srvGetServiceHandleDirect(Handle *out, const char *name)</div><div class="ttdoc">Retrieves a service handle.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a41a1b72e01488a9d26a94421164a971a"><div class="ttname"><a href="srv_8h.html#a41a1b72e01488a9d26a94421164a971a">srvExit</a></div><div class="ttdeci">void srvExit(void)</div><div class="ttdoc">Exits the service API.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a41e92fda5c0478466bb1bc3883a7604a"><div class="ttname"><a href="srv_8h.html#a41e92fda5c0478466bb1bc3883a7604a">srvEnableNotification</a></div><div class="ttdeci">Result srvEnableNotification(Handle *semaphoreOut)</div><div class="ttdoc">Enables service notificatios, returning a notification semaphore.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a578c745aede0ed8af0541ca2dcb7fe23"><div class="ttname"><a href="srv_8h.html#a578c745aede0ed8af0541ca2dcb7fe23">srvUnregisterService</a></div><div class="ttdeci">Result srvUnregisterService(const char *name)</div><div class="ttdoc">Unregisters the current process as a service.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a5bbf82393e861fa2d0bb8df277ee1338"><div class="ttname"><a href="srv_8h.html#a5bbf82393e861fa2d0bb8df277ee1338">srvIsServiceRegistered</a></div><div class="ttdeci">Result srvIsServiceRegistered(bool *registeredOut, const char *name)</div><div class="ttdoc">Checks whether a service is registered.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a640c3109cd4bfa4bd226fae6485c2c38"><div class="ttname"><a href="srv_8h.html#a640c3109cd4bfa4bd226fae6485c2c38">srvGetServiceHandle</a></div><div class="ttdeci">Result srvGetServiceHandle(Handle *out, const char *name)</div><div class="ttdoc">Retrieves a service handle, retrieving from the environment handle list if possible.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a6f6b9bc5cbb88324dffbc8a6feda4cf8"><div class="ttname"><a href="srv_8h.html#a6f6b9bc5cbb88324dffbc8a6feda4cf8">srvUnregisterPort</a></div><div class="ttdeci">Result srvUnregisterPort(const char *name)</div><div class="ttdoc">Unregisters a port.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_a71d216fb01429eaa278d7eb8330dc7bc"><div class="ttname"><a href="srv_8h.html#a71d216fb01429eaa278d7eb8330dc7bc">srvIsPortRegistered</a></div><div class="ttdeci">Result srvIsPortRegistered(bool *registeredOut, const char *name)</div><div class="ttdoc">Checks whether a port is registered.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_aa7f9fb5af629f5c592100baf98ea57dc"><div class="ttname"><a href="srv_8h.html#aa7f9fb5af629f5c592100baf98ea57dc">srvPublishToSubscriber</a></div><div class="ttdeci">Result srvPublishToSubscriber(u32 notificationId, u32 flags)</div><div class="ttdoc">Publishes a notification to subscribers.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_aa90a9a963933fd6b1cf94b9d255057b7"><div class="ttname"><a href="srv_8h.html#aa90a9a963933fd6b1cf94b9d255057b7">srvSetBlockingPolicy</a></div><div class="ttdeci">void srvSetBlockingPolicy(bool nonBlocking)</div><div class="ttdoc">Makes srvGetServiceHandle non-blocking for the current thread (or blocking, the default),...</div></div>
|
|
<div class="ttc" id="asrv_8h_html_aab6cdc04019fc64b219add4013e02b65"><div class="ttname"><a href="srv_8h.html#aab6cdc04019fc64b219add4013e02b65">srvGetSessionHandle</a></div><div class="ttdeci">Handle * srvGetSessionHandle(void)</div><div class="ttdoc">Gets the current service API session handle.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_ab5a2d7fec1477e7bd90c0b91095c4842"><div class="ttname"><a href="srv_8h.html#ab5a2d7fec1477e7bd90c0b91095c4842">srvInit</a></div><div class="ttdeci">Result srvInit(void)</div><div class="ttdoc">Initializes the service API.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_abba8cdb354ff1c96a7bed7ae01747608"><div class="ttname"><a href="srv_8h.html#abba8cdb354ff1c96a7bed7ae01747608">srvWaitForPortRegistered</a></div><div class="ttdeci">Result srvWaitForPortRegistered(const char *name)</div><div class="ttdoc">Waits for a port to be registered.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_abcbdc28b99ab3a3a88cfcef53b870df8"><div class="ttname"><a href="srv_8h.html#abcbdc28b99ab3a3a88cfcef53b870df8">srvUnsubscribe</a></div><div class="ttdeci">Result srvUnsubscribe(u32 notificationId)</div><div class="ttdoc">Unsubscribes from a notification.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_ac5af17995c0fedde9fafe17db2d58969"><div class="ttname"><a href="srv_8h.html#ac5af17995c0fedde9fafe17db2d58969">srvRegisterService</a></div><div class="ttdeci">Result srvRegisterService(Handle *out, const char *name, int maxSessions)</div><div class="ttdoc">Registers the current process as a service.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_ad74922815e49b701024fbf75f33c016c"><div class="ttname"><a href="srv_8h.html#ad74922815e49b701024fbf75f33c016c">srvGetPort</a></div><div class="ttdeci">Result srvGetPort(Handle *out, const char *name)</div><div class="ttdoc">Retrieves a port handle.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_aef5578aec324fdb8bcff2c9c8e31cab5"><div class="ttname"><a href="srv_8h.html#aef5578aec324fdb8bcff2c9c8e31cab5">srvRegisterClient</a></div><div class="ttdeci">Result srvRegisterClient(void)</div><div class="ttdoc">Registers the current process as a client to the service API.</div></div>
|
|
<div class="ttc" id="asrv_8h_html_afdf8849d19334d6587f8e8c50e6e0f11"><div class="ttname"><a href="srv_8h.html#afdf8849d19334d6587f8e8c50e6e0f11">srvReceiveNotification</a></div><div class="ttdeci">Result srvReceiveNotification(u32 *notificationIdOut)</div><div class="ttdoc">Receives a notification.</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
|
|
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
</div><!-- fragment --></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>
|