diff options
Diffstat (limited to 'docs/classam_1_1CAmSocketHandler.html')
| -rw-r--r-- | docs/classam_1_1CAmSocketHandler.html | 722 |
1 files changed, 722 insertions, 0 deletions
diff --git a/docs/classam_1_1CAmSocketHandler.html b/docs/classam_1_1CAmSocketHandler.html new file mode 100644 index 0000000..007b41f --- /dev/null +++ b/docs/classam_1_1CAmSocketHandler.html @@ -0,0 +1,722 @@ +<!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::CAmSocketHandler 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_1CAmSocketHandler.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-attribs">Public Attributes</a> | +<a href="classam_1_1CAmSocketHandler-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">am::CAmSocketHandler Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>The <a class="el" href="classam_1_1CAmSocketHandler.html" title="The am::CAmSocketHandler implements a mainloop for the AudioManager. ">am::CAmSocketHandler</a> implements a mainloop for the AudioManager. + <a href="classam_1_1CAmSocketHandler.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="CAmSocketHandler_8h_source.html">CAmSocketHandler.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler_1_1TAmShPollCheck.html">TAmShPollCheck</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler_1_1TAmShPollFired.html">TAmShPollFired</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><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:a4882106e0134db9f48aaacb3a9057f3d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a4882106e0134db9f48aaacb3a9057f3d">CAmSocketHandler</a> ()</td></tr> +<tr class="separator:a4882106e0134db9f48aaacb3a9057f3d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a800cafd3fab88551412dafbc03147c11"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a800cafd3fab88551412dafbc03147c11">~CAmSocketHandler</a> ()</td></tr> +<tr class="separator:a800cafd3fab88551412dafbc03147c11"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ace2198a9522679b4a680c43755bb9b44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#ace2198a9522679b4a680c43755bb9b44">addFDPoll</a> (const int fd, const short event, <a class="el" href="classam_1_1IAmShPollPrepare.html">IAmShPollPrepare</a> *prepare, <a class="el" href="classam_1_1IAmShPollFired.html">IAmShPollFired</a> *fired, <a class="el" href="classam_1_1IAmShPollCheck.html">IAmShPollCheck</a> *check, <a class="el" href="classam_1_1IAmShPollDispatch.html">IAmShPollDispatch</a> *dispatch, void *userData, <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> &handle)</td></tr> +<tr class="memdesc:ace2198a9522679b4a680c43755bb9b44"><td class="mdescLeft"> </td><td class="mdescRight">Adds a filedescriptor to the polling loop. <a href="#ace2198a9522679b4a680c43755bb9b44">More...</a><br/></td></tr> +<tr class="separator:ace2198a9522679b4a680c43755bb9b44"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a57c40a25d4bff6f88ed4ce5e597a5712"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a57c40a25d4bff6f88ed4ce5e597a5712">removeFDPoll</a> (const <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> handle)</td></tr> +<tr class="memdesc:a57c40a25d4bff6f88ed4ce5e597a5712"><td class="mdescLeft"> </td><td class="mdescRight">removes a filedescriptor from the poll loop <a href="#a57c40a25d4bff6f88ed4ce5e597a5712">More...</a><br/></td></tr> +<tr class="separator:a57c40a25d4bff6f88ed4ce5e597a5712"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af065b5a6143c8566522528bc18ce1f42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#af065b5a6143c8566522528bc18ce1f42">updateEventFlags</a> (const <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> handle, const short events)</td></tr> +<tr class="memdesc:af065b5a6143c8566522528bc18ce1f42"><td class="mdescLeft"> </td><td class="mdescRight">updates the eventFlags of a poll <a href="#af065b5a6143c8566522528bc18ce1f42">More...</a><br/></td></tr> +<tr class="separator:af065b5a6143c8566522528bc18ce1f42"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a74acb55776de9391f5b6ce6002c0e7b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a74acb55776de9391f5b6ce6002c0e7b4">addTimer</a> (const timespec timeouts, <a class="el" href="classam_1_1IAmShTimerCallBack.html">IAmShTimerCallBack</a> *callback, <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> &handle, void *userData)</td></tr> +<tr class="memdesc:a74acb55776de9391f5b6ce6002c0e7b4"><td class="mdescLeft"> </td><td class="mdescRight">adds a timer to the list of timers. <a href="#a74acb55776de9391f5b6ce6002c0e7b4">More...</a><br/></td></tr> +<tr class="separator:a74acb55776de9391f5b6ce6002c0e7b4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7627416d3b2fd93baa84599b52691bec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a7627416d3b2fd93baa84599b52691bec">removeTimer</a> (const <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> handle)</td></tr> +<tr class="memdesc:a7627416d3b2fd93baa84599b52691bec"><td class="mdescLeft"> </td><td class="mdescRight">removes a timer from the list of timers <a href="#a7627416d3b2fd93baa84599b52691bec">More...</a><br/></td></tr> +<tr class="separator:a7627416d3b2fd93baa84599b52691bec"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a34f5a3d01d54f25eae224d5ca84f5a2a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a34f5a3d01d54f25eae224d5ca84f5a2a">restartTimer</a> (const <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> handle)</td></tr> +<tr class="memdesc:a34f5a3d01d54f25eae224d5ca84f5a2a"><td class="mdescLeft"> </td><td class="mdescRight">restarts a timer with the original value <a href="#a34f5a3d01d54f25eae224d5ca84f5a2a">More...</a><br/></td></tr> +<tr class="separator:a34f5a3d01d54f25eae224d5ca84f5a2a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a94740c067ce4b030c3223397faba5b9c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a94740c067ce4b030c3223397faba5b9c">updateTimer</a> (const <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> handle, const timespec timeouts)</td></tr> +<tr class="memdesc:a94740c067ce4b030c3223397faba5b9c"><td class="mdescLeft"> </td><td class="mdescRight">restarts a timer and updates with a new interva <a href="#a94740c067ce4b030c3223397faba5b9c">More...</a><br/></td></tr> +<tr class="separator:a94740c067ce4b030c3223397faba5b9c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af3b4d566129e9d9dc9dae13d5a51afdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#af3b4d566129e9d9dc9dae13d5a51afdf">stopTimer</a> (const <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> handle)</td></tr> +<tr class="memdesc:af3b4d566129e9d9dc9dae13d5a51afdf"><td class="mdescLeft"> </td><td class="mdescRight">stops a timer <a href="#af3b4d566129e9d9dc9dae13d5a51afdf">More...</a><br/></td></tr> +<tr class="separator:af3b4d566129e9d9dc9dae13d5a51afdf"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac4d61b623aedd44ea1fd075aee7851b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#ac4d61b623aedd44ea1fd075aee7851b1">start_listenting</a> ()</td></tr> +<tr class="memdesc:ac4d61b623aedd44ea1fd075aee7851b1"><td class="mdescLeft"> </td><td class="mdescRight">start the block listening for filedescriptors. <a href="#ac4d61b623aedd44ea1fd075aee7851b1">More...</a><br/></td></tr> +<tr class="separator:ac4d61b623aedd44ea1fd075aee7851b1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ade03cab4d0ee59386c13688949ec942a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#ade03cab4d0ee59386c13688949ec942a">stop_listening</a> ()</td></tr> +<tr class="memdesc:ade03cab4d0ee59386c13688949ec942a"><td class="mdescLeft"> </td><td class="mdescRight">exits the loop <a href="#ade03cab4d0ee59386c13688949ec942a">More...</a><br/></td></tr> +<tr class="separator:ade03cab4d0ee59386c13688949ec942a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a166eb3d78647168e55fa0931f7ee6933"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a166eb3d78647168e55fa0931f7ee6933">exit_mainloop</a> ()</td></tr> +<tr class="separator:a166eb3d78647168e55fa0931f7ee6933"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ad0228e22c588a8e944fc700cdc24064f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#ad0228e22c588a8e944fc700cdc24064f">receiverCallback</a> (const pollfd pollfd, const <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> handle, void *userData)</td></tr> +<tr class="separator:ad0228e22c588a8e944fc700cdc24064f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a28ee6a9430a72033a8494fc7c35b2775"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a28ee6a9430a72033a8494fc7c35b2775">checkerCallback</a> (const <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> handle, void *userData)</td></tr> +<tr class="separator:a28ee6a9430a72033a8494fc7c35b2775"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr class="memitem:a16104f2862e1744334e6ed3a9563c0b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classam_1_1CAmSocketHandler_1_1TAmShPollFired.html">TAmShPollFired</a>< <a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a16104f2862e1744334e6ed3a9563c0b9">receiverCallbackT</a></td></tr> +<tr class="separator:a16104f2862e1744334e6ed3a9563c0b9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4d12cdc8ba360fa21df9ec6803259c4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classam_1_1CAmSocketHandler_1_1TAmShPollCheck.html">TAmShPollCheck</a>< <a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmSocketHandler.html#a4d12cdc8ba360fa21df9ec6803259c4c">checkerCallbackT</a></td></tr> +<tr class="separator:a4d12cdc8ba360fa21df9ec6803259c4c"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>The <a class="el" href="classam_1_1CAmSocketHandler.html" title="The am::CAmSocketHandler implements a mainloop for the AudioManager. ">am::CAmSocketHandler</a> implements a mainloop for the AudioManager. </p> +<p>Plugins and different parts of the AudioManager add their filedescriptors to the handler to get called on communication of the filedescriptors.<br/> +More information can be found here : <a class="el" href="mainl.html">Mainloop concept</a> </p> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8h_source.html#l00094">94</a> of file <a class="el" href="CAmSocketHandler_8h_source.html">CAmSocketHandler.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a4882106e0134db9f48aaacb3a9057f3d"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">am::CAmSocketHandler::CAmSocketHandler </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00039">39</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a800cafd3fab88551412dafbc03147c11"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">am::CAmSocketHandler::~CAmSocketHandler </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00064">64</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="ace2198a9522679b4a680c43755bb9b44"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::CAmSocketHandler::addFDPoll </td> + <td>(</td> + <td class="paramtype">const int </td> + <td class="paramname"><em>fd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const short </td> + <td class="paramname"><em>event</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classam_1_1IAmShPollPrepare.html">IAmShPollPrepare</a> * </td> + <td class="paramname"><em>prepare</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classam_1_1IAmShPollFired.html">IAmShPollFired</a> * </td> + <td class="paramname"><em>fired</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classam_1_1IAmShPollCheck.html">IAmShPollCheck</a> * </td> + <td class="paramname"><em>check</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classam_1_1IAmShPollDispatch.html">IAmShPollDispatch</a> * </td> + <td class="paramname"><em>dispatch</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>userData</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> & </td> + <td class="paramname"><em>handle</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Adds a filedescriptor to the polling loop. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">fd</td><td>the filedescriptor </td></tr> + <tr><td class="paramname">event</td><td>the event flags </td></tr> + <tr><td class="paramname">prepare</td><td>a callback that is called before the loop is entered </td></tr> + <tr><td class="paramname">fired</td><td>a callback that is called when the filedescriptor needs to be read </td></tr> + <tr><td class="paramname">check</td><td>a callback that is called to check if further actions are neccessary </td></tr> + <tr><td class="paramname">dispatch</td><td>a callback that is called to dispatch the received data </td></tr> + <tr><td class="paramname">userData</td><td>a pointer to userdata that is always passed around </td></tr> + <tr><td class="paramname">handle</td><td>the handle of this poll </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>E_OK if the descriptor was added, E_NON_EXISTENT if the fd is not valid </dd></dl> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00195">195</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a74acb55776de9391f5b6ce6002c0e7b4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::CAmSocketHandler::addTimer </td> + <td>(</td> + <td class="paramtype">const timespec </td> + <td class="paramname"><em>timeouts</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classam_1_1IAmShTimerCallBack.html">IAmShTimerCallBack</a> * </td> + <td class="paramname"><em>callback</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> & </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>userData</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>adds a timer to the list of timers. </p> +<p>The callback will be fired when the timer is up. This is not a high precise timer, it is very coarse. It is meant to be used for timeouts when waiting for an answer via a filedescriptor. One time timer. If you need again a timer, you need to add a new timer in the callback of the old one. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">timeouts</td><td>timeouts time until the callback is fired </td></tr> + <tr><td class="paramname">callback</td><td>callback the callback </td></tr> + <tr><td class="paramname">handle</td><td>handle the handle that is created for the timer is returned. Can be used to remove the timer </td></tr> + <tr><td class="paramname">userData</td><td>pointer always passed with the call </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>E_OK in case of success </dd></dl> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00272">272</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a28ee6a9430a72033a8494fc7c35b2775"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">bool am::CAmSocketHandler::checkerCallback </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>userData</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>Definition at line <a class="el" href="CAmSocketHandler_8h_source.html#l00151">151</a> of file <a class="el" href="CAmSocketHandler_8h_source.html">CAmSocketHandler.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a166eb3d78647168e55fa0931f7ee6933"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void am::CAmSocketHandler::exit_mainloop </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00558">558</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ad0228e22c588a8e944fc700cdc24064f"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void am::CAmSocketHandler::receiverCallback </td> + <td>(</td> + <td class="paramtype">const pollfd </td> + <td class="paramname"><em>pollfd</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>userData</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>Definition at line <a class="el" href="CAmSocketHandler_8h_source.html#l00145">145</a> of file <a class="el" href="CAmSocketHandler_8h_source.html">CAmSocketHandler.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a57c40a25d4bff6f88ed4ce5e597a5712"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::CAmSocketHandler::removeFDPoll </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> </td> + <td class="paramname"><em>handle</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>removes a filedescriptor from the poll loop </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd></dd></dl> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00244">244</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a7627416d3b2fd93baa84599b52691bec"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::CAmSocketHandler::removeTimer </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> </td> + <td class="paramname"><em>handle</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>removes a timer from the list of timers </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle</td><td>the handle to the timer </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>E_OK in case of success, E_UNKNOWN if timer was not found. </dd></dl> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00321">321</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a34f5a3d01d54f25eae224d5ca84f5a2a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::CAmSocketHandler::restartTimer </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> </td> + <td class="paramname"><em>handle</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>restarts a timer with the original value </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_NON_EXISTENT if the handle was not found </dd></dl> +<p><the original timer value </p> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00399">399</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ac4d61b623aedd44ea1fd075aee7851b1"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void am::CAmSocketHandler::start_listenting </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>start the block listening for filedescriptors. </p> +<p>This is the mainloop. </p> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00074">74</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="ade03cab4d0ee59386c13688949ec942a"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void am::CAmSocketHandler::stop_listening </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>exits the loop </p> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00168">168</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="af3b4d566129e9d9dc9dae13d5a51afdf"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::CAmSocketHandler::stopTimer </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> </td> + <td class="paramname"><em>handle</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>stops a timer </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_NON_EXISTENT if the handle was not found </dd></dl> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00451">451</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="af065b5a6143c8566522528bc18ce1f42"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::CAmSocketHandler::updateEventFlags </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#af782e2735b1adf1e43a9d530cee340aa">sh_pollHandle_t</a> </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const short </td> + <td class="paramname"><em>events</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>updates the eventFlags of a poll </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle</td><td></td></tr> + <tr><td class="paramname">events</td><td></td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd></dd> +<dd> +E_OK on succsess, E_NON_EXISTENT if fd was not found </dd></dl> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00472">472</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<a class="anchor" id="a94740c067ce4b030c3223397faba5b9c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespaceam.html#aa3dcb70029da317d661b6f422de1b4ce">am_Error_e</a> am::CAmSocketHandler::updateTimer </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="namespaceam.html#a22a7b0b07f6cd371e638db2194762958">sh_timerHandle_t</a> </td> + <td class="paramname"><em>handle</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const timespec </td> + <td class="paramname"><em>timeouts</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>restarts a timer and updates with a new interva </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">handle</td><td>handle to the timer </td></tr> + <tr><td class="paramname">timeouts</td><td>new timout time </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>E_OK on success, E_NON_EXISTENT if the handle was not found </dd></dl> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8cpp_source.html#l00347">347</a> of file <a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.cpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a class="anchor" id="a4d12cdc8ba360fa21df9ec6803259c4c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classam_1_1CAmSocketHandler_1_1TAmShPollCheck.html">TAmShPollCheck</a><<a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a>> am::CAmSocketHandler::checkerCallbackT</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8h_source.html#l00159">159</a> of file <a class="el" href="CAmSocketHandler_8h_source.html">CAmSocketHandler.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a16104f2862e1744334e6ed3a9563c0b9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classam_1_1CAmSocketHandler_1_1TAmShPollFired.html">TAmShPollFired</a><<a class="el" href="classam_1_1CAmSocketHandler.html">CAmSocketHandler</a>> am::CAmSocketHandler::receiverCallbackT</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="CAmSocketHandler_8h_source.html#l00156">156</a> of file <a class="el" href="CAmSocketHandler_8h_source.html">CAmSocketHandler.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="CAmSocketHandler_8h_source.html">CAmSocketHandler.h</a></li> +<li>AudioManagerUtilities/src/<a class="el" href="CAmSocketHandler_8cpp_source.html">CAmSocketHandler.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_1CAmSocketHandler.html">CAmSocketHandler</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> |