mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
78 lines
18 KiB
HTML
78 lines
18 KiB
HTML
<!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.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/ofi/Context.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.14</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.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</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><li class="navelem"><a class="el" href="dir_5bbe8f428ccaffea9370922019c81a71.html">ofi</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Context.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) 2018 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 FAIR_MQ_OFI_CONTEXT_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_OFI_CONTEXT_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 <FairMQLogger.h></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <FairMQTransportFactory.h></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <asiofi/domain.hpp></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <asiofi/fabric.hpp></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <asiofi/info.hpp></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <boost/asio/io_context.hpp></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <netinet/in.h></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <ostream></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <stdexcept></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <thread></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></span></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> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>mq</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>ofi</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">enum class</span> ConnectionType : bool { Bind, Connect };</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1ofi_1_1Address.html"> 36</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1ofi_1_1Address.html">Address</a> {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::string Protocol;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  std::string Ip;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Port;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">friend</span> <span class="keyword">auto</span> operator<<(std::ostream& os, <span class="keyword">const</span> <a class="code" href="structfair_1_1mq_1_1ofi_1_1Address.html">Address</a>& a) -> std::ostream&</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordflow">return</span> os << a.Protocol << <span class="stringliteral">"://"</span> << a.Ip << <span class="stringliteral">":"</span> << a.Port;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  }</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">friend</span> <span class="keyword">auto</span> operator==(<span class="keyword">const</span> <a class="code" href="structfair_1_1mq_1_1ofi_1_1Address.html">Address</a>& lhs, <span class="keyword">const</span> <a class="code" href="structfair_1_1mq_1_1ofi_1_1Address.html">Address</a>& rhs) -> <span class="keywordtype">bool</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordflow">return</span> (lhs.Protocol == rhs.Protocol) && (lhs.Ip == rhs.Ip) && (lhs.Port == rhs.Port);</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> };</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ofi_1_1Context.html"> 56</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1ofi_1_1Context.html">Context</a></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classfair_1_1mq_1_1ofi_1_1Context.html">Context</a>(<a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>& sendFactory,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>& receiveFactory,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">int</span> numberIoThreads = 1);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  ~<a class="code" href="classfair_1_1mq_1_1ofi_1_1Context.html">Context</a>();</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>  <span class="keyword">auto</span> GetAsiofiVersion() <span class="keyword">const</span> -> std::string;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">auto</span> GetIoContext() -> boost::asio::io_context& { <span class="keywordflow">return</span> fIoContext; }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">static</span> <span class="keyword">auto</span> ConvertAddress(std::string address) -> <a class="code" href="structfair_1_1mq_1_1ofi_1_1Address.html">Address</a>;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">static</span> <span class="keyword">auto</span> ConvertAddress(<a class="code" href="structfair_1_1mq_1_1ofi_1_1Address.html">Address</a> address) -> sockaddr_in;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">static</span> <span class="keyword">auto</span> ConvertAddress(sockaddr_in address) -> <a class="code" href="structfair_1_1mq_1_1ofi_1_1Address.html">Address</a>;</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">static</span> <span class="keyword">auto</span> VerifyAddress(<span class="keyword">const</span> std::string& address) -> <a class="code" href="structfair_1_1mq_1_1ofi_1_1Address.html">Address</a>;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">auto</span> Interrupt() -> <span class="keywordtype">void</span> { LOG(debug) << <span class="stringliteral">"OFI transport: Interrupted (NOOP - not implemented)."</span>; }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="keyword">auto</span> Resume() -> <span class="keywordtype">void</span> { LOG(debug) << <span class="stringliteral">"OFI transport: Resumed (NOOP - not implemented)."</span>; }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">auto</span> Reset() -> void;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">auto</span> MakeReceiveMessage(<span class="keywordtype">size_t</span> size) -> MessagePtr;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">auto</span> MakeSendMessage(<span class="keywordtype">size_t</span> size) -> MessagePtr;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">auto</span> GetSizeHint() -> <span class="keywordtype">size_t</span> { <span class="keywordflow">return</span> fSizeHint; }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">auto</span> SetSizeHint(<span class="keywordtype">size_t</span> size) -> <span class="keywordtype">void</span> { fSizeHint = size; }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  boost::asio::io_context fIoContext;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  boost::asio::io_context::work fIoWork;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  std::vector<std::thread> fThreadPool;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>& fReceiveFactory;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>& fSendFactory;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">size_t</span> fSizeHint;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">auto</span> InitThreadPool(<span class="keywordtype">int</span> numberIoThreads) -> void;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> }; <span class="comment">/* class Context */</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1ofi_1_1ContextError.html"> 89</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1ofi_1_1ContextError.html">ContextError</a> : std::runtime_error { <span class="keyword">using</span> std::runtime_error::runtime_error; };</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="comment">/* namespace ofi */</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> } <span class="comment">/* namespace fair */</span></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="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_OFI_CONTEXT_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classfair_1_1mq_1_1ofi_1_1Context_html"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1Context.html">fair::mq::ofi::Context</a></div><div class="ttdoc">Transport-wide context. </div><div class="ttdef"><b>Definition:</b> Context.h:56</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1ofi_1_1Address_html"><div class="ttname"><a href="structfair_1_1mq_1_1ofi_1_1Address.html">fair::mq::ofi::Address</a></div><div class="ttdef"><b>Definition:</b> Context.h:36</div></div>
|
|
<div class="ttc" id="classFairMQTransportFactory_html"><div class="ttname"><a href="classFairMQTransportFactory.html">FairMQTransportFactory</a></div><div class="ttdef"><b>Definition:</b> FairMQTransportFactory.h:30</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1ofi_1_1ContextError_html"><div class="ttname"><a href="structfair_1_1mq_1_1ofi_1_1ContextError.html">fair::mq::ofi::ContextError</a></div><div class="ttdef"><b>Definition:</b> Context.h:89</div></div>
|
|
<div class="ttc" id="namespacefair_html"><div class="ttname"><a href="namespacefair.html">fair</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><!-- fragment --></div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|