Ryan OShea | de36e4a | 2020-03-13 16:26:19 +0000 | [diff] [blame^] | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | <html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | <head> |
| 4 | <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 | <meta name="generator" content="Doxygen 1.8.13"/> |
| 7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| 8 | <title>ArmNN: src/armnnUtils/NetworkSockets.hpp Source File</title> |
| 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 10 | <script type="text/javascript" src="jquery.js"></script> |
| 11 | <script type="text/javascript" src="dynsections.js"></script> |
| 12 | <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| 13 | <script type="text/javascript" src="resize.js"></script> |
| 14 | <script type="text/javascript" src="navtreedata.js"></script> |
| 15 | <script type="text/javascript" src="navtree.js"></script> |
| 16 | <script type="text/javascript"> |
| 17 | $(document).ready(initResizable); |
| 18 | </script> |
| 19 | <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 20 | <script type="text/javascript" src="search/searchdata.js"></script> |
| 21 | <script type="text/javascript" src="search/search.js"></script> |
| 22 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 23 | </head> |
| 24 | <body> |
| 25 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 26 | <div id="titlearea"> |
| 27 | <table cellspacing="0" cellpadding="0"> |
| 28 | <tbody> |
| 29 | <tr style="height: 56px;"> |
| 30 | <td id="projectalign" style="padding-left: 0.5em;"> |
| 31 | <div id="projectname">ArmNN |
| 32 |  <span id="projectnumber">NotReleased</span> |
| 33 | </div> |
| 34 | </td> |
| 35 | </tr> |
| 36 | </tbody> |
| 37 | </table> |
| 38 | </div> |
| 39 | <!-- end header part --> |
| 40 | <!-- Generated by Doxygen 1.8.13 --> |
| 41 | <script type="text/javascript"> |
| 42 | var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 43 | </script> |
| 44 | <script type="text/javascript" src="menudata.js"></script> |
| 45 | <script type="text/javascript" src="menu.js"></script> |
| 46 | <script type="text/javascript"> |
| 47 | $(function() { |
| 48 | initMenu('',true,false,'search.php','Search'); |
| 49 | $(document).ready(function() { init_search(); }); |
| 50 | }); |
| 51 | </script> |
| 52 | <div id="main-nav"></div> |
| 53 | </div><!-- top --> |
| 54 | <div id="side-nav" class="ui-resizable side-nav-resizable"> |
| 55 | <div id="nav-tree"> |
| 56 | <div id="nav-tree-contents"> |
| 57 | <div id="nav-sync" class="sync"></div> |
| 58 | </div> |
| 59 | </div> |
| 60 | <div id="splitbar" style="-moz-user-select:none;" |
| 61 | class="ui-resizable-handle"> |
| 62 | </div> |
| 63 | </div> |
| 64 | <script type="text/javascript"> |
| 65 | $(document).ready(function(){initNavTree('_network_sockets_8hpp_source.html','');}); |
| 66 | </script> |
| 67 | <div id="doc-content"> |
| 68 | <!-- window showing the filter options --> |
| 69 | <div id="MSearchSelectWindow" |
| 70 | onmouseover="return searchBox.OnSearchSelectShow()" |
| 71 | onmouseout="return searchBox.OnSearchSelectHide()" |
| 72 | onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 73 | </div> |
| 74 | |
| 75 | <!-- iframe showing the search results (closed by default) --> |
| 76 | <div id="MSearchResultsWindow"> |
| 77 | <iframe src="javascript:void(0)" frameborder="0" |
| 78 | name="MSearchResults" id="MSearchResults"> |
| 79 | </iframe> |
| 80 | </div> |
| 81 | |
| 82 | <div class="header"> |
| 83 | <div class="headertitle"> |
| 84 | <div class="title">NetworkSockets.hpp</div> </div> |
| 85 | </div><!--header--> |
| 86 | <div class="contents"> |
| 87 | <a href="_network_sockets_8hpp.html">Go to the documentation of this file.</a><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 © 2020 Arm Ltd. All rights reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">//</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This file (along with its corresponding .cpp) defines a very thin platform abstraction layer for the use of</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// networking sockets. Thankfully the underlying APIs on Windows and Linux are very similar so not much conversion</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// is needed (typically just forwarding the parameters to a differently named function).</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Some of the APIs are in fact completely identical and so no forwarding function is needed.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#if defined(__unix__)</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <poll.h></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <sys/ioctl.h></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <sys/socket.h></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <sys/un.h></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#elif defined(_MSC_VER)</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <winsock2.h></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <afunix.h></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#endif</span></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> <span class="keyword">namespace </span><a class="code" href="namespacearmnn_utils.html">armnnUtils</a></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span>Sockets</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"> 28</span> <span class="preprocessor">#if defined(__unix__)</span></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> <span class="keyword">using</span> Socket = int;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">using</span> PollFd = pollfd;</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> <span class="preprocessor">#elif defined(_MSC_VER)</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">using</span> Socket = SOCKET;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">using</span> PollFd = WSAPOLLFD;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define SOCK_CLOEXEC 0</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> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keywordtype">bool</span> <a class="code" href="namespacearmnn_utils_1_1_sockets.html#a248c764067ee60c03ee370784c49f353">Initialize</a>();</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="keywordtype">int</span> <a class="code" href="namespacearmnn_utils_1_1_sockets.html#a72e0661331d20d0a352fb49c388a1b05">Close</a>(Socket s);</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="keywordtype">bool</span> <a class="code" href="namespacearmnn_utils_1_1_sockets.html#a8396c0d14fc0e7284b175fedfeceef37">SetNonBlocking</a>(Socket s);</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">long</span> <a class="code" href="namespacearmnn_utils_1_1_sockets.html#ad5b08981ac047ff0a3c7cb3442b9f161">Write</a>(Socket s, <span class="keyword">const</span> <span class="keywordtype">void</span>* buf, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">long</span> <a class="code" href="namespacearmnn_utils_1_1_sockets.html#a7b2c6949d9d76d2c0ffca916175e5322">Read</a>(Socket s, <span class="keywordtype">void</span>* buf, <span class="keywordtype">size_t</span> len);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keywordtype">int</span> <a class="code" href="namespacearmnn_utils_1_1_sockets.html#a36eb04939ffbb4d4a1291724921a6c6a">Ioctl</a>(Socket s, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">int</span> cmd, <span class="keywordtype">void</span>* arg);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">int</span> <a class="code" href="namespacearmnn_utils_1_1_sockets.html#a242d840b21fc2f18ac1ec8d609180e15">Poll</a>(PollFd* fds, nfds_t numFds, <span class="keywordtype">int</span> timeout);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> Socket <a class="code" href="namespacearmnn_utils_1_1_sockets.html#ae7d45c832d3f9a398a08352442d20417">Accept</a>(Socket s, sockaddr* addr, socklen_t* addrlen, <span class="keywordtype">int</span> flags);</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> }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> }</div><div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_ad5b08981ac047ff0a3c7cb3442b9f161"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#ad5b08981ac047ff0a3c7cb3442b9f161">armnnUtils::Sockets::Write</a></div><div class="ttdeci">long Write(Socket s, const void *buf, size_t len)</div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00050">NetworkSockets.cpp:50</a></div></div> |
| 88 | <div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_a72e0661331d20d0a352fb49c388a1b05"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#a72e0661331d20d0a352fb49c388a1b05">armnnUtils::Sockets::Close</a></div><div class="ttdeci">int Close(Socket s)</div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00028">NetworkSockets.cpp:28</a></div></div> |
| 89 | <div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_a248c764067ee60c03ee370784c49f353"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#a248c764067ee60c03ee370784c49f353">armnnUtils::Sockets::Initialize</a></div><div class="ttdeci">bool Initialize()</div><div class="ttdoc">Performs any required one-time setup. </div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00018">NetworkSockets.cpp:18</a></div></div> |
| 90 | <div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_a7b2c6949d9d76d2c0ffca916175e5322"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#a7b2c6949d9d76d2c0ffca916175e5322">armnnUtils::Sockets::Read</a></div><div class="ttdeci">long Read(Socket s, void *buf, size_t len)</div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00060">NetworkSockets.cpp:60</a></div></div> |
| 91 | <div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_a242d840b21fc2f18ac1ec8d609180e15"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#a242d840b21fc2f18ac1ec8d609180e15">armnnUtils::Sockets::Poll</a></div><div class="ttdeci">int Poll(PollFd *fds, nfds_t numFds, int timeout)</div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00081">NetworkSockets.cpp:81</a></div></div> |
| 92 | <div class="ttc" id="namespacearmnn_utils_html"><div class="ttname"><a href="namespacearmnn_utils.html">armnnUtils</a></div><div class="ttdef"><b>Definition:</b> <a href="_data_layout_indexed_8hpp_source.html#l00013">DataLayoutIndexed.hpp:13</a></div></div> |
| 93 | <div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_ae7d45c832d3f9a398a08352442d20417"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#ae7d45c832d3f9a398a08352442d20417">armnnUtils::Sockets::Accept</a></div><div class="ttdeci">armnnUtils::Sockets::Socket Accept(Socket s, sockaddr *addr, socklen_t *addrlen, int flags)</div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00091">NetworkSockets.cpp:91</a></div></div> |
| 94 | <div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_a36eb04939ffbb4d4a1291724921a6c6a"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#a36eb04939ffbb4d4a1291724921a6c6a">armnnUtils::Sockets::Ioctl</a></div><div class="ttdeci">int Ioctl(Socket s, unsigned long int cmd, void *arg)</div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00069">NetworkSockets.cpp:69</a></div></div> |
| 95 | <div class="ttc" id="namespacearmnn_utils_1_1_sockets_html_a8396c0d14fc0e7284b175fedfeceef37"><div class="ttname"><a href="namespacearmnn_utils_1_1_sockets.html#a8396c0d14fc0e7284b175fedfeceef37">armnnUtils::Sockets::SetNonBlocking</a></div><div class="ttdeci">bool SetNonBlocking(Socket s)</div><div class="ttdef"><b>Definition:</b> <a href="_network_sockets_8cpp_source.html#l00038">NetworkSockets.cpp:38</a></div></div> |
| 96 | </div><!-- fragment --></div><!-- contents --> |
| 97 | </div><!-- doc-content --> |
| 98 | <!-- start footer part --> |
| 99 | <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| 100 | <ul> |
| 101 | <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5d9c764a006d252ff232a5efbbd99a46.html">armnnUtils</a></li><li class="navelem"><a class="el" href="_network_sockets_8hpp.html">NetworkSockets.hpp</a></li> |
| 102 | <li class="footer">Generated on Fri Mar 13 2020 16:06:56 for ArmNN by |
| 103 | <a href="http://www.doxygen.org/index.html"> |
| 104 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> |
| 105 | </ul> |
| 106 | </div> |
| 107 | </body> |
| 108 | </html> |