summaryrefslogtreecommitdiff
path: root/TAmPluginTemplate_8h_source.html
diff options
context:
space:
mode:
Diffstat (limited to 'TAmPluginTemplate_8h_source.html')
-rw-r--r--TAmPluginTemplate_8h_source.html132
1 files changed, 132 insertions, 0 deletions
diff --git a/TAmPluginTemplate_8h_source.html b/TAmPluginTemplate_8h_source.html
new file mode 100644
index 0000000..23e2f0b
--- /dev/null
+++ b/TAmPluginTemplate_8h_source.html
@@ -0,0 +1,132 @@
+<!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.8.11"/>
+<title>AudioManager: AudioManagerUtilities/include/TAmPluginTemplate.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="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+ $(document).ready(initResizable);
+ $(window).load(resizeHeight);
+</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>
+<script type="text/javascript">
+ $(document).ready(function() { init_search(); });
+</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">AudioManager
+ &#160;<span id="projectnumber">7.6.6</span>
+ </div>
+ <div id="projectbrief">Native Application Runtime Environment</div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.11 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+ <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
+ <li><a href="annotated.html"><span>Classes</span></a></li>
+ <li class="current"><a href="files.html"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="files.html"><span>File&#160;List</span></a></li>
+ <li><a href="globals.html"><span>File&#160;Members</span></a></li>
+ </ul>
+ </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">
+$(document).ready(function(){initNavTree('TAmPluginTemplate_8h_source.html','');});
+</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">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+ <div class="headertitle">
+<div class="title">TAmPluginTemplate.h</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="TAmPluginTemplate_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>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#ifndef PLUGINTEMPLATE_H_</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define PLUGINTEMPLATE_H_</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#include &lt;dlfcn.h&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#include &lt;libgen.h&gt;</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="CAmDltWrapper_8h.html">CAmDltWrapper.h</a>&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceam.html">am</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;{</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="namespaceam.html#abf28e5a96c232200d00df4354fd6f308"> 40</a></span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; T* <a class="code" href="namespaceam.html#abf28e5a96c232200d00df4354fd6f308">getCreateFunction</a>(<span class="keyword">const</span> std::string&amp; libname, <span class="keywordtype">void</span>*&amp; libraryHandle)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;{</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="namespaceam.html#a47d650dc91db97c1f9323b4ed5cf4fd6">logInfo</a>(<span class="stringliteral">&quot;getCreateFunction : Trying to load library with name: &quot;</span>,libname);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="comment">// cut off directories</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">char</span>* fileWithPath = <span class="keyword">const_cast&lt;</span><span class="keywordtype">char</span>*<span class="keyword">&gt;</span>(libname.c_str());</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; std::string libFileName = basename(fileWithPath);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="comment">// cut off &quot;lib&quot; in front and cut off .so end&quot;</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; std::string createFunctionName = libFileName.substr(3, libFileName.length() - 6) + <span class="stringliteral">&quot;Factory&quot;</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// open library</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; dlerror(); <span class="comment">// Clear any existing error</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; libraryHandle = dlopen(libname.c_str(), RTLD_LAZY );</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* dlopen_error = dlerror();</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">if</span> (!libraryHandle || dlopen_error)</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; {</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="code" href="namespaceam.html#ab00ba22db19413e2040c2ab246f220c6">logError</a>(<span class="stringliteral">&quot;getCreateFunction : dlopen failed&quot;</span>,dlopen_error);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="keywordflow">return</span> (0);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="comment">// get entry point from shared lib</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; dlerror(); <span class="comment">// Clear any existing error</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <span class="keyword">union</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; {</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">void</span>* voidPointer;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; T* typedPointer;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; } functionPointer;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">// Note: direct cast is not allowed by ISO C++. e.g.</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="comment">// T* createFunction = reinterpret_cast&lt;T*&gt;(dlsym(libraryHandle, createFunctionName.c_str()));</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">// compiler warning: &quot;forbids casting between pointer-to-function and pointer-to-object&quot;</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; functionPointer.voidPointer = dlsym(libraryHandle, createFunctionName.c_str());</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; T* createFunction = functionPointer.typedPointer;</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* dlsym_error = dlerror();</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordflow">if</span> (!createFunction || dlsym_error)</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; {</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <a class="code" href="namespaceam.html#ab00ba22db19413e2040c2ab246f220c6">logError</a>(<span class="stringliteral">&quot;getCreateFunction: Failed to load shared lib entry point&quot;</span>,dlsym_error);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <a class="code" href="namespaceam.html#a47d650dc91db97c1f9323b4ed5cf4fd6">logInfo</a>(<span class="stringliteral">&quot;getCreateFunction : loaded successfully plugin&quot;</span>, createFunctionName);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; <span class="keywordflow">return</span> (createFunction);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="namespaceam.html#a27cdb77ef0407689f891b463f093d89b"> 94</a></span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">class</span> T&gt; T* <a class="code" href="namespaceam.html#a27cdb77ef0407689f891b463f093d89b">getDestroyFunction</a>(<span class="keyword">const</span> std::string&amp; libname,<span class="keywordtype">void</span>* libraryHandle)</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;{</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <a class="code" href="namespaceam.html#a47d650dc91db97c1f9323b4ed5cf4fd6">logInfo</a>(<span class="stringliteral">&quot;destroy : Trying to destroy : &quot;</span>,libname);</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="comment">// cut off directories</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; <span class="keywordtype">char</span>* fileWithPath = <span class="keyword">const_cast&lt;</span><span class="keywordtype">char</span>*<span class="keyword">&gt;</span>(libname.c_str());</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; std::string libFileName = basename(fileWithPath);</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; <span class="comment">// cut off &quot;lib&quot; in front and cut off .so end&quot;</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; std::string destroyFunctionName = <span class="stringliteral">&quot;destroy&quot;</span> + libFileName.substr(3, libFileName.length() - 6);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="comment">// get entry point from shared lib</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; dlerror(); <span class="comment">// Clear any existing error</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keyword">union</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; {</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keywordtype">void</span>* voidPointer;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; T* typedPointer;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; } functionPointer;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; functionPointer.voidPointer = dlsym(libraryHandle, destroyFunctionName.c_str());</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; T* destroyFunction = functionPointer.typedPointer;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span>* dlsym_error = dlerror();</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">if</span> (!destroyFunction || dlsym_error)</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160; {</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; <a class="code" href="namespaceam.html#ab00ba22db19413e2040c2ab246f220c6">logError</a>(<span class="stringliteral">&quot;getDestroyFunction: Failed to load shared lib entry point function name=&quot;</span>,</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160; destroyFunctionName, <span class="stringliteral">&quot;error=&quot;</span>,dlsym_error);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>&#160; }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; <span class="keywordflow">else</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; {</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <a class="code" href="namespaceam.html#a47d650dc91db97c1f9323b4ed5cf4fd6">logInfo</a>(<span class="stringliteral">&quot;getDestroyFunction: loaded successfully plugin&quot;</span>, destroyFunctionName);</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; }</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">return</span> (destroyFunction);</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160;}</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160;}</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160;</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* PLUGINTEMPLATE_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="namespaceam_html"><div class="ttname"><a href="namespaceam.html">am</a></div><div class="ttdoc">A Common-API wrapper class, which loads the common-api runtime and instantiates all necessary objects...</div><div class="ttdef"><b>Definition:</b> <a href="CAmCommandReceiver_8h_source.html#l00029">CAmCommandReceiver.h:29</a></div></div>
+<div class="ttc" id="namespaceam_html_a47d650dc91db97c1f9323b4ed5cf4fd6"><div class="ttname"><a href="namespaceam.html#a47d650dc91db97c1f9323b4ed5cf4fd6">am::logInfo</a></div><div class="ttdeci">void logInfo(T value, TArgs...args)</div><div class="ttdoc">logs given values with infolevel with the default context </div><div class="ttdef"><b>Definition:</b> <a href="CAmDltWrapper_8h_source.html#l00420">CAmDltWrapper.h:420</a></div></div>
+<div class="ttc" id="CAmDltWrapper_8h_html"><div class="ttname"><a href="CAmDltWrapper_8h.html">CAmDltWrapper.h</a></div><div class="ttdoc">SPDX license identifier: MPL-2.0. </div></div>
+<div class="ttc" id="namespaceam_html_abf28e5a96c232200d00df4354fd6f308"><div class="ttname"><a href="namespaceam.html#abf28e5a96c232200d00df4354fd6f308">am::getCreateFunction</a></div><div class="ttdeci">T * getCreateFunction(const std::string &amp;libname, void *&amp;libraryHandle)</div><div class="ttdef"><b>Definition:</b> <a href="TAmPluginTemplate_8h_source.html#l00040">TAmPluginTemplate.h:40</a></div></div>
+<div class="ttc" id="namespaceam_html_ab00ba22db19413e2040c2ab246f220c6"><div class="ttname"><a href="namespaceam.html#ab00ba22db19413e2040c2ab246f220c6">am::logError</a></div><div class="ttdeci">void logError(T value, TArgs...args)</div><div class="ttdoc">logs given values with errorlevel with the default context </div><div class="ttdef"><b>Definition:</b> <a href="CAmDltWrapper_8h_source.html#l00431">CAmDltWrapper.h:431</a></div></div>
+<div class="ttc" id="namespaceam_html_a27cdb77ef0407689f891b463f093d89b"><div class="ttname"><a href="namespaceam.html#a27cdb77ef0407689f891b463f093d89b">am::getDestroyFunction</a></div><div class="ttdeci">T * getDestroyFunction(const std::string &amp;libname, void *libraryHandle)</div><div class="ttdef"><b>Definition:</b> <a href="TAmPluginTemplate_8h_source.html#l00094">TAmPluginTemplate.h:94</a></div></div>
+</div><!-- fragment --></div><!-- contents -->
+</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="dir_789817cd9c9d85c1fb6b4cda55b71a5f.html">AudioManagerUtilities</a></li><li class="navelem"><a class="el" href="dir_6fd9bed21473e96783399bf9493172af.html">include</a></li><li class="navelem"><a class="el" href="TAmPluginTemplate_8h.html">TAmPluginTemplate.h</a></li>
+ <li class="footer">Generated on Fri Feb 9 2018 14:50:29 for AudioManager by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
+ </ul>
+</div>
+</body>
+</html>