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>
97 lines
59 KiB
HTML
97 lines
59 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_api_common.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__api__common_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_api_common.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="socket__api__common_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_API_COMMON_H</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define SOCKET_API_COMMON_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_api_common.h 2019-06-26 16:50:31 +0200 9bd2043845dae4ea990fd21346fd75c34f0754c9 $</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> <span class="preprocessor">#if !defined(_UINT16_T_DECLARED) || !defined(_UINT32_T_DECLARED) \</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"> || !defined(_UINT64_T_DECLARED)</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/* socket_api_common.h is included only from anisFP.h</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * and socket.h from PikeOS or POSIX ANIS API.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#error "uint16_t and/or uint32_t and/or uint64_t not declared!"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"></span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/**</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @addtogroup anisSocket</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> */</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/* ------------------- CONSTANT / MACRO DEFINITIONS ------------------------ */</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1518 */</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"></span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/**</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Constant to be used in socket() calls for the socket family.</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> */</span></div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga3f5da0b5be27fe31ec7cc11bfa8d1a25"> 50</a></span> <span class="preprocessor">#define PF_INET AF_INET</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"></span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/**</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * Type of a UDP socket.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> *</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * Set the type of a socket in socket() calls. The value \c SOCK_DGRAM is</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * used to create a socket for a packet based, unreliable connection like</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * UDP.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> */</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga4db8b9a846c67404db0b6f014f9a9fdf"> 62</a></span> <span class="preprocessor">#define SOCK_DGRAM 2</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1519 */</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"></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"> * @hideinitializer</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * Constant to be used in the sin_family member of struct sockaddr_in.</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> *</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * This constant is used to specify the address family "internet".</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"><a class="line" href="group__anisSocket.html#ga9930604d0e32588eae76f43ca38e7826"> 74</a></span> <span class="preprocessor">#define AF_INET 2</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></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"> * @hideinitializer</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * Constant to be used in bind() to receive datagrams from all interfaces.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> *</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * Binding to the special address \c INADDR_ANY allows a socket to receive</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * datagrams from any configured interface in the system, including localhost</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * loopback.</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> */</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#ifndef INADDR_ANY</span></div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga5d1940045dc2e7de552f3d4ff13a74ab"> 87</a></span> <span class="preprocessor">#define INADDR_ANY 0</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1521 */</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"></span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment">/**</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * Options for socket level.</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> *</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> */</span></div><div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga92d045f6ee2f343d6b28830a9fec082e"> 98</a></span> <span class="preprocessor">#define SOL_SOCKET 0xfff</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">/**</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * Options for IP level.</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> */</span></div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gabf96615d54d7d81630efc2e8f1770223"> 105</a></span> <span class="preprocessor">#define IPPROTO_IP 0</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"></span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">/**</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * Get socket type.</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> *</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> */</span></div><div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga8ab1e00e94a92737d3a4b407f7fa90f1"> 113</a></span> <span class="preprocessor">#define SO_TYPE 0x0004</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"></span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">/**</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * Get or set maximum mbuf usage of a socket for reception.</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> *</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> */</span></div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga0db12e960ac303030400d9fd95391b52"> 121</a></span> <span class="preprocessor">#define SO_RCVBUF 0x0008</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"></span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment">/**</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * Use of exact address matching at the binding time.</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> *</span></div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> */</span></div><div class="line"><a name="l00129"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga5589f74fada0d0cd47bd6ea8741a58ee"> 129</a></span> <span class="preprocessor">#define SO_REUSEADDR 0x0010</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"></span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">/**</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> * Force ARP record to flush</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"> */</span></div><div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga5599ccb4d9209da16a32262a764b1c67"> 137</a></span> <span class="preprocessor">#define SO_FLUSH_ARP 0x0020</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">/**</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * Add membership to a multicast group.</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> *</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> */</span></div><div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga924b1653500b7d3bf1bcef96a1a28431"> 145</a></span> <span class="preprocessor">#define IP_ADD_MEMBERSHIP 3</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">/**</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * Drop membership of a multicast group.</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> *</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> */</span></div><div class="line"><a name="l00153"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gad9e530e8ee1d2a001717d40d3aa26618"> 153</a></span> <span class="preprocessor">#define IP_DROP_MEMBERSHIP 4</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"></span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment">/**</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * Set TTL of the multicast messages on the given socket.</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> *</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> */</span></div><div class="line"><a name="l00161"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gabf2be8a26ec89482c3c440028aacc523"> 161</a></span> <span class="preprocessor">#define IP_MULTICAST_TTL 5</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"></span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">/**</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * Set outgoing interface for the multicast messages on the given socket.</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> *</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"><a class="line" href="group__anisSocket.html#ga95ac9ecdbd7845274e20667d3b42cd00"> 169</a></span> <span class="preprocessor">#define IP_MULTICAST_IF 6</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"></span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">/**</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @hideinitializer</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * Set loopback on the outgoing multicast traffic for the given socket.</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> *</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> */</span></div><div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga5481dc4543c45fa31bf769119057a259"> 177</a></span> <span class="preprocessor">#define IP_MULTICAST_LOOP 7</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1522 */</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"></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"> * @hideinitializer</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * Special value for the SO_RCVBUF option with the meaning unlimited.</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> *</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * If the SO_RCVBUF option of a socket is set to this value, there is no</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * limit on the maximum mbuf usage. This is the default for a newly created</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * socket.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> *</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> */</span></div><div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga02ea408a7ddb810fc4339cd0ec56fc02"> 192</a></span> <span class="preprocessor">#define ANIS_RCVBUF_NO_LIMIT 0xffffffffUL</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1761 */</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"></span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment">/**</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * Maximum length of an ANIS instance name.</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> */</span></div><div class="line"><a name="l00200"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga8062b93fe247ec94a5b8a1d703ff7377"> 200</a></span> <span class="preprocessor">#define ANIS_MAX_NAMELEN 32</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1523 */</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"></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"> * @hideinitializer</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * Flag used to select nonblocking I/O in sendto() and recvfrom().</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"> */</span></div><div class="line"><a name="l00210"></a><span class="lineno"><a class="line" href="group__anisSocket.html#gab18d3d439e4a9c8d0f73e7166e8eb376"> 210</a></span> <span class="preprocessor">#define MSG_DONTWAIT 0x08</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment">/* ------------------------ TYPE DECLARATIONS ------------------------------ */</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1585 */</span></div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1586 */</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">/**</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> * Data type to represent the size of a struct sockaddr data type.</span></div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> */</span></div><div class="line"><a name="l00221"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514"> 221</a></span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="group__anisSocket.html#ga6b82106923cc13b3a9734520ecc29514">socklen_t</a>;</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1212 */</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"></span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment">/**</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> * Data type to hold an IPv4 address.</span></div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> */</span></div><div class="line"><a name="l00229"></a><span class="lineno"><a class="line" href="structin__addr.html"> 229</a></span> <span class="keyword">struct </span><a class="code" href="structin__addr.html">in_addr</a> {<span class="comment"></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"> * @brief</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * An IPv4 address in network byte order.</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"> * @detailed</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> * This member contains an IPv4 address as defined in [RFC-791] or the</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment"> * special address INADDR_ANY in network byte order.</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> */</span></div><div class="line"><a name="l00238"></a><span class="lineno"><a class="line" href="structin__addr.html#a5abe94a260a50619a60ce111a59f00b5"> 238</a></span>  <a class="code" href="socket_8h.html#a0cc7aad3029b5e8db64b12dd63599c81">uint32_t</a> <a class="code" href="structin__addr.html#a5abe94a260a50619a60ce111a59f00b5">s_addr</a>;</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> };</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1224 */</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">/**</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * Data type to hold the socket type.</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"><a class="line" href="group__anisSocket.html#ga22bf2db06ebc5466014e637d419cef90"> 247</a></span> <span class="keyword">typedef</span> <a class="code" href="socket_8h.html#a0ff56c581dfb6cf3a5e20721148464db">uint16_t</a> <a class="code" href="group__anisSocket.html#ga22bf2db06ebc5466014e637d419cef90">sa_family_t</a>;</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="preprocessor">#ifndef _IN_PORT_T_DECLARED</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> </div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1735 */</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">/**</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> * Data type to hold a UDP port number.</span></div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> */</span></div><div class="line"><a name="l00257"></a><span class="lineno"><a class="line" href="group__anisSocket.html#ga979d51fa99f7145221b3ed1afff5b827"> 257</a></span> <span class="keyword">typedef</span> <a class="code" href="socket_8h.html#a0ff56c581dfb6cf3a5e20721148464db">uint16_t</a> <a class="code" href="group__anisSocket.html#ga979d51fa99f7145221b3ed1afff5b827">in_port_t</a>;<span class="comment"></span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment">/** @cond __PRIVATE */</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="preprocessor">#define _IN_PORT_T_DECLARED</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment">/** @endcond */</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> </div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1215 */</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"></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"> * @brief</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * Data type to store an PF_INET socket address.</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"><a class="line" href="structsockaddr__in.html"> 269</a></span> <span class="keyword">struct </span><a class="code" href="structsockaddr__in.html">sockaddr_in</a> {<span class="comment"></span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> /**</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * The address family this structure belongs to.</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> *</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> * This member is used to recognize a struct sockaddr_in element casted</span></div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> * to struct sockaddr. Its value is always set to PF_INET.</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> */</span></div><div class="line"><a name="l00278"></a><span class="lineno"><a class="line" href="structsockaddr__in.html#a9a7d98bb8e18f4a06a021c32d6cc7117"> 278</a></span>  <a class="code" href="group__anisSocket.html#ga22bf2db06ebc5466014e637d419cef90">sa_family_t</a> <a class="code" href="structsockaddr__in.html#a9a7d98bb8e18f4a06a021c32d6cc7117">sin_family</a>;</div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> </div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="comment">/* @SYSGO_RQ IF_ANIS-1220 */</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"></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"> * @brief</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> * The port part of the 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"> * @detailed</span></div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> * This member contains the UDP port part of the address in network byte</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * order.</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> */</span></div><div class="line"><a name="l00290"></a><span class="lineno"><a class="line" href="structsockaddr__in.html#ae89eef5c2b45ce0a177379755edecafa"> 290</a></span>  <a class="code" href="group__anisSocket.html#ga979d51fa99f7145221b3ed1afff5b827">in_port_t</a> <a class="code" href="structsockaddr__in.html#ae89eef5c2b45ce0a177379755edecafa">sin_port</a>;</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> </div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  <span class="comment">/* @SYSGO_RQ IF_ANIS-1222 */</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"></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"> * @brief</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> <span class="comment"> * The IP part of the address.</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"> * @detailed</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> * This member contains the IP address part of the address in network</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="comment"> * byte order.</span></div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> <span class="comment"> */</span></div><div class="line"><a name="l00302"></a><span class="lineno"><a class="line" href="structsockaddr__in.html#a4ea5f2f1138e5c8597097db255a9ec6c"> 302</a></span>  <span class="keyword">struct </span><a class="code" href="structin__addr.html">in_addr</a> sin_addr;</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"></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"> * @brief</span></div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> <span class="comment"> * Extra padding at the end of the structure.</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"><a class="line" href="structsockaddr__in.html#a0254bfac1c18e922cb6638c3f6139e09"> 308</a></span>  <span class="keywordtype">char</span> sin_zero[8];</div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> };</div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> </div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment">/* @SYSGO_RQ IF_ANIS-1207 */</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"></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="comment"> * @brief</span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * Data type to handle addresses in an domain agnostic manner.</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"> * @detailed</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> * The struct sockaddr provides an address domain agnostic means to</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> * exchange socket addresses with API service calls. ANIS supports only one</span></div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> * address domain: IPv4. Addresses for this domain are defined using struct</span></div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> * sockaddr_in. This domain specific structure is mapped to a struct</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * sockaddr in API service calls.</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> *</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> * @see struct sockaddr_in</span></div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> */</span></div><div class="line"><a name="l00326"></a><span class="lineno"><a class="line" href="structsockaddr.html"> 326</a></span> <span class="keyword">struct </span><a class="code" href="structsockaddr.html">sockaddr</a> {<span class="comment"></span></div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> /**</span></div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> * The address family this structure belongs to.</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"><a class="line" href="structsockaddr.html#ac6ef02e9a2e90a30218132ffd7b5a5c5"> 331</a></span>  <a class="code" href="group__anisSocket.html#ga22bf2db06ebc5466014e637d419cef90">sa_family_t</a> <a class="code" href="structsockaddr.html#ac6ef02e9a2e90a30218132ffd7b5a5c5">sa_family</a>;</div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"></span></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"> /**</span></div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> * Place holder for the actual data.</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"><a class="line" href="structsockaddr.html#afd5d95d56d0f8959f5b56458b3b3c714"> 337</a></span>  <span class="keywordtype">char</span> sa_data[14];</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</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">/**</span></div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> * Data type to handle group membership.</span></div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> *</span></div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> * @detailed</span></div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment"> * The struct ip_mreq provides way to associate multicast group with</span></div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment"> * network interface. This is used to register into a multicast group or</span></div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="comment"> * drop membership of a multicast group.</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"> */</span></div><div class="line"><a name="l00350"></a><span class="lineno"><a class="line" href="structip__mreq.html"> 350</a></span> <span class="keyword">struct </span><a class="code" href="structip__mreq.html">ip_mreq</a></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"> /**</span></div><div class="line"><a name="l00353"></a><span class="lineno"> 353</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00354"></a><span class="lineno"> 354</span> <span class="comment"> * Multicast group address the application wants to leave or join.</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"><a class="line" href="structip__mreq.html#a68a7523377d80bddb61cd260ed0d8658"> 356</a></span>  <span class="keyword">struct </span><a class="code" href="structin__addr.html">in_addr</a> imr_multiaddr;<span class="comment"></span></div><div class="line"><a name="l00357"></a><span class="lineno"> 357</span> <span class="comment"> /**</span></div><div class="line"><a name="l00358"></a><span class="lineno"> 358</span> <span class="comment"> * @brief</span></div><div class="line"><a name="l00359"></a><span class="lineno"> 359</span> <span class="comment"> * IP address identifying a network interface.</span></div><div class="line"><a name="l00360"></a><span class="lineno"> 360</span> <span class="comment"> */</span></div><div class="line"><a name="l00361"></a><span class="lineno"><a class="line" href="structip__mreq.html#a5a01c67398a3c25dab84996a04730a2a"> 361</a></span>  <span class="keyword">struct </span><a class="code" href="structin__addr.html">in_addr</a> imr_interface;</div><div class="line"><a name="l00362"></a><span class="lineno"> 362</span> };</div><div class="line"><a name="l00363"></a><span class="lineno"> 363</span> <span class="comment"></span></div><div class="line"><a name="l00364"></a><span class="lineno"> 364</span> <span class="comment">/** @} */</span></div><div class="line"><a name="l00365"></a><span class="lineno"> 365</span> </div><div class="line"><a name="l00366"></a><span class="lineno"> 366</span> <span class="preprocessor">#endif </span><span class="comment">/* SOCKET_API_COMMON_H */</span><span class="preprocessor"></span></div><div class="ttc" id="group__anisSocket_html_ga979d51fa99f7145221b3ed1afff5b827"><div class="ttname"><a href="group__anisSocket.html#ga979d51fa99f7145221b3ed1afff5b827">in_port_t</a></div><div class="ttdeci">uint16_t in_port_t</div><div class="ttdoc">Data type to hold a UDP port number. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:257</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="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="structsockaddr_html_ac6ef02e9a2e90a30218132ffd7b5a5c5"><div class="ttname"><a href="structsockaddr.html#ac6ef02e9a2e90a30218132ffd7b5a5c5">sockaddr::sa_family</a></div><div class="ttdeci">sa_family_t sa_family</div><div class="ttdoc">The address family this structure belongs to. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:331</div></div>
|
|
<div class="ttc" id="structsockaddr__in_html"><div class="ttname"><a href="structsockaddr__in.html">sockaddr_in</a></div><div class="ttdoc">Data type to store an PF_INET socket address. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:269</div></div>
|
|
<div class="ttc" id="structsockaddr__in_html_a9a7d98bb8e18f4a06a021c32d6cc7117"><div class="ttname"><a href="structsockaddr__in.html#a9a7d98bb8e18f4a06a021c32d6cc7117">sockaddr_in::sin_family</a></div><div class="ttdeci">sa_family_t sin_family</div><div class="ttdoc">The address family this structure belongs to. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:278</div></div>
|
|
<div class="ttc" id="structip__mreq_html"><div class="ttname"><a href="structip__mreq.html">ip_mreq</a></div><div class="ttdoc">Data type to handle group membership. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:350</div></div>
|
|
<div class="ttc" id="structsockaddr__in_html_ae89eef5c2b45ce0a177379755edecafa"><div class="ttname"><a href="structsockaddr__in.html#ae89eef5c2b45ce0a177379755edecafa">sockaddr_in::sin_port</a></div><div class="ttdeci">in_port_t sin_port</div><div class="ttdoc">The port part of the address. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:290</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="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="structin__addr_html"><div class="ttname"><a href="structin__addr.html">in_addr</a></div><div class="ttdoc">Data type to hold an IPv4 address. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:229</div></div>
|
|
<div class="ttc" id="group__anisSocket_html_ga22bf2db06ebc5466014e637d419cef90"><div class="ttname"><a href="group__anisSocket.html#ga22bf2db06ebc5466014e637d419cef90">sa_family_t</a></div><div class="ttdeci">uint16_t sa_family_t</div><div class="ttdoc">Data type to hold the socket type. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:247</div></div>
|
|
<div class="ttc" id="structin__addr_html_a5abe94a260a50619a60ce111a59f00b5"><div class="ttname"><a href="structin__addr.html#a5abe94a260a50619a60ce111a59f00b5">in_addr::s_addr</a></div><div class="ttdeci">uint32_t s_addr</div><div class="ttdoc">An IPv4 address in network byte order. </div><div class="ttdef"><b>Definition:</b> socket_api_common.h:238</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_bebf8c72019fcb9b88b4a0217a314255.html">anisfp</a></li><li class="navelem"><a class="el" href="dir_0e9b333007a3e0d387ca7dc901ff67d8.html">include</a></li><li class="navelem"><a class="el" href="socket__api__common_8h.html">socket_api_common.h</a></li>
|
|
<li class="footer">(C) Copyright SYSGO AG</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|