libctru/srv_8h.html
2024-11-03 20:36:34 +00:00

741 lines
40 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 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
&#160;<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&amp;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&amp;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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">srv.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Service API.
<a href="#details">More...</a></p>
<p><a href="srv_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab5a2d7fec1477e7bd90c0b91095c4842"><td class="memItemLeft" align="right" valign="top"><a id="ab5a2d7fec1477e7bd90c0b91095c4842"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#ab5a2d7fec1477e7bd90c0b91095c4842">srvInit</a> (void)</td></tr>
<tr class="memdesc:ab5a2d7fec1477e7bd90c0b91095c4842"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the service API. <br /></td></tr>
<tr class="separator:ab5a2d7fec1477e7bd90c0b91095c4842"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41a1b72e01488a9d26a94421164a971a"><td class="memItemLeft" align="right" valign="top"><a id="a41a1b72e01488a9d26a94421164a971a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a41a1b72e01488a9d26a94421164a971a">srvExit</a> (void)</td></tr>
<tr class="memdesc:a41a1b72e01488a9d26a94421164a971a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits the service API. <br /></td></tr>
<tr class="separator:a41a1b72e01488a9d26a94421164a971a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa90a9a963933fd6b1cf94b9d255057b7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#aa90a9a963933fd6b1cf94b9d255057b7">srvSetBlockingPolicy</a> (bool nonBlocking)</td></tr>
<tr class="memdesc:aa90a9a963933fd6b1cf94b9d255057b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Makes srvGetServiceHandle non-blocking for the current thread (or blocking, the default), in case of unavailable (full) requested services. <a href="srv_8h.html#aa90a9a963933fd6b1cf94b9d255057b7">More...</a><br /></td></tr>
<tr class="separator:aa90a9a963933fd6b1cf94b9d255057b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab6cdc04019fc64b219add4013e02b65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#aab6cdc04019fc64b219add4013e02b65">srvGetSessionHandle</a> (void)</td></tr>
<tr class="memdesc:aab6cdc04019fc64b219add4013e02b65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current service API session handle. <a href="srv_8h.html#aab6cdc04019fc64b219add4013e02b65">More...</a><br /></td></tr>
<tr class="separator:aab6cdc04019fc64b219add4013e02b65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a640c3109cd4bfa4bd226fae6485c2c38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a640c3109cd4bfa4bd226fae6485c2c38">srvGetServiceHandle</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *out, const char *name)</td></tr>
<tr class="memdesc:a640c3109cd4bfa4bd226fae6485c2c38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a service handle, retrieving from the environment handle list if possible. <a href="srv_8h.html#a640c3109cd4bfa4bd226fae6485c2c38">More...</a><br /></td></tr>
<tr class="separator:a640c3109cd4bfa4bd226fae6485c2c38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef5578aec324fdb8bcff2c9c8e31cab5"><td class="memItemLeft" align="right" valign="top"><a id="aef5578aec324fdb8bcff2c9c8e31cab5"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#aef5578aec324fdb8bcff2c9c8e31cab5">srvRegisterClient</a> (void)</td></tr>
<tr class="memdesc:aef5578aec324fdb8bcff2c9c8e31cab5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers the current process as a client to the service API. <br /></td></tr>
<tr class="separator:aef5578aec324fdb8bcff2c9c8e31cab5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41e92fda5c0478466bb1bc3883a7604a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a41e92fda5c0478466bb1bc3883a7604a">srvEnableNotification</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *semaphoreOut)</td></tr>
<tr class="memdesc:a41e92fda5c0478466bb1bc3883a7604a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables service notificatios, returning a notification semaphore. <a href="srv_8h.html#a41e92fda5c0478466bb1bc3883a7604a">More...</a><br /></td></tr>
<tr class="separator:a41e92fda5c0478466bb1bc3883a7604a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5af17995c0fedde9fafe17db2d58969"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#ac5af17995c0fedde9fafe17db2d58969">srvRegisterService</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *out, const char *name, int maxSessions)</td></tr>
<tr class="memdesc:ac5af17995c0fedde9fafe17db2d58969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers the current process as a service. <a href="srv_8h.html#ac5af17995c0fedde9fafe17db2d58969">More...</a><br /></td></tr>
<tr class="separator:ac5af17995c0fedde9fafe17db2d58969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a578c745aede0ed8af0541ca2dcb7fe23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a578c745aede0ed8af0541ca2dcb7fe23">srvUnregisterService</a> (const char *name)</td></tr>
<tr class="memdesc:a578c745aede0ed8af0541ca2dcb7fe23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters the current process as a service. <a href="srv_8h.html#a578c745aede0ed8af0541ca2dcb7fe23">More...</a><br /></td></tr>
<tr class="separator:a578c745aede0ed8af0541ca2dcb7fe23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f71bee85946cbfd06a963c1845fb617"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a2f71bee85946cbfd06a963c1845fb617">srvGetServiceHandleDirect</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *out, const char *name)</td></tr>
<tr class="memdesc:a2f71bee85946cbfd06a963c1845fb617"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a service handle. <a href="srv_8h.html#a2f71bee85946cbfd06a963c1845fb617">More...</a><br /></td></tr>
<tr class="separator:a2f71bee85946cbfd06a963c1845fb617"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f4cb526f8f0164a463ad912f1e31d7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a0f4cb526f8f0164a463ad912f1e31d7f">srvRegisterPort</a> (const char *name, <a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> clientHandle)</td></tr>
<tr class="memdesc:a0f4cb526f8f0164a463ad912f1e31d7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a port. <a href="srv_8h.html#a0f4cb526f8f0164a463ad912f1e31d7f">More...</a><br /></td></tr>
<tr class="separator:a0f4cb526f8f0164a463ad912f1e31d7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f6b9bc5cbb88324dffbc8a6feda4cf8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a6f6b9bc5cbb88324dffbc8a6feda4cf8">srvUnregisterPort</a> (const char *name)</td></tr>
<tr class="memdesc:a6f6b9bc5cbb88324dffbc8a6feda4cf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters a port. <a href="srv_8h.html#a6f6b9bc5cbb88324dffbc8a6feda4cf8">More...</a><br /></td></tr>
<tr class="separator:a6f6b9bc5cbb88324dffbc8a6feda4cf8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad74922815e49b701024fbf75f33c016c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#ad74922815e49b701024fbf75f33c016c">srvGetPort</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *out, const char *name)</td></tr>
<tr class="memdesc:ad74922815e49b701024fbf75f33c016c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a port handle. <a href="srv_8h.html#ad74922815e49b701024fbf75f33c016c">More...</a><br /></td></tr>
<tr class="separator:ad74922815e49b701024fbf75f33c016c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abba8cdb354ff1c96a7bed7ae01747608"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#abba8cdb354ff1c96a7bed7ae01747608">srvWaitForPortRegistered</a> (const char *name)</td></tr>
<tr class="memdesc:abba8cdb354ff1c96a7bed7ae01747608"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits for a port to be registered. <a href="srv_8h.html#abba8cdb354ff1c96a7bed7ae01747608">More...</a><br /></td></tr>
<tr class="separator:abba8cdb354ff1c96a7bed7ae01747608"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01146e340564cb9c4966ed190c080d63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a01146e340564cb9c4966ed190c080d63">srvSubscribe</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId)</td></tr>
<tr class="memdesc:a01146e340564cb9c4966ed190c080d63"><td class="mdescLeft">&#160;</td><td class="mdescRight">Subscribes to a notification. <a href="srv_8h.html#a01146e340564cb9c4966ed190c080d63">More...</a><br /></td></tr>
<tr class="separator:a01146e340564cb9c4966ed190c080d63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcbdc28b99ab3a3a88cfcef53b870df8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#abcbdc28b99ab3a3a88cfcef53b870df8">srvUnsubscribe</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId)</td></tr>
<tr class="memdesc:abcbdc28b99ab3a3a88cfcef53b870df8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unsubscribes from a notification. <a href="srv_8h.html#abcbdc28b99ab3a3a88cfcef53b870df8">More...</a><br /></td></tr>
<tr class="separator:abcbdc28b99ab3a3a88cfcef53b870df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdf8849d19334d6587f8e8c50e6e0f11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#afdf8849d19334d6587f8e8c50e6e0f11">srvReceiveNotification</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *notificationIdOut)</td></tr>
<tr class="memdesc:afdf8849d19334d6587f8e8c50e6e0f11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives a notification. <a href="srv_8h.html#afdf8849d19334d6587f8e8c50e6e0f11">More...</a><br /></td></tr>
<tr class="separator:afdf8849d19334d6587f8e8c50e6e0f11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7f9fb5af629f5c592100baf98ea57dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#aa7f9fb5af629f5c592100baf98ea57dc">srvPublishToSubscriber</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> flags)</td></tr>
<tr class="memdesc:aa7f9fb5af629f5c592100baf98ea57dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publishes a notification to subscribers. <a href="srv_8h.html#aa7f9fb5af629f5c592100baf98ea57dc">More...</a><br /></td></tr>
<tr class="separator:aa7f9fb5af629f5c592100baf98ea57dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16f6e1590d6143155d36e1b6f1df5a95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a16f6e1590d6143155d36e1b6f1df5a95">srvPublishAndGetSubscriber</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *processIdCountOut, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *processIdsOut, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId)</td></tr>
<tr class="memdesc:a16f6e1590d6143155d36e1b6f1df5a95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publishes a notification to subscribers and retrieves a list of all processes that were notified. <a href="srv_8h.html#a16f6e1590d6143155d36e1b6f1df5a95">More...</a><br /></td></tr>
<tr class="separator:a16f6e1590d6143155d36e1b6f1df5a95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bbf82393e861fa2d0bb8df277ee1338"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a5bbf82393e861fa2d0bb8df277ee1338">srvIsServiceRegistered</a> (bool *registeredOut, const char *name)</td></tr>
<tr class="memdesc:a5bbf82393e861fa2d0bb8df277ee1338"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether a service is registered. <a href="srv_8h.html#a5bbf82393e861fa2d0bb8df277ee1338">More...</a><br /></td></tr>
<tr class="separator:a5bbf82393e861fa2d0bb8df277ee1338"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71d216fb01429eaa278d7eb8330dc7bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srv_8h.html#a71d216fb01429eaa278d7eb8330dc7bc">srvIsPortRegistered</a> (bool *registeredOut, const char *name)</td></tr>
<tr class="memdesc:a71d216fb01429eaa278d7eb8330dc7bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether a port is registered. <a href="srv_8h.html#a71d216fb01429eaa278d7eb8330dc7bc">More...</a><br /></td></tr>
<tr class="separator:a71d216fb01429eaa278d7eb8330dc7bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Service API. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a41e92fda5c0478466bb1bc3883a7604a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41e92fda5c0478466bb1bc3883a7604a">&#9670;&nbsp;</a></span>srvEnableNotification()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvEnableNotification </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td>
<td class="paramname"><em>semaphoreOut</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enables service notificatios, returning a notification semaphore. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">semaphoreOut</td><td>Pointer to output the notification semaphore to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad74922815e49b701024fbf75f33c016c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad74922815e49b701024fbf75f33c016c">&#9670;&nbsp;</a></span>srvGetPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvGetPort </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a port handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to output the handle to. </td></tr>
<tr><td class="paramname">name</td><td>Name of the port. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a640c3109cd4bfa4bd226fae6485c2c38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a640c3109cd4bfa4bd226fae6485c2c38">&#9670;&nbsp;</a></span>srvGetServiceHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvGetServiceHandle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a service handle, retrieving from the environment handle list if possible. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to write the handle to. </td></tr>
<tr><td class="paramname">name</td><td>Name of the service. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if no error occured, 0xD8E06406 if the caller has no right to access the service, 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see <a class="el" href="srv_8h.html#aa90a9a963933fd6b1cf94b9d255057b7">srvSetBlockingPolicy</a>). </dd></dl>
</div>
</div>
<a id="a2f71bee85946cbfd06a963c1845fb617"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f71bee85946cbfd06a963c1845fb617">&#9670;&nbsp;</a></span>srvGetServiceHandleDirect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvGetServiceHandleDirect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a service handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to output the handle to. </td></tr>
<tr><td class="paramname">name</td><td>Name of the service.<ul>
<li></li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if no error occured, 0xD8E06406 if the caller has no right to access the service, 0xD0401834 if the requested service port is full and srvGetServiceHandle is non-blocking (see <a class="el" href="srv_8h.html#aa90a9a963933fd6b1cf94b9d255057b7">srvSetBlockingPolicy</a>). </dd></dl>
</div>
</div>
<a id="aab6cdc04019fc64b219add4013e02b65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab6cdc04019fc64b219add4013e02b65">&#9670;&nbsp;</a></span>srvGetSessionHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* srvGetSessionHandle </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the current service API session handle. </p>
<dl class="section return"><dt>Returns</dt><dd>The current service API session handle. </dd></dl>
</div>
</div>
<a id="a71d216fb01429eaa278d7eb8330dc7bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71d216fb01429eaa278d7eb8330dc7bc">&#9670;&nbsp;</a></span>srvIsPortRegistered()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvIsPortRegistered </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>registeredOut</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a port is registered. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">registeredOut</td><td>Pointer to output the registration status to. </td></tr>
<tr><td class="paramname">name</td><td>Name of the port to check. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5bbf82393e861fa2d0bb8df277ee1338"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bbf82393e861fa2d0bb8df277ee1338">&#9670;&nbsp;</a></span>srvIsServiceRegistered()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvIsServiceRegistered </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>registeredOut</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a service is registered. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">registeredOut</td><td>Pointer to output the registration status to. </td></tr>
<tr><td class="paramname">name</td><td>Name of the service to check. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a16f6e1590d6143155d36e1b6f1df5a95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16f6e1590d6143155d36e1b6f1df5a95">&#9670;&nbsp;</a></span>srvPublishAndGetSubscriber()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvPublishAndGetSubscriber </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>processIdCountOut</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>processIdsOut</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>notificationId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Publishes a notification to subscribers and retrieves a list of all processes that were notified. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">processIdCountOut</td><td>Pointer to output the number of process IDs to. </td></tr>
<tr><td class="paramname">processIdsOut</td><td>Pointer to output the process IDs to. Should have size "60 * sizeof(u32)". </td></tr>
<tr><td class="paramname">notificationId</td><td>ID of the notification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa7f9fb5af629f5c592100baf98ea57dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7f9fb5af629f5c592100baf98ea57dc">&#9670;&nbsp;</a></span>srvPublishToSubscriber()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvPublishToSubscriber </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>notificationId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Publishes a notification to subscribers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">notificationId</td><td>ID of the notification. </td></tr>
<tr><td class="paramname">flags</td><td>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) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afdf8849d19334d6587f8e8c50e6e0f11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdf8849d19334d6587f8e8c50e6e0f11">&#9670;&nbsp;</a></span>srvReceiveNotification()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvReceiveNotification </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>notificationIdOut</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receives a notification. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">notificationIdOut</td><td>Pointer to output the ID of the received notification to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0f4cb526f8f0164a463ad912f1e31d7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f4cb526f8f0164a463ad912f1e31d7f">&#9670;&nbsp;</a></span>srvRegisterPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvRegisterPort </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>&#160;</td>
<td class="paramname"><em>clientHandle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a port. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the port. </td></tr>
<tr><td class="paramname">clientHandle</td><td>Client handle of the port. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac5af17995c0fedde9fafe17db2d58969"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5af17995c0fedde9fafe17db2d58969">&#9670;&nbsp;</a></span>srvRegisterService()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvRegisterService </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>maxSessions</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers the current process as a service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out</td><td>Pointer to write the service handle to. </td></tr>
<tr><td class="paramname">name</td><td>Name of the service. </td></tr>
<tr><td class="paramname">maxSessions</td><td>Maximum number of sessions the service can handle. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa90a9a963933fd6b1cf94b9d255057b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa90a9a963933fd6b1cf94b9d255057b7">&#9670;&nbsp;</a></span>srvSetBlockingPolicy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void srvSetBlockingPolicy </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>nonBlocking</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes srvGetServiceHandle non-blocking for the current thread (or blocking, the default), in case of unavailable (full) requested services. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">blocking</td><td>Whether srvGetServiceHandle should be non-blocking. srvGetServiceHandle will always block if the service hasn't been registered yet, use srvIsServiceRegistered to check whether that is the case or not. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a01146e340564cb9c4966ed190c080d63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01146e340564cb9c4966ed190c080d63">&#9670;&nbsp;</a></span>srvSubscribe()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvSubscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>notificationId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Subscribes to a notification. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">notificationId</td><td>ID of the notification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6f6b9bc5cbb88324dffbc8a6feda4cf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f6b9bc5cbb88324dffbc8a6feda4cf8">&#9670;&nbsp;</a></span>srvUnregisterPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvUnregisterPort </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregisters a port. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the port. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a578c745aede0ed8af0541ca2dcb7fe23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a578c745aede0ed8af0541ca2dcb7fe23">&#9670;&nbsp;</a></span>srvUnregisterService()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvUnregisterService </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregisters the current process as a service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the service. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abcbdc28b99ab3a3a88cfcef53b870df8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcbdc28b99ab3a3a88cfcef53b870df8">&#9670;&nbsp;</a></span>srvUnsubscribe()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvUnsubscribe </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>notificationId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unsubscribes from a notification. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">notificationId</td><td>ID of the notification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abba8cdb354ff1c96a7bed7ae01747608"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abba8cdb354ff1c96a7bed7ae01747608">&#9670;&nbsp;</a></span>srvWaitForPortRegistered()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> srvWaitForPortRegistered </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Waits for a port to be registered. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the port to wait for registration. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>