diff options
Diffstat (limited to 'docs/classam_1_1CAmCommonAPIWrapper.html')
| -rw-r--r-- | docs/classam_1_1CAmCommonAPIWrapper.html | 654 |
1 files changed, 654 insertions, 0 deletions
diff --git a/docs/classam_1_1CAmCommonAPIWrapper.html b/docs/classam_1_1CAmCommonAPIWrapper.html new file mode 100644 index 0000000..d904f6b --- /dev/null +++ b/docs/classam_1_1CAmCommonAPIWrapper.html @@ -0,0 +1,654 @@ +<!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.6"/> +<title>AudioManager: am::CAmCommonAPIWrapper Class 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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="padding-left: 0.5em;"> + <div id="projectname">AudioManager +  <span id="projectnumber">7.5.11</span> + </div> + <div id="projectbrief">Native Application Runtime Environment</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<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 Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><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="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class 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('classam_1_1CAmCommonAPIWrapper.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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="classam_1_1CAmCommonAPIWrapper-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">am::CAmCommonAPIWrapper Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:afe7cb834bf23daa9eee094a27b540405"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#afe7cb834bf23daa9eee094a27b540405">~CAmCommonAPIWrapper</a> ()</td></tr> +<tr class="separator:afe7cb834bf23daa9eee094a27b540405"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a195f70d2c9cbd92d4cee4494c2e9c622"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#a195f70d2c9cbd92d4cee4494c2e9c622">getSocketHandler</a> () const </td></tr> +<tr class="memdesc:a195f70d2c9cbd92d4cee4494c2e9c622"><td class="mdescLeft"> </td><td class="mdescRight">Getter for the socket handler. <a href="#a195f70d2c9cbd92d4cee4494c2e9c622">More...</a><br/></td></tr> +<tr class="separator:a195f70d2c9cbd92d4cee4494c2e9c622"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad68e664c43be933aafb2ca437a4aa1e0"><td class="memTemplParams" colspan="2">template<class TStubImp > </td></tr> +<tr class="memitem:ad68e664c43be933aafb2ca437a4aa1e0"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#ad68e664c43be933aafb2ca437a4aa1e0">registerService</a> (const std::shared_ptr< TStubImp > &shStub, const std::string &domain, const std::string &instance)</td></tr> +<tr class="memdesc:ad68e664c43be933aafb2ca437a4aa1e0"><td class="mdescLeft"> </td><td class="mdescRight">Register stub objects. <a href="#ad68e664c43be933aafb2ca437a4aa1e0">More...</a><br/></td></tr> +<tr class="separator:ad68e664c43be933aafb2ca437a4aa1e0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a67dbc668563d1c424baeda2c04652472"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#a67dbc668563d1c424baeda2c04652472">unregisterService</a> (const std::string &domain, const std::string &interface, const std::string &instance)</td></tr> +<tr class="memdesc:a67dbc668563d1c424baeda2c04652472"><td class="mdescLeft"> </td><td class="mdescRight">Unregister stub objects. <a href="#a67dbc668563d1c424baeda2c04652472">More...</a><br/></td></tr> +<tr class="separator:a67dbc668563d1c424baeda2c04652472"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a182152e2b7009015485cde7c3a5185cb"><td class="memTemplParams" colspan="2">template<class TStubImp > </td></tr> +<tr class="memitem:a182152e2b7009015485cde7c3a5185cb"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#a182152e2b7009015485cde7c3a5185cb">__attribute__</a> ((deprecated)) registerStub(const std</td></tr> +<tr class="memdesc:a182152e2b7009015485cde7c3a5185cb"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated method. <a href="#a182152e2b7009015485cde7c3a5185cb">More...</a><br/></td></tr> +<tr class="separator:a182152e2b7009015485cde7c3a5185cb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abb99a5a00db571541d7dfb9f48551635"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#abb99a5a00db571541d7dfb9f48551635">__attribute__</a> ((deprecated)) unregisterStub(const std</td></tr> +<tr class="memdesc:abb99a5a00db571541d7dfb9f48551635"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated method. <a href="#abb99a5a00db571541d7dfb9f48551635">More...</a><br/></td></tr> +<tr class="separator:abb99a5a00db571541d7dfb9f48551635"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3dd06d017bd317e54e07a54cdcd01864"><td class="memTemplParams" colspan="2">template<template< typename...> class ProxyClass, typename... AttributeExtensions> </td></tr> +<tr class="memitem:a3dd06d017bd317e54e07a54cdcd01864"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< ProxyClass<br class="typebreak"/> +< AttributeExtensions...> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#a3dd06d017bd317e54e07a54cdcd01864">buildProxy</a> (const std::string &domain, const std::string &instance)</td></tr> +<tr class="memdesc:a3dd06d017bd317e54e07a54cdcd01864"><td class="mdescLeft"> </td><td class="mdescRight">Build proxy objects. <a href="#a3dd06d017bd317e54e07a54cdcd01864">More...</a><br/></td></tr> +<tr class="separator:a3dd06d017bd317e54e07a54cdcd01864"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad8814b540318b8b42b76e03fe5e32d29"><td class="memTemplParams" colspan="2">template<template< typename...> class ProxyClass, typename... AttributeExtensions> </td></tr> +<tr class="memitem:ad8814b540318b8b42b76e03fe5e32d29"><td class="memTemplItemLeft" align="right" valign="top">std::shared_ptr< ProxyClass<br class="typebreak"/> +< AttributeExtensions...> > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#ad8814b540318b8b42b76e03fe5e32d29">__attribute__</a> ((deprecated)) <a class="el" href="classam_1_1CAmCommonAPIWrapper.html#a3dd06d017bd317e54e07a54cdcd01864">buildProxy</a>(const std</td></tr> +<tr class="memdesc:ad8814b540318b8b42b76e03fe5e32d29"><td class="mdescLeft"> </td><td class="mdescRight">Deprecated method. <a href="#ad8814b540318b8b42b76e03fe5e32d29">More...</a><br/></td></tr> +<tr class="separator:ad8814b540318b8b42b76e03fe5e32d29"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:ae0b4c69ab7cba9734f45306c15a2e0ce"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classam_1_1CAmCommonAPIWrapper.html">CAmCommonAPIWrapper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#ae0b4c69ab7cba9734f45306c15a2e0ce">getInstance</a> ()</td></tr> +<tr class="memdesc:ae0b4c69ab7cba9734f45306c15a2e0ce"><td class="mdescLeft"> </td><td class="mdescRight">Returns an already instantiated object. <a href="#ae0b4c69ab7cba9734f45306c15a2e0ce">More...</a><br/></td></tr> +<tr class="separator:ae0b4c69ab7cba9734f45306c15a2e0ce"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae43aaeefe9f50d258e8e2ed74cdebb0d"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#ae43aaeefe9f50d258e8e2ed74cdebb0d">deleteInstance</a> ()</td></tr> +<tr class="memdesc:ae43aaeefe9f50d258e8e2ed74cdebb0d"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the instanciated object. <a href="#ae43aaeefe9f50d258e8e2ed74cdebb0d">More...</a><br/></td></tr> +<tr class="separator:ae43aaeefe9f50d258e8e2ed74cdebb0d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a008a684395e96b7204e726b6c835fc7b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classam_1_1CAmCommonAPIWrapper.html">CAmCommonAPIWrapper</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#a008a684395e96b7204e726b6c835fc7b">instantiateOnce</a> (<a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> *socketHandler, const std::string &applicationName="")</td></tr> +<tr class="memdesc:a008a684395e96b7204e726b6c835fc7b"><td class="mdescLeft"> </td><td class="mdescRight">Creates a singleton instance attached to the provided socket handler object. <a href="#a008a684395e96b7204e726b6c835fc7b">More...</a><br/></td></tr> +<tr class="separator:a008a684395e96b7204e726b6c835fc7b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:afc1d51651edcb3a70dc6adef82b537b6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html#afc1d51651edcb3a70dc6adef82b537b6">CAmCommonAPIWrapper</a> (<a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> *socketHandler, const std::string &applicationName="")</td></tr> +<tr class="separator:afc1d51651edcb3a70dc6adef82b537b6"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"> +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8h_source.html#l00049">49</a> of file <a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="afc1d51651edcb3a70dc6adef82b537b6"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">am::CAmCommonAPIWrapper::CAmCommonAPIWrapper </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> * </td> + <td class="paramname"><em>socketHandler</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>applicationName</em> = <code>""</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html#l00039">39</a> of file <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html">CAmCommonAPIWrapper.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="afe7cb834bf23daa9eee094a27b540405"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">am::CAmCommonAPIWrapper::~CAmCommonAPIWrapper </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html#l00073">73</a> of file <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html">CAmCommonAPIWrapper.cpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a182152e2b7009015485cde7c3a5185cb"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class TStubImp > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool am::CAmCommonAPIWrapper::__attribute__ </td> + <td>(</td> + <td class="paramtype">(deprecated) </td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Deprecated method. </p> +<p>Instead you should use bool <a class="el" href="classam_1_1CAmCommonAPIWrapper.html#ad68e664c43be933aafb2ca437a4aa1e0" title="Register stub objects. ">registerService(const std::shared_ptr<TStubImp> & shStub, const std::string & domain, const std::string & instance)</a>.</p> +<p>Register stub objects.</p> +<p>Example: std::shared_ptr<ConcreteStubClass> aStub; registerService( aStub, "local:com.your_company.interface_name:com.your_company.instance_name");</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">shStub</td><td>Shared pointer to a stub instance </td></tr> + <tr><td class="paramname">address</td><td>Complete common-api address as example "local:com.your_company.interface_name:com.your_company.instance_name" </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8h_source.html#l00195">195</a> of file <a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>.</p> + +</div> +</div> +<a class="anchor" id="abb99a5a00db571541d7dfb9f48551635"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool am::CAmCommonAPIWrapper::__attribute__ </td> + <td>(</td> + <td class="paramtype">(deprecated) </td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Deprecated method. </p> +<p>Instead you should use bool <a class="el" href="classam_1_1CAmCommonAPIWrapper.html#a67dbc668563d1c424baeda2c04652472" title="Unregister stub objects. ">unregisterService(const std::string &domain, const std::string &interface, const std::string &instance)</a>.</p> +<p>Unregister stub objects.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">address</td><td>Complete common-api address as example "local:com.your_company.interface_name:com.your_company.instance_name" </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8h_source.html#l00211">211</a> of file <a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ad8814b540318b8b42b76e03fe5e32d29"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<template< typename...> class ProxyClass, typename... AttributeExtensions> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<ProxyClass<AttributeExtensions...> > am::CAmCommonAPIWrapper::__attribute__ </td> + <td>(</td> + <td class="paramtype">(deprecated) </td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Deprecated method. </p> +<p>Instead you should use <a class="el" href="classam_1_1CAmCommonAPIWrapper.html#a3dd06d017bd317e54e07a54cdcd01864" title="Build proxy objects. ">buildProxy(const std::string &domain, const std::string &instance)</a>.</p> +<p>Build proxy objects. Example: std::shared_ptr<AProxyClass<>> aProxy = buildProxy<AProxyClass>("local:com.your_company.interface_name:com.your_company.instance_name");</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">address</td><td>Complete common-api address as example "local:com.your_company.interface_name:com.your_company.instance_name"</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A proxy object. </dd></dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8h_source.html#l00266">266</a> of file <a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a3dd06d017bd317e54e07a54cdcd01864"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<template< typename...> class ProxyClass, typename... AttributeExtensions> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<ProxyClass<AttributeExtensions...> > am::CAmCommonAPIWrapper::buildProxy </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>domain</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>instance</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Build proxy objects. </p> +<p>Example: std::shared_ptr<AProxyClass<>> aProxy = buildProxy<AProxyClass>("local", "com.your_company.instance_name");</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">domain</td><td>A string with the domain name, usually "local" </td></tr> + <tr><td class="paramname">instance</td><td>Common-api instance string as example "com.your_company.instance_name"</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A proxy object. </dd></dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8h_source.html#l00249">249</a> of file <a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>.</p> + +</div> +</div> +<a class="anchor" id="ae43aaeefe9f50d258e8e2ed74cdebb0d"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void am::CAmCommonAPIWrapper::deleteInstance </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Deletes the instanciated object. </p> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html#l00097">97</a> of file <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html">CAmCommonAPIWrapper.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ae0b4c69ab7cba9734f45306c15a2e0ce"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html">CAmCommonAPIWrapper</a> * am::CAmCommonAPIWrapper::getInstance </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Returns an already instantiated object. </p> +<p>This method should be called after the instantiateOnce(...) has been called with non null socket handler parameter.</p> +<dl class="section return"><dt>Returns</dt><dd>The common-api wrapper object. </dd></dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html#l00112">112</a> of file <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html">CAmCommonAPIWrapper.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a195f70d2c9cbd92d4cee4494c2e9c622"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a>* am::CAmCommonAPIWrapper::getSocketHandler </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Getter for the socket handler. </p> +<dl class="section return"><dt>Returns</dt><dd>Pointer to the socket handler. </dd></dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8h_source.html#l00135">135</a> of file <a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a008a684395e96b7204e726b6c835fc7b"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html">CAmCommonAPIWrapper</a> * am::CAmCommonAPIWrapper::instantiateOnce </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> * </td> + <td class="paramname"><em>socketHandler</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>applicationName</em> = <code>""</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Creates a singleton instance attached to the provided socket handler object. </p> +<p>This method should be called only once because it instantiates a single object. Otherwise it will throw an exception. The first call of this method with non null parameter loads the common-api and attaches it to the main loop.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">socketHandler</td><td>A pointer to socket handler or NULL</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>The common-api wrapper object. </dd></dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html#l00083">83</a> of file <a class="el" href="CAmCommonAPIWrapper_8cpp_source.html">CAmCommonAPIWrapper.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ad68e664c43be933aafb2ca437a4aa1e0"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class TStubImp > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool am::CAmCommonAPIWrapper::registerService </td> + <td>(</td> + <td class="paramtype">const std::shared_ptr< TStubImp > & </td> + <td class="paramname"><em>shStub</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>domain</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>instance</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Register stub objects. </p> +<p>Example: std::shared_ptr<ConcreteStubClass> aStub; registerService( aStub, "local", "com.your_company.instance_name");</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">shStub</td><td>Shared pointer to a stub instance </td></tr> + <tr><td class="paramname">domain</td><td>A string with the domain name, usually "local" </td></tr> + <tr><td class="paramname">instance</td><td>Common-api instance string as example "com.your_company.instance_name" </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8h_source.html#l00165">165</a> of file <a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a67dbc668563d1c424baeda2c04652472"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool am::CAmCommonAPIWrapper::unregisterService </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>domain</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>interface</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>instance</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Unregister stub objects. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">domain</td><td>A string with the domain name, usually "local" </td></tr> + <tr><td class="paramname">interface</td><td>Common-api interface string as example "com.your_company.interface_name" </td></tr> + <tr><td class="paramname">instance</td><td>Common-api instance string as example "com.your_company.instance_name" </td></tr> + </table> + </dd> +</dl> + +<p>Definition at line <a class="el" href="CAmCommonAPIWrapper_8h_source.html#l00178">178</a> of file <a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>AudioManagerUtilities/include/<a class="el" href="CAmCommonAPIWrapper_8h_source.html">CAmCommonAPIWrapper.h</a></li> +<li>AudioManagerUtilities/src/<a class="el" href="CAmCommonAPIWrapper_8cpp_source.html">CAmCommonAPIWrapper.cpp</a></li> +</ul> +</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="namespaceam.html">am</a></li><li class="navelem"><a class="el" href="classam_1_1CAmCommonAPIWrapper.html">CAmCommonAPIWrapper</a></li> + <li class="footer">Generated on Fri Sep 30 2016 14:27:22 for AudioManager by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |