TorqueEngine
/
Torque2D
mirrorاز https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: Dispatcher Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a>  </div>
  <div class="headertitle"><div class="title">Dispatcher Namespace Reference</div></div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="class_namespace.html">Namespace</a> for the message dispatcher functions.  
<a href="namespace_dispatcher.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><b>_DispatchData</b></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal class used by the dispatcher. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_dispatcher_1_1_i_message_listener.html">IMessageListener</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Listener interface for objects that receive messages.  <a href="class_dispatcher_1_1_i_message_listener.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_dispatcher_1_1_message_queue.html">MessageQueue</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal class for tracking message queues.  <a href="struct_dispatcher_1_1_message_queue.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Message Queue Management</div></td></tr>
<tr class="memitem:a475336f26197a41b45eb826398e63766" id="r_a475336f26197a41b45eb826398e63766"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#a475336f26197a41b45eb826398e63766">isQueueRegistered</a> (const char *name)</td></tr>
<tr class="memdesc:a475336f26197a41b45eb826398e63766"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a message queue is registered.  <br /></td></tr>
<tr class="separator:a475336f26197a41b45eb826398e63766"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09ff473e98ca1b914c3444d881c2ba1b" id="r_a09ff473e98ca1b914c3444d881c2ba1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#a09ff473e98ca1b914c3444d881c2ba1b">registerMessageQueue</a> (const char *name)</td></tr>
<tr class="memdesc:a09ff473e98ca1b914c3444d881c2ba1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a message queue.  <br /></td></tr>
<tr class="separator:a09ff473e98ca1b914c3444d881c2ba1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20cc5c36744cd94eca902c6acb2229fd" id="r_a20cc5c36744cd94eca902c6acb2229fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#a20cc5c36744cd94eca902c6acb2229fd">unregisterMessageQueue</a> (const char *name)</td></tr>
<tr class="memdesc:a20cc5c36744cd94eca902c6acb2229fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister a message queue.  <br /></td></tr>
<tr class="separator:a20cc5c36744cd94eca902c6acb2229fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a127b637fdd313e225e4343dd463aa3a1" id="r_a127b637fdd313e225e4343dd463aa3a1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#a127b637fdd313e225e4343dd463aa3a1">registerMessageListener</a> (const char *queue, <a class="el" href="class_dispatcher_1_1_i_message_listener.html">IMessageListener</a> *listener)</td></tr>
<tr class="memdesc:a127b637fdd313e225e4343dd463aa3a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a listener with a queue to receive messages.  <br /></td></tr>
<tr class="separator:a127b637fdd313e225e4343dd463aa3a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a755f0ac1a6c41778ab98a0226cd74bd6" id="r_a755f0ac1a6c41778ab98a0226cd74bd6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#a755f0ac1a6c41778ab98a0226cd74bd6">unregisterMessageListener</a> (const char *queue, <a class="el" href="class_dispatcher_1_1_i_message_listener.html">IMessageListener</a> *listener)</td></tr>
<tr class="memdesc:a755f0ac1a6c41778ab98a0226cd74bd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister a listener with a queue.  <br /></td></tr>
<tr class="separator:a755f0ac1a6c41778ab98a0226cd74bd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Message Dispatcher</div></td></tr>
<tr class="memitem:a251f75d3c4ed3ecead95ac7dcf52d1fd" id="r_a251f75d3c4ed3ecead95ac7dcf52d1fd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#a251f75d3c4ed3ecead95ac7dcf52d1fd">dispatchMessage</a> (const char *queue, const char *msg, const char *data)</td></tr>
<tr class="memdesc:a251f75d3c4ed3ecead95ac7dcf52d1fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch a message to a queue.  <br /></td></tr>
<tr class="separator:a251f75d3c4ed3ecead95ac7dcf52d1fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65396645d201721ac81a5774f1706f5a" id="r_a65396645d201721ac81a5774f1706f5a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#a65396645d201721ac81a5774f1706f5a">dispatchMessageObject</a> (const char *queue, <a class="el" href="class_message.html">Message</a> *msg)</td></tr>
<tr class="memdesc:a65396645d201721ac81a5774f1706f5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dispatch a message object to a queue.  <br /></td></tr>
<tr class="separator:a65396645d201721ac81a5774f1706f5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Internal Functions</div></td></tr>
<tr class="memitem:acca04c368d0821de2c0c2e88a5e38b1d" id="r_acca04c368d0821de2c0c2e88a5e38b1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_dispatcher_1_1_message_queue.html">MessageQueue</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#acca04c368d0821de2c0c2e88a5e38b1d">getMessageQueue</a> (const char *name)</td></tr>
<tr class="memdesc:acca04c368d0821de2c0c2e88a5e38b1d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal function: obtain message queue. <a class="el" href="namespace_dispatcher.html" title="Namespace for the message dispatcher functions.">Dispatcher</a> mutex must be locked.  <br /></td></tr>
<tr class="separator:acca04c368d0821de2c0c2e88a5e38b1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc18764e02e02fec00ec896e18bb405a" id="r_afc18764e02e02fec00ec896e18bb405a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#afc18764e02e02fec00ec896e18bb405a">lockDispatcherMutex</a> ()</td></tr>
<tr class="memdesc:afc18764e02e02fec00ec896e18bb405a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal function: Lock the dispatcher mutex.  <br /></td></tr>
<tr class="separator:afc18764e02e02fec00ec896e18bb405a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a418d1a0f7116a1018baab4559f73361d" id="r_a418d1a0f7116a1018baab4559f73361d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_dispatcher.html#a418d1a0f7116a1018baab4559f73361d">unlockDispatcherMutex</a> ()</td></tr>
<tr class="memdesc:a418d1a0f7116a1018baab4559f73361d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal function: Unlock the dispatcher mutex.  <br /></td></tr>
<tr class="separator:a418d1a0f7116a1018baab4559f73361d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="class_namespace.html">Namespace</a> for the message dispatcher functions. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a251f75d3c4ed3ecead95ac7dcf52d1fd" name="a251f75d3c4ed3ecead95ac7dcf52d1fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a251f75d3c4ed3ecead95ac7dcf52d1fd">&#9670;&#160;</a></span>dispatchMessage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool dispatchMessage </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>queue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Dispatch a message to a queue. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td><a class="el" href="class_queue.html">Queue</a> to dispatch the message to </td></tr>
    <tr><td class="paramname">msg</td><td><a class="el" href="class_message.html" title="Base class for messages.">Message</a> to dispatch </td></tr>
    <tr><td class="paramname">data</td><td>Data for message </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true for success, false for failure </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#a65396645d201721ac81a5774f1706f5a" title="Dispatch a message object to a queue.">dispatchMessageObject()</a> </dd></dl>

