311 lines
15 KiB
HTML
311 lines
15 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" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Base Module: Steinberg::Singleton Namespace 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>
|
|
<script type="text/javascript" src="clipboard.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="smtg_extra.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">Base Module<span id="projectnumber"> VST 3.8</span>
|
|
</div>
|
|
<div id="projectbrief">SDK for developing VST plug-in</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&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
|
$(function(){initNavTree('namespaceSteinberg_1_1Singleton.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 class="header">
|
|
<div class="summary">
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">Steinberg::Singleton Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Automatic creation and destruction of singleton instances.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:ae71bce85324f37d598620c2adc38733f" id="r_ae71bce85324f37d598620c2adc38733f"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae71bce85324f37d598620c2adc38733f">ObjectVector</a> = std::vector<<a class="el" href="classSteinberg_1_1FObject.html">FObject</a>**></td></tr>
|
|
<tr class="separator:ae71bce85324f37d598620c2adc38733f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a84acfabb69fd8f78cc6afad4301357b7" id="r_a84acfabb69fd8f78cc6afad4301357b7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a84acfabb69fd8f78cc6afad4301357b7">isTerminated</a> ()</td></tr>
|
|
<tr class="memdesc:a84acfabb69fd8f78cc6afad4301357b7"><td class="mdescLeft"> </td><td class="mdescRight">Returns true when singleton instances were already released. <br /></td></tr>
|
|
<tr class="separator:a84acfabb69fd8f78cc6afad4301357b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1612cf2b7b00489ee4cd0af7999ff7ac" id="r_a1612cf2b7b00489ee4cd0af7999ff7ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1612cf2b7b00489ee4cd0af7999ff7ac">lockRegister</a> ()</td></tr>
|
|
<tr class="memdesc:a1612cf2b7b00489ee4cd0af7999ff7ac"><td class="mdescLeft"> </td><td class="mdescRight">lock and unlock the singleton registration for multi-threading safety <br /></td></tr>
|
|
<tr class="separator:a1612cf2b7b00489ee4cd0af7999ff7ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2aad80bf0469cb9153a7666f2b2b4817" id="r_a2aad80bf0469cb9153a7666f2b2b4817"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2aad80bf0469cb9153a7666f2b2b4817">unlockRegister</a> ()</td></tr>
|
|
<tr class="separator:a2aad80bf0469cb9153a7666f2b2b4817"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6e6c857d3abf9d8ef37ef8d465c9977" id="r_ad6e6c857d3abf9d8ef37ef8d465c9977"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad6e6c857d3abf9d8ef37ef8d465c9977">registerInstance</a> (<a class="el" href="classSteinberg_1_1FObject.html">FObject</a> **o)</td></tr>
|
|
<tr class="memdesc:ad6e6c857d3abf9d8ef37ef8d465c9977"><td class="mdescLeft"> </td><td class="mdescRight">registers an instance (type <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a>) <br /></td></tr>
|
|
<tr class="separator:ad6e6c857d3abf9d8ef37ef8d465c9977"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:ab5cb5c38a31d778cf922b01947589311" id="r_ab5cb5c38a31d778cf922b01947589311"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ae71bce85324f37d598620c2adc38733f">ObjectVector</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab5cb5c38a31d778cf922b01947589311">singletonInstances</a> = nullptr</td></tr>
|
|
<tr class="separator:ab5cb5c38a31d778cf922b01947589311"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae52f18a708ab305abe54c48ffc1c9840" id="r_ae52f18a708ab305abe54c48ffc1c9840"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae52f18a708ab305abe54c48ffc1c9840">singletonsTerminated</a> = false</td></tr>
|
|
<tr class="separator:ae52f18a708ab305abe54c48ffc1c9840"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac67df8722321fe3f07d688a9710006cc" id="r_ac67df8722321fe3f07d688a9710006cc"><td class="memItemLeft" align="right" valign="top">Steinberg::Base::Thread::FLock * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac67df8722321fe3f07d688a9710006cc">singletonsLock</a></td></tr>
|
|
<tr class="separator:ac67df8722321fe3f07d688a9710006cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0aba916420413107b7921c376fa714b" id="r_ad0aba916420413107b7921c376fa714b"><td class="memItemLeft" align="right" valign="top">struct Steinberg::Singleton::Deleter </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0aba916420413107b7921c376fa714b">deleter</a></td></tr>
|
|
<tr class="separator:ad0aba916420413107b7921c376fa714b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Automatic creation and destruction of singleton instances. </p>
|
|
</div><h2 class="groupheader">Typedef Documentation</h2>
|
|
<a id="ae71bce85324f37d598620c2adc38733f" name="ae71bce85324f37d598620c2adc38733f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae71bce85324f37d598620c2adc38733f">◆ </a></span>ObjectVector</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">using <a class="el" href="#ae71bce85324f37d598620c2adc38733f">ObjectVector</a> = std::vector<<a class="el" href="classSteinberg_1_1FObject.html">FObject</a>**></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a84acfabb69fd8f78cc6afad4301357b7" name="a84acfabb69fd8f78cc6afad4301357b7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84acfabb69fd8f78cc6afad4301357b7">◆ </a></span>isTerminated()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool isTerminated </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true when singleton instances were already released. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1612cf2b7b00489ee4cd0af7999ff7ac" name="a1612cf2b7b00489ee4cd0af7999ff7ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1612cf2b7b00489ee4cd0af7999ff7ac">◆ </a></span>lockRegister()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void lockRegister </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>lock and unlock the singleton registration for multi-threading safety </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2aad80bf0469cb9153a7666f2b2b4817" name="a2aad80bf0469cb9153a7666f2b2b4817"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2aad80bf0469cb9153a7666f2b2b4817">◆ </a></span>unlockRegister()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void unlockRegister </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad6e6c857d3abf9d8ef37ef8d465c9977" name="ad6e6c857d3abf9d8ef37ef8d465c9977"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad6e6c857d3abf9d8ef37ef8d465c9977">◆ </a></span>registerInstance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void registerInstance </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classSteinberg_1_1FObject.html">FObject</a> **</td> <td class="paramname"><span class="paramname"><em>o</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>registers an instance (type <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a>) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="ab5cb5c38a31d778cf922b01947589311" name="ab5cb5c38a31d778cf922b01947589311"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab5cb5c38a31d778cf922b01947589311">◆ </a></span>singletonInstances</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="#ae71bce85324f37d598620c2adc38733f">ObjectVector</a>* singletonInstances = nullptr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae52f18a708ab305abe54c48ffc1c9840" name="ae52f18a708ab305abe54c48ffc1c9840"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae52f18a708ab305abe54c48ffc1c9840">◆ </a></span>singletonsTerminated</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool singletonsTerminated = false</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac67df8722321fe3f07d688a9710006cc" name="ac67df8722321fe3f07d688a9710006cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac67df8722321fe3f07d688a9710006cc">◆ </a></span>singletonsLock</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Steinberg::Base::Thread::FLock* singletonsLock</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad0aba916420413107b7921c376fa714b" name="ad0aba916420413107b7921c376fa714b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad0aba916420413107b7921c376fa714b">◆ </a></span>deleter</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">struct Steinberg::Singleton::Deleter deleter</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<html>
|
|
<head>
|
|
<title>Empty</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<meta name="Author" content="Steinberg">
|
|
</head>
|
|
<body>
|
|
<br/>
|
|
<hr width="100%" size="2" align="left" />
|
|
<div align=right>
|
|
Copyright ©<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
|
|
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
|
|
</div>
|
|
<script>
|
|
document.querySelector("#year").textContent = new Date().getFullYear();
|
|
</script>
|
|
</body>
|
|
</html>
|