Fábio Coutada
7855eab092
MAJOR MILESTONE: Successfully imported complete PikeOS 5.0 ecosystem from Virtual Machine 100 (devvm-arch) on gigabyte Proxmox server. Import Summary: - Source Code: 4.3GB, 63,441 files, 14,829 C/C++/H files - Documentation: 78MB, 37+ PDF manuals covering all PikeOS aspects - XSD Schemas: 1.8MB, 158 schema files for configuration/code generation - Test Framework: Complete TFW infrastructure in src/tfw/ Key Components: ✅ Multi-architecture kernels (ARM v7/v8, PowerPC e500/e500mc/e5500, x86_64) ✅ Core source libraries (libstand, ssw, p4ext) ✅ Complete test framework with executables, includes, libraries ✅ 37+ comprehensive PDF documentation (installation, development, platform manuals) ✅ 158 XSD schemas for Eclipse-based code generation and configuration ✅ AUTOSAR/MISRA safety-critical compliance foundation ✅ Hardware virtualization support ✅ Eclipse IDE project configuration (.project, .cproject) Documentation Categories: - Installation & User Guides (pikeos-installation-guide.pdf, user manuals) - Development References (kernel, driver, test framework manuals) - API & Programming (C/C++ environments, native API extensions) - Platform Manuals (ARM, PowerPC, x86 specific guides) - CDK Documentation (gcc, binutils, ld, cpp internals) - Release Notes (all components for 5.0.3) - Specialized Topics (hardware virtualization, POSIX compliance) Technical Achievements: ✅ Complete PikeOS 5.0 codebase across multiple processor architectures ✅ Safety-critical foundation with AUTOSAR/MISRA compliance ✅ Eclipse IDE integration with XSD-driven code generation pipeline ✅ Comprehensive test framework for validation and verification ✅ Complete documentation covering development, deployment, and optimization Extraction Method: - Source: VM 100 (devvm-arch) on gigabyte server (192.168.0.104) - Method: Direct LVM disk mount via losetup, rsync transfer - Size: Total 4.4GB extracted and organized Next Phases: - Phase 3: XSD Workflow Analysis (Day 8-10) - Phase 4: Safety Standards Compliance Documentation (Day 11-12) - Phase 5: Component Categorization (Day 13-14) - Phase 6: Aurelio Brain Test (Day 15) Co-Authored-By: Claude <noreply@anthropic.com>
124 lines
142 KiB
HTML
124 lines
142 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>socket.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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</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! -->
|
|
<!-- 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>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('socket_8h_source.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">socket.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="socket_8h.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="preprocessor">#ifndef SOCKET_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define SOCKET_H</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">/** ***************************************************************************</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * @if INCLUDE_HEADER</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * @copyright</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * (C) Copyright SYSGO AG.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Klein-Winternheim, Germany</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * All rights reserved.</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * @endif</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * @file</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * anisSocket: API Definition for the ANIS Stack.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * @if INCLUDE_HEADER</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * @cfg_management</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * $Id: include/socket.h 2019-07-26 14:16:12 +0200 f6077168b3f152b3d7204dde5657fee2d8cdbbd3 $</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * $HeadURL$</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * $Author$</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * $Date$</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * $Revision$</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @endif</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *****************************************************************************/</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="comment">/* ------------------------- FILE INCLUSION -------------------------------- */</span></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="preprocessor">#include <vm.h></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <p4.h></span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#if defined(PIKEOSCENV)</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <stdint.h></span> <span class="comment">/* uint16_t, uint32_t, uint64_t */</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include <p4.h></span> <span class="comment">/* P4_uint16_t, P4_uint32_t, P4_uint64_t */</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifndef _UINT16_T_DECLARED</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/** Unsigned 16-bit integer type. */</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="socket_8h.html#a0ff56c581dfb6cf3a5e20721148464db"> 38</a></span> <span class="keyword">typedef</span> P4_uint16_t <a class="code" href="socket_8h.html#a0ff56c581dfb6cf3a5e20721148464db">uint16_t</a>;<span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/** @cond __PRIVATE */</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define _UINT16_T_DECLARED</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/** @endcond */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif</span></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="preprocessor">#ifndef _UINT32_T_DECLARED</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/** Unsigned 32-bit integer type. */</span></div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="socket_8h.html#a0cc7aad3029b5e8db64b12dd63599c81"> 46</a></span> <span class="keyword">typedef</span> P4_uint32_t <a class="code" href="socket_8h.html#a0cc7aad3029b5e8db64b12dd63599c81">uint32_t</a>;<span class="comment"></span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/** @cond __PRIVATE */</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#define _UINT32_T_DECLARED</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/** @endcond */</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></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="preprocessor">#ifndef _UINT64_T_DECLARED</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/** unsigned 64-bit integer type */</span></div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="socket_8h.html#a8bd44ed5ed915e56cef58aefdd91daeb"> 54</a></span> <span class="keyword">typedef</span> P4_uint64_t <a class="code" href="socket_8h.html#a8bd44ed5ed915e56cef58aefdd91daeb">uint64_t</a>;<span class="comment"></span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/** @cond __PRIVATE */</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define _UINT64_T_DECLARED</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/** @endcond */</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></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> <span class="preprocessor">#include <anisfp/anisEndian.h></span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#include <anisfp/socket_api_common.h></span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/**</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @addtogroup anisSocket</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> */</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">/* ------------------- CONSTANT / MACRO DEFINITIONS ------------------------ */</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1571 */</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/**</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * Error return codes of ANIS API functions.</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> *</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * The functions of the ANIS API return one of these values to indicate</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * success or failure. All error codes are negative so that they are</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * disjoint from non-negative integers that indicate success in certain</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * services (e.g. socket(), recvfrom(), and sendto()).</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga97bf3204b925dcc74344a0fe68fc6bb5"> 83</a></span> <span class="keyword">enum</span> <a class="code" href="group__anisSocket.html#ga97bf3204b925dcc74344a0fe68fc6bb5">anis_error_e</a></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> {<span class="comment"></span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> /** everything is okay */</span></div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a9f77c517fa9fd5b772fd704185337bfe"> 86</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a9f77c517fa9fd5b772fd704185337bfe">ANIS_E_OK</a> = 0,<span class="comment"></span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> /** invalid address (protocol) family */</span></div><div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a7ae663416da47cef5496f3fd5faa1ae4"> 88</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a7ae663416da47cef5496f3fd5faa1ae4">ANIS_E_AFNOSUPPORT</a> = -128,<span class="comment"></span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /** invalid socket type */</span></div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a19c7b48903d186b0478464769fe04698"> 90</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a19c7b48903d186b0478464769fe04698">ANIS_E_SOCKTNOSUPPORT</a> = -127,<span class="comment"></span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> /** invalid protocol */</span></div><div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5ae67a0077e7c3ba204bf549d1cbdc71c9"> 92</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5ae67a0077e7c3ba204bf549d1cbdc71c9">ANIS_E_PROTOTYPE</a> = -126,<span class="comment"></span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> /** socket is already in use or not enough resources */</span></div><div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a40755f2243941e277d64a8538a7ed5b5"> 94</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a40755f2243941e277d64a8538a7ed5b5">ANIS_E_BUSY</a> = -125,<span class="comment"></span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> /** invalid socket descriptor */</span></div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5abf518a8d434669c0fce0cd5f67c9ffe7"> 96</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5abf518a8d434669c0fce0cd5f67c9ffe7">ANIS_E_BADF</a> = -124,<span class="comment"></span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> /** address is already in use */</span></div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5abb77ce5e4cb4b67a7a75a72c6a99f403"> 98</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5abb77ce5e4cb4b67a7a75a72c6a99f403">ANIS_E_ADDRINUSE</a> = -123,<span class="comment"></span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /** invalid length value */</span></div><div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5acec189fcbf3da4ee5b4e5e107d98cb33"> 100</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5acec189fcbf3da4ee5b4e5e107d98cb33">ANIS_E_FAULT</a> = -122,<span class="comment"></span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> /** invalid IP address */</span></div><div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aa6d065b68af15b15acac0bfc2efff0aa"> 102</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aa6d065b68af15b15acac0bfc2efff0aa">ANIS_E_ADDRNOTAVAIL</a> = -121,<span class="comment"></span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> /** invalid argument length */</span></div><div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a41c6127a55462871cd13b002661dd717"> 104</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a41c6127a55462871cd13b002661dd717">ANIS_E_INVAL</a> = -120,<span class="comment"></span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> /** invalid protocol level */</span></div><div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5af2d8bf5e0fd6e0acb08466022e2bd93a"> 106</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5af2d8bf5e0fd6e0acb08466022e2bd93a">ANIS_E_OPNOTSUPP</a> = -119,<span class="comment"></span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> /** invalid socket option option */</span></div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a0684400fdd07b379a2739ae374e5ce1f"> 108</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a0684400fdd07b379a2739ae374e5ce1f">ANIS_E_NOPROTOOPT</a> = -118,<span class="comment"></span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> /** oversize length value */</span></div><div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5af8df4ecd651023b4c3b3ac997f4d7c4c"> 110</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5af8df4ecd651023b4c3b3ac997f4d7c4c">ANIS_E_RANGE</a> = -117,<span class="comment"></span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> /** could not be done, try again */</span></div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a6f59ed366481d228cc6540f23d791520"> 112</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a6f59ed366481d228cc6540f23d791520">ANIS_E_AGAIN</a> = -116,<span class="comment"></span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> /** message is greater than buffer */</span></div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a429cb2e154e9aecdac90ef50d6a69044"> 114</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a429cb2e154e9aecdac90ef50d6a69044">ANIS_E_MSGSIZE</a> = -115,<span class="comment"></span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> /** ANIS instance doesn't exist */</span></div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aa9442af4d1ee3fc37c6477ce2dadea6e"> 116</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aa9442af4d1ee3fc37c6477ce2dadea6e">ANIS_E_NO_ENT</a> = -114,<span class="comment"></span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> /** permission denied */</span></div><div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a09eb74bc73c673eafe0cb63958f60181"> 118</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a09eb74bc73c673eafe0cb63958f60181">ANIS_E_PERM</a> = -113,<span class="comment"></span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> /** unbound socket or initialization of ANIS failed */</span></div><div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aed1de229aed1013382b0ac9ee0cc1fde"> 120</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aed1de229aed1013382b0ac9ee0cc1fde">ANIS_E_STATE</a> = -112,<span class="comment"></span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> /** internal error occurred */</span></div><div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a7b2084bbb005e1ea00346b0a9727efa3"> 122</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a7b2084bbb005e1ea00346b0a9727efa3">ANIS_E_SYS</a> = -111,<span class="comment"></span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> /** operation was interrupted */</span></div><div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5addaf2fdec2d448748e96141a08a4ebc3"> 124</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5addaf2fdec2d448748e96141a08a4ebc3">ANIS_E_INTR</a> = -110,<span class="comment"></span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> /** Not enough memory */</span></div><div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a53f8552d19283e602e6bb3b6aba6f9a7"> 126</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a53f8552d19283e602e6bb3b6aba6f9a7">ANIS_E_NO_MEM</a> = -109,<span class="comment"></span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> /** File descriptor cannot be allocated */</span></div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5afd5ffa60b9d5c90bd00703152f51fbd8"> 128</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5afd5ffa60b9d5c90bd00703152f51fbd8">ANIS_E_NO_FD</a> = -108,<span class="comment"></span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /** In the system already exists active thread with the same number */</span></div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a9d8eb7623dfe5a59f1093879488392d2"> 130</a></span>  <a class="code" href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a9d8eb7623dfe5a59f1093879488392d2">ANIS_E_THRACTIVE</a> = -107,</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> };</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment">/* ------------------------ TYPE DECLARATIONS ------------------------------ */</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">/**</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * Signed data type to hold the size of a message.</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> *</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * This signed integer type is used to store the size of a received message</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * or an error indication.</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> */</span></div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga831c6b6852c6d34448e30a88c34539fd"> 143</a></span> <span class="keyword">typedef</span> <span class="keywordtype">long</span> <a class="code" href="group__anisSocket.html#ga831c6b6852c6d34448e30a88c34539fd">ssize_t</a>;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="preprocessor">#ifndef _GCC_SIZE_T</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment">/**</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * Unsigned long data type to hold the size of a message.</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> *</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * This unsigned long type is used to store the size of a message</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * to be sent.</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> */</span></div><div class="line"><a name="l00154"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gacf18a0d6c4b39d531e021702e9a77984"> 154</a></span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="group__anisSocket.html#gacf18a0d6c4b39d531e021702e9a77984">size_t</a>;<span class="comment"></span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">/** @cond __PRIVATE */</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="preprocessor">#define _GCC_SIZE_T</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment">/** @endcond */</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="preprocessor">#endif </span><span class="comment">/* _GCC_SIZE_T */</span><span class="preprocessor"></span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment">/* ----------------------- FUNCTION DECLARATIONS --------------------------- */</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> </div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1669 */</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"></span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment">/**</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * Initialize ANIS API.</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> *</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * Initialize a connection to an ANIS instance with the name given in \a</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * anisname. Internally the ANIS API runs a thread to implement blocking.</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * This thread is also started by this function. The thread number to use is</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * provided in the argument \a threadno.</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> *</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @param[in] anisname Name of an ANIS instance.</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> * @param[in] threadno Thread number for the internal control thread.</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> *</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * On success the function returns ANIS_E_OK. If an error occurs, it</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * returns one of the following error codes.</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> *</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * @retval ANIS_E_NO_MEM</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * Not enough memory to initialize PikeOS API.</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * @retval ANIS_E_NO_FD</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> * Not enough file descriptors.</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * @retval ANIS_E_THRACTIVE</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * Thread with the same ID is already active.</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @retval ANIS_E_STATE</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * Initialization has already been done.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @retval ANIS_E_NO_ENT</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * No ANIS instance \a anisname exists. Instance of the \a anisname was not</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> * either starter or failed during startup.</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * @retval ANIS_E_PERM</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> * No sufficient access right to connect to the ANIS instance.</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * The string length of \a anisname is greater than or</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * equal to \a ANIS_MAX_NAMELEN.</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * A call to a PikeOS API function failed.</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> */</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keywordtype">int</span> <a class="code" href="group__anisSocket.html#ga3eeb75f358558b9e9d4ba9b58b08e676">anis_init</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *anisname, P4_uint32_t threadno);</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1561 */</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"></span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">/**</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * Create a new socket.</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> *</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * This function creates a new ANIS socket using the parameter \a domain, \a</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> * type and \a protocol to specify it. The only valid values are \a PF_INET</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"> * for \a domain, \a SOCK_DGRAM for \a type and 0 for \a protocol.</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> *</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> * @param[in] domain</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * the communication domain; only PF_INET is supported</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> *</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * @param[in] type</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * the communication semantics; only SOCK_DGRAM is supported</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> *</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> * @param[in] protocol</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * the communication protocol; only 0 is supported.</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> *</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * On success the function returns a valid socket descriptor that references</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * the created socket. If an error occurs, it returns one of the following</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * negative error codes.</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> *</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> * @retval ANIS_E_STATE</span></div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> * Initialization has not yet been done.</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> *</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * @retval ANIS_E_PROTOTYPE</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * \a type is not set to SOCK_DGRAM</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> *</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @retval ANIS_E_AFNOSUPPORT</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * \a domain is not set to PF_INET</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> *</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * @retval ANIS_E_AFSOCKTNOSUPPORT</span></div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * \a protocol is not set to 0</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> *</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> * @retval ANIS_E_BUSY</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * Reached the limit of 512 sockets open by the application.</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> *</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * @retval ANIS_E_BUSY</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * The total number of sockets open by all clients of the ANIS file provider</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * reached the configured limit.</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> *</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * @retval ANIS_E_NO_FD</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * Not enough file descriptors.</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> *</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> * An internal error occurred or a call to a PikeOS API function failed.</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> *</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> * @note</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * The number of sockets that can be opened simultaneously is limited in</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * multiple ways. If the smallest of these limits is exceeded, socket()</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> * will fail and return ANIS_E_BUSY or ANIS_E_NO_FD. The limits are:</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * - number of sockets configured in the ANIS file provider</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * - maximum number of file descriptors of the caller's partition</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * (a file descriptor is needed for each open socket)</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * - at most 512 open sockets are supported by the PikeOS ANIS API library</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> */</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="keywordtype">int</span> <a class="code" href="group__anisSocket.html#gaf4e0711877c45a41168ac677b0670ccd">socket</a>(<span class="keywordtype">int</span> domain, <span class="keywordtype">int</span> type, <span class="keywordtype">int</span> protocol);</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> </div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1573 */</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"></span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment">/**</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * @ingroup anisSockConf</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> *</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * Bind a socket to an address.</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> *</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> * Bind the given socket to the given address. Bind to INADDR_ANY address</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * results to socket bound to all configured interfaces including localhost</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * interface.</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> *</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * @param[in] sock</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> * the socket descriptor to bind</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> *</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> * @param[in] address</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * the address to which to bind the socket</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> *</span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * @param[in] address_len</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * the size in bytes of the object referenced by \a address</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"> *</span></div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * On success the function returns ANIS_E_OK.</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> *</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> * @retval ANIS_E_ADDRINUSE</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * another socket is already bound to \a address</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> *</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> * \a address_len is not equal to the size of struct sockaddr_in</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> *</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> * the socket is already bound</span></div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="comment"> *</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * @retval ANIS_E_AFNOSUPPORT</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * the \a sin_family member of \a address is not PF_INET</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> *</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> * @retval ANIS_E_ADDRNOTAVAIL</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * the IP address specified in \a address does neither match the configured</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * IP address nor INADDR_ANY</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> *</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * \a sock is not a valid socket descriptor</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> *</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * an internal error occurred or a call to a PikeOS API function failed</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> *</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * @retval ANIS_E_STATE</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> * ANIS wasn't initialized.</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> */</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="keywordtype">int</span> <a class="code" href="group__anisSocket.html#ga318aa8bcb1857ddf776ffce53ac8252a">bind</a> (<span class="keywordtype">int</span> sock, <span class="keyword">struct</span> <a class="code" href="structsockaddr.html">sockaddr</a> *address, <a class="code" href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514">socklen_t</a> address_len);</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"></span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment">/**</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * @ingroup anisSockIO</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> *</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * Retrieve a message from a socket.</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> *</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> * Dequeue the oldest message from the sockets \a sock message queue and</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> * return its first \c N bytes in \a buffer, where \c N is the lesser of the</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> * value provided in \a length and the message size. If the message queue is</span></div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"> * currently empty and the \c MSG_DONTWAIT flag is not set in \a flags,</span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> * recvfrom() blocks until a message is received or an error occurs. If the</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * message queue is currently empty and the \c MSG_DONTWAIT flag is set in</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * \a flags, recvfrom() returns immediately with error \c ANIS_E_EAGAIN.</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> *</span></div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> * If the output parameter \a address is not \c NULL, the source address of</span></div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> * the received message is returned in this buffer and \a address_len is set</span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> * to the length of the value written into \a address. If the application</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * does not need the source address of the message, it may set \a address</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * and \a address_len to \c NULL.</span></div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"> *</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> * @param[in] sock</span></div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> * the socket descriptor to be read from</span></div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> *</span></div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> * @param[out] buffer</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * the output buffer used to store the received message</span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> *</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> * @param[in] length</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * the size of the buffer provided in \a buffer</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> *</span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * @param[in] flags</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * receive semantics; either zero or \c MSG_DONTWAIT</span></div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> <span class="comment"> *</span></div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> <span class="comment"> * @param[out] address</span></div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> <span class="comment"> * the output buffer used to store the source address of the received message</span></div><div class="line"><a name="l00351"></a><span class="lineno"> 351</span> <span class="comment"> *</span></div><div class="line"><a name="l00352"></a><span class="lineno"> 352</span> <span class="comment"> * @param[in,out] address_len</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * the length of the buffer provided in \a address when called; the length</span></div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * of the address upon return</span></div><div class="line"><a name="l00355"></a><span class="lineno"> 355</span> <span class="comment"> *</span></div><div class="line"><a name="l00356"></a><span class="lineno"> 356</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> * If a message was successfully received that did fit into the provided</span></div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * buffer, recvfrom() returns the size of the message in bytes. If the</span></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * message did not fit completely into the buffer, recvfrom() returns</span></div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> * ANIS_E_MSGSIZE. In this case only the first \a length bytes are available</span></div><div class="line"><a name="l00361"></a><span class="lineno"> 361</span> <span class="comment"> * to the caller.</span></div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> <span class="comment"> *</span></div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"> * @retval ANIS_E_MSGSIZE</span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment"> * the message is longer than \a length bytes.</span></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> <span class="comment"> *</span></div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="comment"> * @retval ANIS_E_INTR</span></div><div class="line"><a name="l00367"></a><span class="lineno"> 367</span> <span class="comment"> * \a sock is closed whilst blocking</span></div><div class="line"><a name="l00368"></a><span class="lineno"> 368</span> <span class="comment"> *</span></div><div class="line"><a name="l00369"></a><span class="lineno"> 369</span> <span class="comment"> * @retval ANIS_E_AGAIN</span></div><div class="line"><a name="l00370"></a><span class="lineno"> 370</span> <span class="comment"> * the message queue of \a sock is empty and the \c MSG_DONTWAIT flag is</span></div><div class="line"><a name="l00371"></a><span class="lineno"> 371</span> <span class="comment"> * set in \a flags</span></div><div class="line"><a name="l00372"></a><span class="lineno"> 372</span> <span class="comment"> *</span></div><div class="line"><a name="l00373"></a><span class="lineno"> 373</span> <span class="comment"> * @retval ANIS_E_STATE</span></div><div class="line"><a name="l00374"></a><span class="lineno"> 374</span> <span class="comment"> * \a sock is not bound</span></div><div class="line"><a name="l00375"></a><span class="lineno"> 375</span> <span class="comment"> *</span></div><div class="line"><a name="l00376"></a><span class="lineno"> 376</span> <span class="comment"> * @retval ANIS_E_RANGE</span></div><div class="line"><a name="l00377"></a><span class="lineno"> 377</span> <span class="comment"> * \a length is greater than the maximum message size of 65507 bytes</span></div><div class="line"><a name="l00378"></a><span class="lineno"> 378</span> <span class="comment"> *</span></div><div class="line"><a name="l00379"></a><span class="lineno"> 379</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00380"></a><span class="lineno"> 380</span> <span class="comment"> * \a address_len is less than the size, in bytes, of a struct sockaddr_in</span></div><div class="line"><a name="l00381"></a><span class="lineno"> 381</span> <span class="comment"> *</span></div><div class="line"><a name="l00382"></a><span class="lineno"> 382</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00383"></a><span class="lineno"> 383</span> <span class="comment"> * unsupported flags are set in \a flags</span></div><div class="line"><a name="l00384"></a><span class="lineno"> 384</span> <span class="comment"> *</span></div><div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment"> * \a sock is not a valid socket descriptor</span></div><div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment"> *</span></div><div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> * an internal error occurred or a call to a PikeOS API function failed.</span></div><div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"> * The reasons include uninitialized thread local storage or \a message</span></div><div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> * not entirely mapped.</span></div><div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> */</span></div><div class="line"><a name="l00393"></a><span class="lineno"> 393</span> </div><div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1630 */</span></div><div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <a class="code" href="group__anisSocket.html#ga831c6b6852c6d34448e30a88c34539fd">ssize_t</a> <a class="code" href="group__anisSocket.html#gaaf00beb7b83dbe8d7832f088400a7fa3">recvfrom</a>(<span class="keywordtype">int</span> sock, <span class="keywordtype">void</span> *buffer, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> flags,</div><div class="line"><a name="l00396"></a><span class="lineno"> 396</span>  <span class="keyword">struct</span> <a class="code" href="structsockaddr.html">sockaddr</a> *address, <a class="code" href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514">socklen_t</a> *address_len);</div><div class="line"><a name="l00397"></a><span class="lineno"> 397</span> </div><div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1646 */</span></div><div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"></span></div><div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment">/**</span></div><div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> * @ingroup anisSockIO</span></div><div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> *</span></div><div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment"> * Send a message.</span></div><div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="comment"> *</span></div><div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="comment"> * The function sendto() sends the message of length \a length given in \a</span></div><div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="comment"> * message using the socket \a sock to the destination \a dest_addr. If the</span></div><div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="comment"> * peer address \a address is the limited broadcast address (i.e. \c</span></div><div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="comment"> * 255.255.255.255), the message is send to the directed broadcast address</span></div><div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="comment"> * of the local network the socket is bound to.</span></div><div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="comment"> *</span></div><div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment"> * If the sending socket is bound to \c INADDR_ANY the outgoing device is</span></div><div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * selected by the ANIS. In case of multicast message the outgoing interface</span></div><div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * can be set via \c IP_MULTICAST_IF, or the interface is selected based on</span></div><div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * the group membership registration via \c IP_ADD_MEMBERSHIP. If none of</span></div><div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> * above succeeds the message is sent out via 1st configured interface.</span></div><div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> *</span></div><div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment"> * If ANIS does not have sufficient resources to send the message and the \c</span></div><div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment"> * MSG_DONTWAIT flag is not set in \a flags, the sendto() function will block</span></div><div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> * until resources become available. If the flag is set, the function</span></div><div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> * returns immediately in this case with an error.</span></div><div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"> *</span></div><div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> * @param[in] sock</span></div><div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment"> * the socket descriptor to be used for sending</span></div><div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"> *</span></div><div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment"> * @param[in] message</span></div><div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> * the buffer used to store the message to be send</span></div><div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> *</span></div><div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> * @param[in] length</span></div><div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> * the size of the message stored in \a message</span></div><div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> *</span></div><div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> * @param[in] flags</span></div><div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> * send semantics; either zero or \c MSG_DONTWAIT</span></div><div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> *</span></div><div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment"> * @param[in] dest_addr</span></div><div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> * the destination address of the message</span></div><div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> *</span></div><div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment"> * @param[in] dest_len</span></div><div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="comment"> * the length in bytes of the \a dest_addr buffer</span></div><div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment"> *</span></div><div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> * On success sendto() returns the number of bytes sent.</span></div><div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment"> *</span></div><div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment"> * an internal error occurred or a call to a PikeOS API function failed.</span></div><div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"> * The reasons include uninitialized thread local storage or \a message</span></div><div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment"> * not entirely mapped.</span></div><div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="comment"> *</span></div><div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="comment"> * \a sock is not a valid socket descriptor</span></div><div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment"> *</span></div><div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="comment"> * @retval ANIS_E_INTR</span></div><div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="comment"> * \a sock is closed whilst blocking</span></div><div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="comment"> *</span></div><div class="line"><a name="l00456"></a><span class="lineno"> 456</span> <span class="comment"> * @retval ANIS_E_STATE</span></div><div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment"> * \a sock is not bound</span></div><div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment"> *</span></div><div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment"> * unsupported flags are set in \a flags</span></div><div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> *</span></div><div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> * @retval ANIS_E_FAULT</span></div><div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"> * \a dest_len is not equal to the size, in bytes, of a struct sockaddr_in</span></div><div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> *</span></div><div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment"> * @retval ANIS_E_RANGE</span></div><div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment"> * \a length is greater than the maximum message size of 65507 bytes</span></div><div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"> *</span></div><div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"> * @retval ANIS_E_AGAIN</span></div><div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> * ANIS does not have sufficient resource to send the message and the</span></div><div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"> * \c MSG_DONTWAIT flag is set in \a flags</span></div><div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> *</span></div><div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> */</span></div><div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <a class="code" href="group__anisSocket.html#ga831c6b6852c6d34448e30a88c34539fd">ssize_t</a> <a class="code" href="group__anisSocket.html#ga6c003ac52dd776a8fcd5839b71aabd6f">sendto</a>(<span class="keywordtype">int</span> sock, <span class="keyword">const</span> <span class="keywordtype">void</span> *message, <span class="keywordtype">size_t</span> length, <span class="keywordtype">int</span> flags,</div><div class="line"><a name="l00474"></a><span class="lineno"> 474</span>  <span class="keyword">struct</span> <a class="code" href="structsockaddr.html">sockaddr</a> *dest_addr, <a class="code" href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514">socklen_t</a> dest_len);</div><div class="line"><a name="l00475"></a><span class="lineno"> 475</span> </div><div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1619 */</span></div><div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment"></span></div><div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment">/**</span></div><div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"> * @ingroup anisSockConf</span></div><div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment"> *</span></div><div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="comment"> * Retrieve local address of socket.</span></div><div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="comment"> *</span></div><div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="comment"> * Retrieve the local address the socket \a sock is bound to and store it in</span></div><div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="comment"> * \a address. The parameter \a address_len must contain the length of the</span></div><div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="comment"> * buffer provided in \a address when this function is called. If the given</span></div><div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="comment"> * socket is bound, getsockname() will set \a address_len to the amount of</span></div><div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="comment"> * bytes written into \a address. If the given socket is not bound,</span></div><div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="comment"> * getsockname() will set \a address_len to zero.</span></div><div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="comment"> *</span></div><div class="line"><a name="l00492"></a><span class="lineno"> 492</span> <span class="comment"> * @param[in] sock</span></div><div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="comment"> * the socket descriptor whose local address shall be retrieved</span></div><div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment"> *</span></div><div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment"> * @param[out] address</span></div><div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment"> * the local address of the socket \a sock</span></div><div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> *</span></div><div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> * @param[in,out] address_len</span></div><div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"> * the length of the buffer provided in \a address when called; the length</span></div><div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> * of the address upon return (if bound) or 0 (if not bound)</span></div><div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> *</span></div><div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> * On success the function returns ANIS_E_OK.</span></div><div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> *</span></div><div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> * \a address_len is less than the size, in bytes, of a struct sockaddr_in.</span></div><div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> *</span></div><div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> * \a sock is not a valid socket descriptor</span></div><div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> *</span></div><div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> * ANIS wasn't initialized</span></div><div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> *</span></div><div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment"> * an internal error occurred or a call to a PikeOS API function failed</span></div><div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="comment"> *</span></div><div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"> * @sa bind()</span></div><div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> */</span></div><div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="keywordtype">int</span> <a class="code" href="group__anisSocket.html#ga4a212f13ad447d189ed40be8c6a2b97e">getsockname</a>(<span class="keywordtype">int</span> sock, <span class="keyword">struct</span> <a class="code" href="structsockaddr.html">sockaddr</a> *address, <a class="code" href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514">socklen_t</a> *address_len);</div><div class="line"><a name="l00520"></a><span class="lineno"> 520</span> </div><div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1590 */</span></div><div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"></span></div><div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment">/**</span></div><div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> * @ingroup anisSockConf</span></div><div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> *</span></div><div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> * Retrieve socket options.</span></div><div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> *</span></div><div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> * Retrieve options of a socket. Upon success 0 is returned. If an error</span></div><div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> * occurred the function returns -1 and sets errno.</span></div><div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> * Parameter \a level defines protocol level. Two</span></div><div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> * groups \c SOL_SOCKET and \c IPPROTO_IP are supported.</span></div><div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"> *</span></div><div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"> * Supported option_names for \c SOL_SOCKET are following</span></div><div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"> * \li \c SO_TYPE: The type of the socket; with ANIS this is always</span></div><div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"> * SOCK_DGRAM.</span></div><div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"> * \li \c SO_RCVBUF: The current limit of the sockets receive buffer</span></div><div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"> * in bytes.</span></div><div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment"> *</span></div><div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"> * Supported option_names for \c IPPROTO_IP are following.</span></div><div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"> * \li \c IP_MULTICAST_TTL: Get the time-to-live value of outgoing multicast</span></div><div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> * packets for this socket. Argument is an integer.</span></div><div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> * \li \c IP_MULTICAST_LOOP: Get boolean integer argument that determines</span></div><div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"> * whether sent multicast packets should be looped back to the local socket.</span></div><div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"> *</span></div><div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> * @param[in] sock</span></div><div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> * the socket descriptor whose options shall be retrieved</span></div><div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"> *</span></div><div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> * @param[in] level</span></div><div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"> * the protocol level; only SOL_SOCKET is supported</span></div><div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"> *</span></div><div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"> * @param[in] option_name</span></div><div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> * which option to retrieve; supported are SO_TYPE and SO_RCVBUF</span></div><div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> *</span></div><div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"> * @param[out] option_value</span></div><div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"> * the value of the option</span></div><div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> *</span></div><div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> * @param[in,out] option_len</span></div><div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"> * size of the buffer passed in \a option_value on input; size of the</span></div><div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"> * retrieved value on output</span></div><div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"> *</span></div><div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"> * On success the function returns ANIS_E_OK.</span></div><div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"> *</span></div><div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> * @retval ANIS_E_OPNOTSUPP</span></div><div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="comment"> * \a level is not SOL_SOCKET</span></div><div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"> *</span></div><div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> * @retval ANIS_E_NOPROTOOPT</span></div><div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> * \a option_name is neither SO_RCVBUF nor SO_TYPE</span></div><div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> *</span></div><div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> * the input value of \a option_len is less than the size of the output</span></div><div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> * option value</span></div><div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"> *</span></div><div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> * \a sock is not a valid socket descriptor</span></div><div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment"> *</span></div><div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> * ANIS wasn't initialized</span></div><div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> *</span></div><div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> * an internal error occurred or a call to a PikeOS API function failed</span></div><div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> *</span></div><div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> * @sa setsockopt()</span></div><div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> */</span></div><div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="keywordtype">int</span> <a class="code" href="group__anisSocket.html#ga47c80c862fe07a40c925011fe3f5da1e">getsockopt</a>(<span class="keywordtype">int</span> sock, <span class="keywordtype">int</span> level, <span class="keywordtype">int</span> option_name,</div><div class="line"><a name="l00588"></a><span class="lineno"> 588</span>  <span class="keywordtype">void</span> *option_value, <a class="code" href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514">socklen_t</a> *option_len);</div><div class="line"><a name="l00589"></a><span class="lineno"> 589</span> </div><div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1606 */</span></div><div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"></span></div><div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment">/**</span></div><div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> * @ingroup anisSockConf</span></div><div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> *</span></div><div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"> * Set socket options.</span></div><div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment"> *</span></div><div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment"> * Set options of a socket. Parameter \a level defines protocol level. Two</span></div><div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment"> * groups \c SOL_SOCKET and \c IPPROTO_IP are supported.</span></div><div class="line"><a name="l00601"></a><span class="lineno"> 601</span> <span class="comment"> *</span></div><div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment"> * Supported options for \c SOL_SOCKET are following.</span></div><div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"> * \li \c SO_RCVBUF: If the value provided in the \c int object referenced by</span></div><div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"> * \a option_value is \c ANIS_RCVBUF_NO_LIMIT the limit of the sockets \a</span></div><div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> * socket receive buffer is set to unlimited. Otherwise it is set to the</span></div><div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> * given value in bytes, rounded up to a multiple of the MTU. If zero value</span></div><div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"> * is provided as input value no reception buffers are assigned to the</span></div><div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"> * socket. Each time packet is received the whole MTU size (one mbuf) is</span></div><div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> * taken from the pool of assigned buffers. In case of setting limit to the</span></div><div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"> * lower value than the count of the currently occupied reception buffers,</span></div><div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> * no buffer is released, and the limit is applied to all the new messages.</span></div><div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> * \li \c SO_REUSEADDR: Indicates that the rules used in validating addresses</span></div><div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"> * supplied in a bind() call should allow reuse of local addresses. For</span></div><div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment"> * PF_INET sockets this means that a socket may always bind. Argument is an</span></div><div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment"> * integer boolean flag.</span></div><div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="comment"> * \li \c SO_FLUSH_ARP: Flush ARP record for the given IP together with all</span></div><div class="line"><a name="l00617"></a><span class="lineno"> 617</span> <span class="comment"> * the packets scheduled to send to the destination IP. Expected is struct</span></div><div class="line"><a name="l00618"></a><span class="lineno"> 618</span> <span class="comment"> * in_addr value in the network order representing IP. If there is already</span></div><div class="line"><a name="l00619"></a><span class="lineno"> 619</span> <span class="comment"> * ongoing write of the packet to the Ethernet driver to the destination IP,</span></div><div class="line"><a name="l00620"></a><span class="lineno"> 620</span> <span class="comment"> * the packet is not dropped, but it is sent with the resolved MAC address</span></div><div class="line"><a name="l00621"></a><span class="lineno"> 621</span> <span class="comment"> * from the time before ARP record flush. The SO_FLUSH_ARP option is an ANIS-specific</span></div><div class="line"><a name="l00622"></a><span class="lineno"> 622</span> <span class="comment"> * addition to the socket API and may be disabled by a configuration option.</span></div><div class="line"><a name="l00623"></a><span class="lineno"> 623</span> <span class="comment"> *</span></div><div class="line"><a name="l00624"></a><span class="lineno"> 624</span> <span class="comment"> * In case several sockets are being bind to the same IP:PORT, SO_REUSEADDR</span></div><div class="line"><a name="l00625"></a><span class="lineno"> 625</span> <span class="comment"> * needs to be set latest before 2nd bind to the 2nd socket.</span></div><div class="line"><a name="l00626"></a><span class="lineno"> 626</span> <span class="comment"> *</span></div><div class="line"><a name="l00627"></a><span class="lineno"> 627</span> <span class="comment"> * If there are several sockets bound to the same IP:PORT pair, the unicast</span></div><div class="line"><a name="l00628"></a><span class="lineno"> 628</span> <span class="comment"> * messages are delivered only to the one target socket, the first one</span></div><div class="line"><a name="l00629"></a><span class="lineno"> 629</span> <span class="comment"> * bound. And if there are not enough buffers available due to reception</span></div><div class="line"><a name="l00630"></a><span class="lineno"> 630</span> <span class="comment"> * buffer limit set, the message is discarded even there are other sockets</span></div><div class="line"><a name="l00631"></a><span class="lineno"> 631</span> <span class="comment"> * with valid IP:PORT. In case of Multicast traffic the message is delivered</span></div><div class="line"><a name="l00632"></a><span class="lineno"> 632</span> <span class="comment"> * to all the socket within the same group and with sufficient reception</span></div><div class="line"><a name="l00633"></a><span class="lineno"> 633</span> <span class="comment"> * buffers. In case of the Broadcast traffic the message is delivered to all</span></div><div class="line"><a name="l00634"></a><span class="lineno"> 634</span> <span class="comment"> * the sockets bound to the target segment IP:PORT and with sufficient</span></div><div class="line"><a name="l00635"></a><span class="lineno"> 635</span> <span class="comment"> * reception buffers.</span></div><div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment"> *</span></div><div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment"> * Supported options for \c IPPROTO_IP are following.</span></div><div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment"> * \li \c IP_ADD_MEMBERSHIP: Join a multicast group. Argument is an ip_mreq</span></div><div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment"> * structure. Local interface IP or INADDR_ANY can be provided as interface</span></div><div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment"> * address. If INADDR_ANY is used 1st configured interface in the system is</span></div><div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment"> * used as outgoing device. This can be later changed by the IP_MULTICAST_IF</span></div><div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment"> * option. Each unique group can be added just once to the socket.</span></div><div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment"> * \li \c IP_DROP_MEMBERSHIP: Leave a multicast group. Argument is an</span></div><div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="comment"> * ip_mreq structure, where member "imr_interface" is ignored.</span></div><div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="comment"> * \li \c IP_MULTICAST_TTL: Set the time-to-live value of outgoing multicast</span></div><div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="comment"> * packets for this socket. It is very important for multicast packets to</span></div><div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment"> * set the smallest TTL possible. The default is 1 which means that</span></div><div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment"> * multicast packets don't leave the local network unless the user program</span></div><div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment"> * explicitly requests it. Argument is an integer.</span></div><div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"> * \li \c IP_MULTICAST_IF: Set the local device for a multicast socket.</span></div><div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment"> * Argument is an ip_mreq structure, the same one as for IP_ADD_MEMBERSHIP.</span></div><div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> * Only member 'imr_interface' needs to be specified, other members are</span></div><div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"> * ignored.</span></div><div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> * \li \c IP_MULTICAST_LOOP: Set a boolean integer argument that determines</span></div><div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> * whether sent multicast packets should be looped back to the local sockets.</span></div><div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> * Multicast loop is enabled by default on newly created sockets.\n</span></div><div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> * Example:\n sockA (MC loop false, group X), SockB (MC loop true,</span></div><div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"> * group X) > sendto(sockA) > Message is not received by any socket.\n</span></div><div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> * sockA(MC loop false, group X), SockB (MC loop true, group X) ></span></div><div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment"> * sendto(sockB) > Messages is received back by sockB and SockA sockets.</span></div><div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment"> *</span></div><div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="comment"> * @param[in] sock</span></div><div class="line"><a name="l00663"></a><span class="lineno"> 663</span> <span class="comment"> * the socket descriptor whose options shall be set</span></div><div class="line"><a name="l00664"></a><span class="lineno"> 664</span> <span class="comment"> *</span></div><div class="line"><a name="l00665"></a><span class="lineno"> 665</span> <span class="comment"> * @param[in] level</span></div><div class="line"><a name="l00666"></a><span class="lineno"> 666</span> <span class="comment"> * the protocol level</span></div><div class="line"><a name="l00667"></a><span class="lineno"> 667</span> <span class="comment"> *</span></div><div class="line"><a name="l00668"></a><span class="lineno"> 668</span> <span class="comment"> * @param[in] option_name</span></div><div class="line"><a name="l00669"></a><span class="lineno"> 669</span> <span class="comment"> * which option to set</span></div><div class="line"><a name="l00670"></a><span class="lineno"> 670</span> <span class="comment"> *</span></div><div class="line"><a name="l00671"></a><span class="lineno"> 671</span> <span class="comment"> * @param[in] option_value</span></div><div class="line"><a name="l00672"></a><span class="lineno"> 672</span> <span class="comment"> * the new value of the option</span></div><div class="line"><a name="l00673"></a><span class="lineno"> 673</span> <span class="comment"> *</span></div><div class="line"><a name="l00674"></a><span class="lineno"> 674</span> <span class="comment"> * @param[in] option_len</span></div><div class="line"><a name="l00675"></a><span class="lineno"> 675</span> <span class="comment"> * size of the buffer passed in \a option_value</span></div><div class="line"><a name="l00676"></a><span class="lineno"> 676</span> <span class="comment"> *</span></div><div class="line"><a name="l00677"></a><span class="lineno"> 677</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00678"></a><span class="lineno"> 678</span> <span class="comment"> * On success the function returns ANIS_E_OK</span></div><div class="line"><a name="l00679"></a><span class="lineno"> 679</span> <span class="comment"> *</span></div><div class="line"><a name="l00680"></a><span class="lineno"> 680</span> <span class="comment"> * @retval ANIS_E_OPNOTSUPP</span></div><div class="line"><a name="l00681"></a><span class="lineno"> 681</span> <span class="comment"> * \a level is not \c SOL_SOCKET nor \c IPPROTO_IP</span></div><div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="comment"> *</span></div><div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="comment"> * @retval ANIS_E_NOPROTOOPT</span></div><div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment"> * \a option_name is none of supported ones</span></div><div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment"> *</span></div><div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> * @retval ANIS_E_INVAL</span></div><div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment"> *</span></div><div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"> * \a option_len is not equal to the size of bytes of the object referenced</span></div><div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> * by \a option_value. Or the provided input values are out of allowed input</span></div><div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"> * range. Or socket is already member of the provided group. Or there is no</span></div><div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment"> * space for more groups to be added. Or there is no ARP record for given IP</span></div><div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> * to FLUSH. Or the ARP table is static.</span></div><div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"> *</span></div><div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment"> * @retval ANIS_E_PERM</span></div><div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment"> * SO_FLUSH_ARP is not allowed by the configuration.</span></div><div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment"> *</span></div><div class="line"><a name="l00697"></a><span class="lineno"> 697</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment"> * \a sock is not a valid socket descriptor</span></div><div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment"> *</span></div><div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00701"></a><span class="lineno"> 701</span> <span class="comment"> * ANIS wasn't initialized</span></div><div class="line"><a name="l00702"></a><span class="lineno"> 702</span> <span class="comment"> *</span></div><div class="line"><a name="l00703"></a><span class="lineno"> 703</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00704"></a><span class="lineno"> 704</span> <span class="comment"> * an internal error occurred or a call to a PikeOS API function failed</span></div><div class="line"><a name="l00705"></a><span class="lineno"> 705</span> <span class="comment"> *</span></div><div class="line"><a name="l00706"></a><span class="lineno"> 706</span> <span class="comment"> * @sa getsockopt()</span></div><div class="line"><a name="l00707"></a><span class="lineno"> 707</span> <span class="comment"> */</span></div><div class="line"><a name="l00708"></a><span class="lineno"> 708</span> <span class="keywordtype">int</span> <a class="code" href="group__anisSocket.html#gaa793cb578eb781d7b08eee22de58ca23">setsockopt</a>(<span class="keywordtype">int</span> sock, <span class="keywordtype">int</span> level, <span class="keywordtype">int</span> option_name,</div><div class="line"><a name="l00709"></a><span class="lineno"> 709</span>  <span class="keyword">const</span> <span class="keywordtype">void</span> *option_value, <a class="code" href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514">socklen_t</a> option_len);</div><div class="line"><a name="l00710"></a><span class="lineno"> 710</span> </div><div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1661 */</span></div><div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment"></span></div><div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment">/**</span></div><div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment"> * @purpose</span></div><div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="comment"> * Close a socket.</span></div><div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment"> *</span></div><div class="line"><a name="l00717"></a><span class="lineno"> 717</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00718"></a><span class="lineno"> 718</span> <span class="comment"> * This function frees the socket object allocated to the socket in the ANIS</span></div><div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment"> * API and sends a socket close request to ANISFP, which will also release</span></div><div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="comment"> * all resources allocated to the socket.</span></div><div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="comment"> *</span></div><div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment"> * @param[in] sock</span></div><div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment"> * the socket to close</span></div><div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment"> *</span></div><div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment"> * On success the function returns ANIS_E_OK.</span></div><div class="line"><a name="l00727"></a><span class="lineno"> 727</span> <span class="comment"> *</span></div><div class="line"><a name="l00728"></a><span class="lineno"> 728</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="comment"> * \a sock is not a valid socket descriptor</span></div><div class="line"><a name="l00730"></a><span class="lineno"> 730</span> <span class="comment"> *</span></div><div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="comment"> * @retval ANIS_E_BADF</span></div><div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment"> * ANIS wasn't initialized</span></div><div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="comment"> *</span></div><div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="comment"> * @retval ANIS_E_SYS</span></div><div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="comment"> * an internal error occurred or a call to a PikeOS API function failed</span></div><div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="comment"> */</span></div><div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="keywordtype">int</span> <a class="code" href="group__anisSocket.html#ga47ce203bdefb2984d6f167b3090c9216">socket_close</a>(<span class="keywordtype">int</span> sock);</div><div class="line"><a name="l00738"></a><span class="lineno"> 738</span> </div><div class="line"><a name="l00739"></a><span class="lineno"> 739</span> <span class="comment">/* Endian handling functions. */</span></div><div class="line"><a name="l00740"></a><span class="lineno"> 740</span> <span class="comment"></span></div><div class="line"><a name="l00741"></a><span class="lineno"> 741</span> <span class="comment">/**</span></div><div class="line"><a name="l00742"></a><span class="lineno"> 742</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00743"></a><span class="lineno"> 743</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00744"></a><span class="lineno"> 744</span> <span class="comment"> * Convert a short integer value \a x from network to host byte order.</span></div><div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="comment"> *</span></div><div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="comment"> * @param[in] x Short integer value to convert.</span></div><div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="comment"> *</span></div><div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00749"></a><span class="lineno"> 749</span> <span class="comment"> * The function returns the representation of \a x in host byte order.</span></div><div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="comment"> */</span></div><div class="line"><a name="l00751"></a><span class="lineno"> 751</span> </div><div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1553 */</span></div><div class="line"><a name="l00753"></a><span class="lineno"> 753</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1555 */</span></div><div class="line"><a name="l00754"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gada37feda716b4ba89cf9dba34288141d"> 754</a></span> <span class="preprocessor">#define ntohs(x) ((P4_uint16_t)anisNTOHS((P4_uint16_t)(x)))</span></div><div class="line"><a name="l00755"></a><span class="lineno"> 755</span> <span class="comment"></span></div><div class="line"><a name="l00756"></a><span class="lineno"> 756</span> <span class="comment">/**</span></div><div class="line"><a name="l00757"></a><span class="lineno"> 757</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00759"></a><span class="lineno"> 759</span> <span class="comment"> * Convert a long integer value \a x from network to host byte order.</span></div><div class="line"><a name="l00760"></a><span class="lineno"> 760</span> <span class="comment"> *</span></div><div class="line"><a name="l00761"></a><span class="lineno"> 761</span> <span class="comment"> * @param[in] x Long integer value to convert.</span></div><div class="line"><a name="l00762"></a><span class="lineno"> 762</span> <span class="comment"> *</span></div><div class="line"><a name="l00763"></a><span class="lineno"> 763</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00764"></a><span class="lineno"> 764</span> <span class="comment"> * The function returns the representation of \a x in host byte order.</span></div><div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="comment"> */</span></div><div class="line"><a name="l00766"></a><span class="lineno"> 766</span> </div><div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1557 */</span></div><div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1559 */</span></div><div class="line"><a name="l00769"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gac317b3e903719ba02894f1710f7f2439"> 769</a></span> <span class="preprocessor">#define ntohl(x) ((P4_uint32_t)anisNTOHL((P4_uint32_t)(x)))</span></div><div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment"></span></div><div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment">/**</span></div><div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00773"></a><span class="lineno"> 773</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00774"></a><span class="lineno"> 774</span> <span class="comment"> * Convert a long long integer value \a x from network to host byte order.</span></div><div class="line"><a name="l00775"></a><span class="lineno"> 775</span> <span class="comment"> *</span></div><div class="line"><a name="l00776"></a><span class="lineno"> 776</span> <span class="comment"> * @param[in] x Long Long integer value to convert.</span></div><div class="line"><a name="l00777"></a><span class="lineno"> 777</span> <span class="comment"> *</span></div><div class="line"><a name="l00778"></a><span class="lineno"> 778</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00779"></a><span class="lineno"> 779</span> <span class="comment"> * The function returns the representation of \a x in host byte order.</span></div><div class="line"><a name="l00780"></a><span class="lineno"> 780</span> <span class="comment"> */</span></div><div class="line"><a name="l00781"></a><span class="lineno"> 781</span> </div><div class="line"><a name="l00782"></a><span class="lineno"> 782</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-3189 */</span></div><div class="line"><a name="l00783"></a><span class="lineno"> 783</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-3191 */</span></div><div class="line"><a name="l00784"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga3cfcf123d4ead264289232f91f2c9ca5"> 784</a></span> <span class="preprocessor">#define ntohll(x) ((P4_uint64_t)anisNTOHLL((P4_uint64_t)(x)))</span></div><div class="line"><a name="l00785"></a><span class="lineno"> 785</span> <span class="comment"></span></div><div class="line"><a name="l00786"></a><span class="lineno"> 786</span> <span class="comment">/**</span></div><div class="line"><a name="l00787"></a><span class="lineno"> 787</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00788"></a><span class="lineno"> 788</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00789"></a><span class="lineno"> 789</span> <span class="comment"> * Convert a short integer value \a x from host to network byte order.</span></div><div class="line"><a name="l00790"></a><span class="lineno"> 790</span> <span class="comment"> *</span></div><div class="line"><a name="l00791"></a><span class="lineno"> 791</span> <span class="comment"> * @param[in] x Short integer value to convert.</span></div><div class="line"><a name="l00792"></a><span class="lineno"> 792</span> <span class="comment"> *</span></div><div class="line"><a name="l00793"></a><span class="lineno"> 793</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00794"></a><span class="lineno"> 794</span> <span class="comment"> * The function returns the representation of \a x in network byte order.</span></div><div class="line"><a name="l00795"></a><span class="lineno"> 795</span> <span class="comment"> */</span></div><div class="line"><a name="l00796"></a><span class="lineno"> 796</span> </div><div class="line"><a name="l00797"></a><span class="lineno"> 797</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1545 */</span></div><div class="line"><a name="l00798"></a><span class="lineno"> 798</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1547 */</span></div><div class="line"><a name="l00799"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga51799f5ebb4c7228ef7e95c247030f42"> 799</a></span> <span class="preprocessor">#define htons(x) ((P4_uint16_t)anisHTONS((P4_uint16_t)(x)))</span></div><div class="line"><a name="l00800"></a><span class="lineno"> 800</span> <span class="comment"></span></div><div class="line"><a name="l00801"></a><span class="lineno"> 801</span> <span class="comment">/**</span></div><div class="line"><a name="l00802"></a><span class="lineno"> 802</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00803"></a><span class="lineno"> 803</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00804"></a><span class="lineno"> 804</span> <span class="comment"> * Convert a long integer value \a x from host to network byte order.</span></div><div class="line"><a name="l00805"></a><span class="lineno"> 805</span> <span class="comment"> *</span></div><div class="line"><a name="l00806"></a><span class="lineno"> 806</span> <span class="comment"> * @param[in] x Long integer value to convert.</span></div><div class="line"><a name="l00807"></a><span class="lineno"> 807</span> <span class="comment"> *</span></div><div class="line"><a name="l00808"></a><span class="lineno"> 808</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="comment"> * The function returns the representation of \a x in network byte order.</span></div><div class="line"><a name="l00810"></a><span class="lineno"> 810</span> <span class="comment"> */</span></div><div class="line"><a name="l00811"></a><span class="lineno"> 811</span> </div><div class="line"><a name="l00812"></a><span class="lineno"> 812</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1549 */</span></div><div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1551 */</span></div><div class="line"><a name="l00814"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gae4027a6ad07f13aa12eab285a1b46019"> 814</a></span> <span class="preprocessor">#define htonl(x) ((P4_uint32_t)anisHTONL((P4_uint32_t)(x)))</span></div><div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="comment"></span></div><div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="comment">/**</span></div><div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00819"></a><span class="lineno"> 819</span> <span class="comment"> * Convert a long long integer value \a x from host to network byte order.</span></div><div class="line"><a name="l00820"></a><span class="lineno"> 820</span> <span class="comment"> *</span></div><div class="line"><a name="l00821"></a><span class="lineno"> 821</span> <span class="comment"> * @param[in] x Long long integer value to convert.</span></div><div class="line"><a name="l00822"></a><span class="lineno"> 822</span> <span class="comment"> *</span></div><div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="comment"> * @returns</span></div><div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="comment"> * The function returns the representation of \a x in network byte order.</span></div><div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="comment"> */</span></div><div class="line"><a name="l00826"></a><span class="lineno"> 826</span> </div><div class="line"><a name="l00827"></a><span class="lineno"> 827</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-3185 */</span></div><div class="line"><a name="l00828"></a><span class="lineno"> 828</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-3187 */</span></div><div class="line"><a name="l00829"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga9f4bf0773c45ad9a9753a1b784a13fbb"> 829</a></span> <span class="preprocessor">#define htonll(x) ((P4_uint64_t)anisHTONLL((P4_uint64_t)(x)))</span></div><div class="line"><a name="l00830"></a><span class="lineno"> 830</span> <span class="comment"></span></div><div class="line"><a name="l00831"></a><span class="lineno"> 831</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00832"></a><span class="lineno"> 832</span> </div><div class="line"><a name="l00833"></a><span class="lineno"> 833</span> <span class="preprocessor">#endif </span><span class="comment">/*SOCKET_H*/</span><span class="preprocessor"></span></div><div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5ae67a0077e7c3ba204bf549d1cbdc71c9"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5ae67a0077e7c3ba204bf549d1cbdc71c9">ANIS_E_PROTOTYPE</a></div><div class="ttdef"><b>Definition:</b> socket.h:92</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a7ae663416da47cef5496f3fd5faa1ae4"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a7ae663416da47cef5496f3fd5faa1ae4">ANIS_E_AFNOSUPPORT</a></div><div class="ttdef"><b>Definition:</b> socket.h:88</div></div>
|
|
<div class="ttc" id="socket_8h_html_a0cc7aad3029b5e8db64b12dd63599c81"><div class="ttname"><a href="socket_8h.html#a0cc7aad3029b5e8db64b12dd63599c81">uint32_t</a></div><div class="ttdeci">P4_uint32_t uint32_t</div><div class="ttdef"><b>Definition:</b> socket.h:46</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a429cb2e154e9aecdac90ef50d6a69044"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a429cb2e154e9aecdac90ef50d6a69044">ANIS_E_MSGSIZE</a></div><div class="ttdef"><b>Definition:</b> socket.h:114</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gacf18a0d6c4b39d531e021702e9a77984"><div class="ttname"><a href="group__anisSocket.html#gacf18a0d6c4b39d531e021702e9a77984">size_t</a></div><div class="ttdeci">unsigned long size_t</div><div class="ttdoc">Unsigned long data type to hold the size of a message. </div><div class="ttdef"><b>Definition:</b> socket.h:154</div></div>
|
|
<div class="ttc" id="socket_8h_html_a0ff56c581dfb6cf3a5e20721148464db"><div class="ttname"><a href="socket_8h.html#a0ff56c581dfb6cf3a5e20721148464db">uint16_t</a></div><div class="ttdeci">P4_uint16_t uint16_t</div><div class="ttdef"><b>Definition:</b> socket.h:38</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gaf4e0711877c45a41168ac677b0670ccd"><div class="ttname"><a href="group__anisSocket.html#gaf4e0711877c45a41168ac677b0670ccd">socket</a></div><div class="ttdeci">int socket(int domain, int type, int protocol)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga318aa8bcb1857ddf776ffce53ac8252a"><div class="ttname"><a href="group__anisSocket.html#ga318aa8bcb1857ddf776ffce53ac8252a">bind</a></div><div class="ttdeci">int bind(int sock, struct sockaddr *address, socklen_t address_len)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gaa793cb578eb781d7b08eee22de58ca23"><div class="ttname"><a href="group__anisSocket.html#gaa793cb578eb781d7b08eee22de58ca23">setsockopt</a></div><div class="ttdeci">int setsockopt(int sock, int level, int option_name, const void *option_value, socklen_t option_len)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5af2d8bf5e0fd6e0acb08466022e2bd93a"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5af2d8bf5e0fd6e0acb08466022e2bd93a">ANIS_E_OPNOTSUPP</a></div><div class="ttdef"><b>Definition:</b> socket.h:106</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga831c6b6852c6d34448e30a88c34539fd"><div class="ttname"><a href="group__anisSocket.html#ga831c6b6852c6d34448e30a88c34539fd">ssize_t</a></div><div class="ttdeci">long ssize_t</div><div class="ttdoc">Signed data type to hold the size of a message. </div><div class="ttdef"><b>Definition:</b> socket.h:143</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a0684400fdd07b379a2739ae374e5ce1f"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a0684400fdd07b379a2739ae374e5ce1f">ANIS_E_NOPROTOOPT</a></div><div class="ttdef"><b>Definition:</b> socket.h:108</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a7b2084bbb005e1ea00346b0a9727efa3"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a7b2084bbb005e1ea00346b0a9727efa3">ANIS_E_SYS</a></div><div class="ttdef"><b>Definition:</b> socket.h:122</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5aa6d065b68af15b15acac0bfc2efff0aa"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aa6d065b68af15b15acac0bfc2efff0aa">ANIS_E_ADDRNOTAVAIL</a></div><div class="ttdef"><b>Definition:</b> socket.h:102</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5afd5ffa60b9d5c90bd00703152f51fbd8"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5afd5ffa60b9d5c90bd00703152f51fbd8">ANIS_E_NO_FD</a></div><div class="ttdef"><b>Definition:</b> socket.h:128</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5aed1de229aed1013382b0ac9ee0cc1fde"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aed1de229aed1013382b0ac9ee0cc1fde">ANIS_E_STATE</a></div><div class="ttdef"><b>Definition:</b> socket.h:120</div></div>
|
|
<div class="ttc" id="socket_8h_html_a8bd44ed5ed915e56cef58aefdd91daeb"><div class="ttname"><a href="socket_8h.html#a8bd44ed5ed915e56cef58aefdd91daeb">uint64_t</a></div><div class="ttdeci">P4_uint64_t uint64_t</div><div class="ttdef"><b>Definition:</b> socket.h:54</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a9d8eb7623dfe5a59f1093879488392d2"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a9d8eb7623dfe5a59f1093879488392d2">ANIS_E_THRACTIVE</a></div><div class="ttdef"><b>Definition:</b> socket.h:130</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a9f77c517fa9fd5b772fd704185337bfe"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a9f77c517fa9fd5b772fd704185337bfe">ANIS_E_OK</a></div><div class="ttdef"><b>Definition:</b> socket.h:86</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga6b82106923cc13b3a9734520ecc29514"><div class="ttname"><a href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514">socklen_t</a></div><div class="ttdeci">int socklen_t</div><div class="ttdoc">Data type to represent the size of a struct sockaddr data type. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:221</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a53f8552d19283e602e6bb3b6aba6f9a7"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a53f8552d19283e602e6bb3b6aba6f9a7">ANIS_E_NO_MEM</a></div><div class="ttdef"><b>Definition:</b> socket.h:126</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga97bf3204b925dcc74344a0fe68fc6bb5"><div class="ttname"><a href="group__anisSocket.html#ga97bf3204b925dcc74344a0fe68fc6bb5">anis_error_e</a></div><div class="ttdeci">anis_error_e</div><div class="ttdoc">Error return codes of ANIS API functions. </div><div class="ttdef"><b>Definition:</b> socket.h:83</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a41c6127a55462871cd13b002661dd717"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a41c6127a55462871cd13b002661dd717">ANIS_E_INVAL</a></div><div class="ttdef"><b>Definition:</b> socket.h:104</div></div>
|
|
<div class="ttc" id="structsockaddr_html"><div class="ttname"><a href="structsockaddr.html">sockaddr</a></div><div class="ttdoc">Data type to handle addresses in an domain agnostic manner. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:326</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5addaf2fdec2d448748e96141a08a4ebc3"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5addaf2fdec2d448748e96141a08a4ebc3">ANIS_E_INTR</a></div><div class="ttdef"><b>Definition:</b> socket.h:124</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga6c003ac52dd776a8fcd5839b71aabd6f"><div class="ttname"><a href="group__anisSocket.html#ga6c003ac52dd776a8fcd5839b71aabd6f">sendto</a></div><div class="ttdeci">ssize_t sendto(int sock, const void *message, size_t length, int flags, struct sockaddr *dest_addr, socklen_t dest_len)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a6f59ed366481d228cc6540f23d791520"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a6f59ed366481d228cc6540f23d791520">ANIS_E_AGAIN</a></div><div class="ttdef"><b>Definition:</b> socket.h:112</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga3eeb75f358558b9e9d4ba9b58b08e676"><div class="ttname"><a href="group__anisSocket.html#ga3eeb75f358558b9e9d4ba9b58b08e676">anis_init</a></div><div class="ttdeci">int anis_init(const char *anisname, P4_uint32_t threadno)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga47c80c862fe07a40c925011fe3f5da1e"><div class="ttname"><a href="group__anisSocket.html#ga47c80c862fe07a40c925011fe3f5da1e">getsockopt</a></div><div class="ttdeci">int getsockopt(int sock, int level, int option_name, void *option_value, socklen_t *option_len)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gaaf00beb7b83dbe8d7832f088400a7fa3"><div class="ttname"><a href="group__anisSocket.html#gaaf00beb7b83dbe8d7832f088400a7fa3">recvfrom</a></div><div class="ttdeci">ssize_t recvfrom(int sock, void *buffer, size_t length, int flags, struct sockaddr *address, socklen_t *address_len)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5abb77ce5e4cb4b67a7a75a72c6a99f403"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5abb77ce5e4cb4b67a7a75a72c6a99f403">ANIS_E_ADDRINUSE</a></div><div class="ttdef"><b>Definition:</b> socket.h:98</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5acec189fcbf3da4ee5b4e5e107d98cb33"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5acec189fcbf3da4ee5b4e5e107d98cb33">ANIS_E_FAULT</a></div><div class="ttdef"><b>Definition:</b> socket.h:100</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a19c7b48903d186b0478464769fe04698"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a19c7b48903d186b0478464769fe04698">ANIS_E_SOCKTNOSUPPORT</a></div><div class="ttdef"><b>Definition:</b> socket.h:90</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga47ce203bdefb2984d6f167b3090c9216"><div class="ttname"><a href="group__anisSocket.html#ga47ce203bdefb2984d6f167b3090c9216">socket_close</a></div><div class="ttdeci">int socket_close(int sock)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5abf518a8d434669c0fce0cd5f67c9ffe7"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5abf518a8d434669c0fce0cd5f67c9ffe7">ANIS_E_BADF</a></div><div class="ttdef"><b>Definition:</b> socket.h:96</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5aa9442af4d1ee3fc37c6477ce2dadea6e"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5aa9442af4d1ee3fc37c6477ce2dadea6e">ANIS_E_NO_ENT</a></div><div class="ttdef"><b>Definition:</b> socket.h:116</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga4a212f13ad447d189ed40be8c6a2b97e"><div class="ttname"><a href="group__anisSocket.html#ga4a212f13ad447d189ed40be8c6a2b97e">getsockname</a></div><div class="ttdeci">int getsockname(int sock, struct sockaddr *address, socklen_t *address_len)</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5af8df4ecd651023b4c3b3ac997f4d7c4c"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5af8df4ecd651023b4c3b3ac997f4d7c4c">ANIS_E_RANGE</a></div><div class="ttdef"><b>Definition:</b> socket.h:110</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a09eb74bc73c673eafe0cb63958f60181"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a09eb74bc73c673eafe0cb63958f60181">ANIS_E_PERM</a></div><div class="ttdef"><b>Definition:</b> socket.h:118</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_gga97bf3204b925dcc74344a0fe68fc6bb5a40755f2243941e277d64a8538a7ed5b5"><div class="ttname"><a href="group__anisSocket.html#gga97bf3204b925dcc74344a0fe68fc6bb5a40755f2243941e277d64a8538a7ed5b5">ANIS_E_BUSY</a></div><div class="ttdef"><b>Definition:</b> socket.h:94</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_6865ef3f899aa5f8d7e6a15136678bc0.html">pikeos_api</a></li><li class="navelem"><a class="el" href="dir_432297b4b4c43d380d60f0580acbea43.html">include</a></li><li class="navelem"><a class="el" href="socket_8h.html">socket.h</a></li>
|
|
<li class="footer">(C) Copyright SYSGO AG</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|