</div>
</div>
<a id="a65396645d201721ac81a5774f1706f5a" name="a65396645d201721ac81a5774f1706f5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65396645d201721ac81a5774f1706f5a">&#9670;&#160;</a></span>dispatchMessageObject()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool dispatchMessageObject </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>queue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_message.html">Message</a> *&#160;</td>
          <td class="paramname"><em>msg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Dispatch a message object to a queue. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td><a class="el" href="class_queue.html">Queue</a> to dispatch the message to </td></tr>
    <tr><td class="paramname">msg</td><td><a class="el" href="class_message.html" title="Base class for messages.">Message</a> to dispatch </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true for success, false for failure </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#a251f75d3c4ed3ecead95ac7dcf52d1fd" title="Dispatch a message to a queue.">dispatchMessage()</a> </dd></dl>

</div>
</div>
<a id="acca04c368d0821de2c0c2e88a5e38b1d" name="acca04c368d0821de2c0c2e88a5e38b1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acca04c368d0821de2c0c2e88a5e38b1d">&#9670;&#160;</a></span>getMessageQueue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_dispatcher_1_1_message_queue.html">MessageQueue</a> * getMessageQueue </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Internal function: obtain message queue. <a class="el" href="namespace_dispatcher.html" title="Namespace for the message dispatcher functions.">Dispatcher</a> mutex must be locked. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>Name of the queue </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_message.html" title="Base class for messages.">Message</a> queue </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#afc18764e02e02fec00ec896e18bb405a" title="Internal function: Lock the dispatcher mutex.">lockDispatcherMutex()</a>, <a class="el" href="namespace_dispatcher.html#a418d1a0f7116a1018baab4559f73361d" title="Internal function: Unlock the dispatcher mutex.">unlockDispatcherMutex()</a> </dd></dl>

</div>
</div>
<a id="a475336f26197a41b45eb826398e63766" name="a475336f26197a41b45eb826398e63766"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a475336f26197a41b45eb826398e63766">&#9670;&#160;</a></span>isQueueRegistered()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool isQueueRegistered </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Check if a message queue is registered. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The name of the message queue </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the queue is registered, false otherwise </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#a09ff473e98ca1b914c3444d881c2ba1b" title="Register a message queue.">registerMessageQueue()</a>, <a class="el" href="namespace_dispatcher.html#a20cc5c36744cd94eca902c6acb2229fd" title="Unregister a message queue.">unregisterMessageQueue()</a> </dd></dl>

