_interface.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13.2"/>
		<meta name="viewport" content="width=device-width, initial-scale=1"/>
		<title>Nebula: Interface</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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" />
		<link href="custom.css" rel="stylesheet" type="text/css"/>
<link href="custom_dark_theme.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">Nebula
							</div>
						</td>
					</tr>
				</tbody>
			</table>
		</div>
		<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('_interface.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div><div class="header">
  <div class="headertitle"><div class="title">Interface</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated</a></b></dt><dd>Warning: The <a class="el" href="namespace_interface.html">Interface</a> code isn't used very extensively anymore, so the comments below are legacy and not necessary. </dd></dl>
<p><a class="el" href="namespace_interface.html">Interface</a> objects offer asynchronous access to important <a class="el" href="namespace_nebula.html">Nebula</a> subsystems, like <a class="el" href="namespace_i_o.html" title="Instances of wrapped stream classes.">IO</a>, <a class="el" href="namespace_audio.html">Audio</a> and Rendering. They are the key mechanism in <a class="el" href="namespace_nebula.html">Nebula</a> to make efficient use of multicore CPUs.</p>
<p><a class="el" href="namespace_interface.html">Interface</a> objects are thread-global singletons which encapsulate an entire <a class="el" href="namespace_nebula.html">Nebula</a> subsystem. In fact each <a class="el" href="namespace_interface.html">Interface</a> object initializes a minimal <a class="el" href="namespace_nebula.html">Nebula</a> runtime which runs in a separate thread. This works great because all <a class="el" href="namespace_nebula.html">Nebula</a> singletons are thread-local (the only exception are <a class="el" href="namespace_interface.html">Interface</a> objects which are singletons across threads). So code running in a parallel thread will only see the <a class="el" href="namespace_nebula.html">Nebula</a> server objects which have been created in this thread. This parallel approach simplifies the implementation of <a class="el" href="namespace_nebula.html">Nebula</a> classes, since only the code which handles communication across threads has to be thread safe.</p>
<p>Communication with <a class="el" href="namespace_interface.html">Interface</a> objects happens through normal Message objects. To instruct an <a class="el" href="namespace_interface.html">Interface</a> object to execute a task in parallel to the main thread, just create a Message object, initialize it and send it through to the <a class="el" href="namespace_interface.html">Interface</a>'s Send() method. The Send() method will return immediately and the calling thread is free to do other stuff while the task is executing in the <a class="el" href="namespace_interface.html">Interface</a> object's worker thread. If a result is desired, the calling thread can either poll or wait for completion of the original message. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- start footer part -->
		<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
			<ul>
				<li class="navelem"><a class="el" href="foundation.html">Foundation Libraries</a></li>
				<li class="footer">
					Generated on Tue Jan 28 2025 22:43:09 for Nebula. Dark theme by <a href="http://majerle.eu" target="_new">Tilen Majerle</a>. All rights reserved.
				</li>
			</ul>
		</div>
		<script src="custom.js"></script>
	</body>
</html>