mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
202 lines
22 KiB
HTML
202 lines
22 KiB
HTML
<!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">
|
|
<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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/FairMQUnmanagedRegion.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="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" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FairMQ
|
|
 <span id="projectnumber">1.4.33</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">FairMQUnmanagedRegion.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/********************************************************************************</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This software is distributed under the terms of the *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * GNU Lesser General Public Licence (LGPL) version 3, *</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * copied verbatim in the file "LICENSE" *</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> ********************************************************************************/</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef FAIRMQUNMANAGEDREGION_H_</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIRMQUNMANAGEDREGION_H_</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <cstddef></span> <span class="comment">// size_t</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <cstdint></span> <span class="comment">// uint32_t</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <memory></span> <span class="comment">// std::unique_ptr</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <functional></span> <span class="comment">// std::function</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <ostream></span> <span class="comment">// std::ostream</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span><a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">enum class</span> FairMQRegionEvent : int</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  created,</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  destroyed,</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  local_only</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> };</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structFairMQRegionInfo.html"> 28</a></span> <span class="keyword">struct </span><a class="code" href="structFairMQRegionInfo.html">FairMQRegionInfo</a></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <a class="code" href="structFairMQRegionInfo.html">FairMQRegionInfo</a>()</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  : managed(<span class="keyword">true</span>)</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  , id(0)</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  , ptr(<span class="keyword">nullptr</span>)</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  , size(0)</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  , flags(0)</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  , event(FairMQRegionEvent::created)</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {}</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="structFairMQRegionInfo.html">FairMQRegionInfo</a>(<span class="keywordtype">bool</span> _managed, uint64_t _id, <span class="keywordtype">void</span>* _ptr, <span class="keywordtype">size_t</span> _size, int64_t _flags, FairMQRegionEvent _event)</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  : managed(_managed)</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  , id(_id)</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  , ptr(_ptr)</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  , size(_size)</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  , flags(_flags)</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  , event(_event)</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  {}</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">bool</span> managed; <span class="comment">// managed/unmanaged</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  uint64_t id; <span class="comment">// id of the region</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span>* ptr; <span class="comment">// pointer to the start of the region</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">size_t</span> size; <span class="comment">// region size</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  int64_t flags; <span class="comment">// custom flags set by the creator</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  FairMQRegionEvent event;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> };</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structFairMQRegionBlock.html"> 56</a></span> <span class="keyword">struct </span><a class="code" href="structFairMQRegionBlock.html">FairMQRegionBlock</a> {</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">void</span>* ptr;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">size_t</span> size;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span>* hint;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="structFairMQRegionBlock.html">FairMQRegionBlock</a>(<span class="keywordtype">void</span>* p, <span class="keywordtype">size_t</span> s, <span class="keywordtype">void</span>* h)</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  : ptr(p), size(s), hint(h)</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {}</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> };</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">using</span> FairMQRegionCallback = std::function<void(<span class="keywordtype">void</span>*, <span class="keywordtype">size_t</span>, <span class="keywordtype">void</span>*)>;</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">using</span> FairMQRegionBulkCallback = std::function<void(<span class="keyword">const</span> std::vector<FairMQRegionBlock>&)>;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">using</span> FairMQRegionEventCallback = std::function<void(<a class="code" href="structFairMQRegionInfo.html">FairMQRegionInfo</a>)>;</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="classFairMQUnmanagedRegion.html"> 70</a></span> <span class="keyword">class </span><a class="code" href="classFairMQUnmanagedRegion.html">FairMQUnmanagedRegion</a></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> {</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classFairMQUnmanagedRegion.html">FairMQUnmanagedRegion</a>() {}</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classFairMQUnmanagedRegion.html">FairMQUnmanagedRegion</a>(<a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>* factory) : fTransport(factory) {}</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span>* GetData() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> GetSize() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">virtual</span> uint16_t GetId() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetLinger(uint32_t linger) = 0;</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">virtual</span> uint32_t GetLinger() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>* GetTransport() { <span class="keywordflow">return</span> fTransport; }</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span> SetTransport(<a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>* transport) { fTransport = transport; }</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">virtual</span> ~<a class="code" href="classFairMQUnmanagedRegion.html">FairMQUnmanagedRegion</a>() {};</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>* fTransport{<span class="keyword">nullptr</span>};</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> };</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keyword">using</span> FairMQUnmanagedRegionPtr = std::unique_ptr<FairMQUnmanagedRegion>;</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">inline</span> std::ostream& operator<<(std::ostream& os, <span class="keyword">const</span> FairMQRegionEvent& event)</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> {</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">switch</span> (event) {</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">case</span> FairMQRegionEvent::created:</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">return</span> os << <span class="stringliteral">"created"</span>;</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">case</span> FairMQRegionEvent::destroyed:</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">return</span> os << <span class="stringliteral">"destroyed"</span>;</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordflow">case</span> FairMQRegionEvent::local_only:</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordflow">return</span> os << <span class="stringliteral">"local_only"</span>;</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordflow">default</span>:</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">return</span> os << <span class="stringliteral">"unrecognized event"</span>;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  }</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> }</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">namespace </span><a class="code" href="namespacefair_1_1mq.html">fair::mq</a></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> {</div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">using</span> RegionCallback = FairMQRegionCallback;</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="keyword">using</span> RegionBulkCallback = FairMQRegionBulkCallback;</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">using</span> RegionEventCallback = FairMQRegionEventCallback;</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">using</span> RegionEvent = FairMQRegionEvent;</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">using</span> RegionInfo = <a class="code" href="structFairMQRegionInfo.html">FairMQRegionInfo</a>;</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">using</span> RegionBlock = <a class="code" href="structFairMQRegionBlock.html">FairMQRegionBlock</a>;</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">using</span> UnmanagedRegion = <a class="code" href="classFairMQUnmanagedRegion.html">FairMQUnmanagedRegion</a>;</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">using</span> UnmanagedRegionPtr = FairMQUnmanagedRegionPtr;</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> } <span class="comment">// namespace fair::mq</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIRMQUNMANAGEDREGION_H_ */</span><span class="preprocessor"></span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="astructFairMQRegionBlock_html"><div class="ttname"><a href="structFairMQRegionBlock.html">FairMQRegionBlock</a></div><div class="ttdef"><b>Definition:</b> FairMQUnmanagedRegion.h:56</div></div>
|
|
<div class="ttc" id="astructFairMQRegionInfo_html"><div class="ttname"><a href="structFairMQRegionInfo.html">FairMQRegionInfo</a></div><div class="ttdef"><b>Definition:</b> FairMQUnmanagedRegion.h:29</div></div>
|
|
<div class="ttc" id="anamespacefair_1_1mq_html"><div class="ttname"><a href="namespacefair_1_1mq.html">fair::mq</a></div><div class="ttdoc">Tools for interfacing containers to the transport via polymorphic allocators.</div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:23</div></div>
|
|
<div class="ttc" id="aclassFairMQUnmanagedRegion_html"><div class="ttname"><a href="classFairMQUnmanagedRegion.html">FairMQUnmanagedRegion</a></div><div class="ttdef"><b>Definition:</b> FairMQUnmanagedRegion.h:71</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html"><div class="ttname"><a href="classFairMQTransportFactory.html">FairMQTransportFactory</a></div><div class="ttdef"><b>Definition:</b> FairMQTransportFactory.h:30</div></div>
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|