</div>
</div>
<a id="afc18764e02e02fec00ec896e18bb405a" name="afc18764e02e02fec00ec896e18bb405a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc18764e02e02fec00ec896e18bb405a">&#9670;&#160;</a></span>lockDispatcherMutex()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool lockDispatcherMutex </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Internal function: Lock the dispatcher mutex. </p>
<dl class="section return"><dt>Returns</dt><dd>true for success, false for failure </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#a418d1a0f7116a1018baab4559f73361d" title="Internal function: Unlock the dispatcher mutex.">unlockDispatcherMutex()</a> </dd></dl>

</div>
</div>
<a id="a127b637fdd313e225e4343dd463aa3a1" name="a127b637fdd313e225e4343dd463aa3a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a127b637fdd313e225e4343dd463aa3a1">&#9670;&#160;</a></span>registerMessageListener()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool registerMessageListener </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>queue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_dispatcher_1_1_i_message_listener.html">IMessageListener</a> *&#160;</td>
          <td class="paramname"><em>listener</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Register a listener with a queue to receive messages. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td>The name of the queue to register the listener with </td></tr>
    <tr><td class="paramname">listener</td><td>The listener interface that receives messages </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true for success, false otherwise </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#a755f0ac1a6c41778ab98a0226cd74bd6" title="Unregister a listener with a queue.">unregisterMessageListener()</a> </dd></dl>

</div>
</div>
<a id="a09ff473e98ca1b914c3444d881c2ba1b" name="a09ff473e98ca1b914c3444d881c2ba1b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09ff473e98ca1b914c3444d881c2ba1b">&#9670;&#160;</a></span>registerMessageQueue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void registerMessageQueue </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Register a message queue. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The name of the message queue to register </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#a475336f26197a41b45eb826398e63766" title="Check if a message queue is registered.">isQueueRegistered()</a>, <a class="el" href="namespace_dispatcher.html#a20cc5c36744cd94eca902c6acb2229fd" title="Unregister a message queue.">unregisterMessageQueue()</a> </dd></dl>

</div>
</div>
<a id="a418d1a0f7116a1018baab4559f73361d" name="a418d1a0f7116a1018baab4559f73361d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a418d1a0f7116a1018baab4559f73361d">&#9670;&#160;</a></span>unlockDispatcherMutex()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void unlockDispatcherMutex </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">extern</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Internal function: Unlock the dispatcher mutex. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#afc18764e02e02fec00ec896e18bb405a" title="Internal function: Lock the dispatcher mutex.">lockDispatcherMutex()</a> </dd></dl>

</div>
</div>
<a id="a755f0ac1a6c41778ab98a0226cd74bd6" name="a755f0ac1a6c41778ab98a0226cd74bd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a755f0ac1a6c41778ab98a0226cd74bd6">&#9670;&#160;</a></span>unregisterMessageListener()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void unregisterMessageListener </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>queue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_dispatcher_1_1_i_message_listener.html">IMessageListener</a> *&#160;</td>
          <td class="paramname"><em>listener</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unregister a listener with a queue. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queue</td><td>The name of the queue to unregister the listener </td></tr>
    <tr><td class="paramname">listener</td><td>The listener interface that was passed to <a class="el" href="namespace_dispatcher.html#a127b637fdd313e225e4343dd463aa3a1" title="Register a listener with a queue to receive messages.">registerMessageListener()</a> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#a127b637fdd313e225e4343dd463aa3a1" title="Register a listener with a queue to receive messages.">registerMessageListener()</a> </dd></dl>

</div>
</div>
<a id="a20cc5c36744cd94eca902c6acb2229fd" name="a20cc5c36744cd94eca902c6acb2229fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20cc5c36744cd94eca902c6acb2229fd">&#9670;&#160;</a></span>unregisterMessageQueue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void unregisterMessageQueue </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unregister a message queue. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The name of the message queue </td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_dispatcher.html#a09ff473e98ca1b914c3444d881c2ba1b" title="Register a message queue.">registerMessageQueue()</a>, <a class="el" href="namespace_dispatcher.html#a475336f26197a41b45eb826398e63766" title="Check if a message queue is registered.">isQueueRegistered()</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>