jessequ
/
qamqp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
qamqp/doc/html/amqp__queue_8h_source.html

151 lines
16 KiB
HTML
Raw Normal View History

[+] Start write documentation
2012-07-19 00:18:04 +08:00
<!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"/>
<title>QAMQP: src/qamqp/amqp_queue.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="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">QAMQP
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9ec0bf019b04e9539964c8725d5fd1e8.html">qamqp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">amqp_queue.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef amqp_queue_h__</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define amqp_queue_h__</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;amqp_channel.h&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &quot;amqp_message.h&quot;</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">namespace </span>QAMQP</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;{</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; <span class="keyword">class </span>Client;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="keyword">class </span>ClientPrivate;</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <span class="keyword">class </span>Exchange;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <span class="keyword">class </span>QueuePrivate;</div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="code" href="class_q_a_m_q_p_1_1_queue.html"> 13</a></span>&#160; <span class="keyword">class </span><a class="code" href="class_q_a_m_q_p_1_1_queue.html">Queue</a> : <span class="keyword">public</span> <a class="code" href="class_q_a_m_q_p_1_1_channel.html">Channel</a></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; {</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; Q_OBJECT</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="class_q_a_m_q_p_1_1_queue.html">Queue</a>(<span class="keywordtype">int</span> channelNumber = -1, <a class="code" href="class_q_a_m_q_p_1_1_client.html">Client</a> * parent = 0);</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; Q_PROPERTY(QueueOptions option READ option );</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; Q_PROPERTY(QString consumerTag READ consumerTag WRITE setConsumerTag)</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; Q_PROPERTY(<span class="keywordtype">bool</span> noAck READ noAck WRITE setNoAck)</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; P_DECLARE_PRIVATE(<a class="code" href="class_q_a_m_q_p_1_1_queue.html">QAMQP::Queue</a>)</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; Q_DISABLE_COPY(Queue); </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span>ClientPrivate;</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordtype">void</span> onOpen();</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordtype">void</span> onClose();</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">enum</span> QueueOption {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; NoOptions = 0x0,</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; Passive = 0x01,</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; Durable = 0x02,</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; Exclusive = 0x4,</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; AutoDelete = 0x8, </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; NoWait = 0x10</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; };</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; Q_DECLARE_FLAGS(QueueOptions, QueueOption)</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">enum</span> ConsumeOption {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; coNoLocal = 0x1,</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; coNoAck = 0x02,</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; coExclusive = 0x04, </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; coNoWait = 0x8</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; };</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; Q_DECLARE_FLAGS(ConsumeOptions, ConsumeOption)</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; ~Queue();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; QueueOptions option() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">void</span> declare();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordtype">void</span> declare(<span class="keyword">const</span> QString &amp;name, QueueOptions options);</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">void</span> <span class="keyword">remove</span>(<span class="keywordtype">bool</span> ifUnused = <span class="keyword">true</span>, <span class="keywordtype">bool</span> ifEmpty = <span class="keyword">true</span>, <span class="keywordtype">bool</span> noWait = <span class="keyword">true</span>);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">void</span> purge();</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordtype">void</span> bind(<span class="keyword">const</span> QString &amp; exchangeName, <span class="keyword">const</span> QString &amp; key);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordtype">void</span> bind(<a class="code" href="class_q_a_m_q_p_1_1_exchange.html">Exchange</a> * exchange, <span class="keyword">const</span> QString &amp; key);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; <span class="keywordtype">void</span> unbind(<span class="keyword">const</span> QString &amp; exchangeName, <span class="keyword">const</span> QString &amp; key);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="keywordtype">void</span> unbind(<a class="code" href="class_q_a_m_q_p_1_1_exchange.html">Exchange</a> * exchange, <span class="keyword">const</span> QString &amp; key);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; MessagePtr getMessage();</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordtype">void</span> <span class="keyword">get</span>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordtype">void</span> ack(<span class="keyword">const</span> MessagePtr &amp; message);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordtype">bool</span> hasMessage() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keywordtype">void</span> consume(ConsumeOptions options = ConsumeOptions(NoOptions));</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordtype">void</span> setConsumerTag(<span class="keyword">const</span> QString &amp;consumerTag);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; QString consumerTag() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="keywordtype">void</span> setNoAck(<span class="keywordtype">bool</span> noAck);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keywordtype">bool</span> noAck() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; Q_SIGNALS:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">void</span> declared();</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keywordtype">void</span> binded(<span class="keywordtype">bool</span>);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="keywordtype">void</span> removed();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="keywordtype">void</span> messageRecieved();</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="keywordtype">void</span> empty();</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; Q_PRIVATE_SLOT(pd_func(), <span class="keywordtype">void</span> _q_content(<span class="keyword">const</span> <a class="code" href="class_q_a_m_q_p_1_1_frame_1_1_content.html" title="Class for working with content frames. Implement main methods for serialize and deserialize raw cont...">QAMQP::Frame::Content</a> &amp; frame))</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; Q_PRIVATE_SLOT(pd_func(), <span class="keywordtype">void</span> _q_body(<span class="keywordtype">int</span> channeNumber, <span class="keyword">const</span> QByteArray &amp; body))</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; };</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;}</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#ifdef QAMQP_P_INCLUDE</span></div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160;<span class="preprocessor"></span><span class="preprocessor"># include &quot;amqp_queue_p.h&quot;</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#endif // amqp_queue_h__</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 18 2012 22:16:34 for QAMQP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>