-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathannotated.html
More file actions
161 lines (159 loc) · 19.8 KB
/
annotated.html
File metadata and controls
161 lines (159 loc) · 19.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Data Structures - Eclipse Arrowhead™ Core C Libraries</title>
<script src="jquery.js"></script>
<script src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script>
window.addEventListener("load", () => {
let contents = document.querySelector("body > div.contents");
if (!contents) {
return;
}
document.querySelectorAll("#top ul > li.current > a > span").forEach((selectedMenuItem) => {
contents.classList.add(selectedMenuItem.innerText.trim().toLowerCase().replace(/\s+/, "-"));
});
for (let i = contents.childNodes.length - 1; i >= 0; i -= 1) {
let childNode = contents.childNodes.item(i);
if ((childNode.nodeType === 3 && childNode.textContent.trim().length === 0)
|| (childNode.nodeType === 1 && childNode.classList.contains("textblock") && childNode.textContent.trim().length === 0)) {
childNode.remove();
}
}
});
</script>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="DoxygenStyle.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top">
<header>
<img alt="Logo" src="arrowhead-logo-white.svg"/>
<h1>Eclipse Arrowhead™ Core C Libraries <span class="version"></span></h1>
</header>
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Overview</span></a></li>
<li><a href="files.html"><span>Headers</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">Data Structures</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">The data structures of all Core C libraries. Every data structure is prefixed with ah_ and the name of the header file in which it is declared. </div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__buf.html" target="_self">ah_buf</a></td><td class="desc">Sized reference to a contiguous chunk of memory </td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__chunk.html" target="_self">ah_http_chunk</a></td><td class="desc">HTTP chunk, including data and an arbitrary extension </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__client.html" target="_self">ah_http_client</a></td><td class="desc">HTTP client </td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__client__cbs.html" target="_self">ah_http_client_cbs</a></td><td class="desc">HTTP client callback set </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__client__obs.html" target="_self">ah_http_client_obs</a></td><td class="desc">HTTP client observer </td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__head.html" target="_self">ah_http_head</a></td><td class="desc">HTTP start line and field lines </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__header.html" target="_self">ah_http_header</a></td><td class="desc">HTTP header field, which is a name/value pair </td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__server.html" target="_self">ah_http_server</a></td><td class="desc">HTTP server </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__server__cbs.html" target="_self">ah_http_server_cbs</a></td><td class="desc">HTTP server callback set </td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__server__obs.html" target="_self">ah_http_server_obs</a></td><td class="desc">HTTP server observer </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__trailer.html" target="_self">ah_http_trailer</a></td><td class="desc">HTTP chunked message end, consisting of a last chunk extension and a trailer </td></tr>
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__http__ver.html" target="_self">ah_http_ver</a></td><td class="desc">HTTP version indicator </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__ipaddr__v4.html" target="_self">ah_ipaddr_v4</a></td><td class="desc">IPv4 address </td></tr>
<tr id="row_13_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__ipaddr__v6.html" target="_self">ah_ipaddr_v6</a></td><td class="desc">IPv6 address </td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__json__buf.html" target="_self">ah_json_buf</a></td><td class="desc">JSON token buffer </td></tr>
<tr id="row_15_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__json__val.html" target="_self">ah_json_val</a></td><td class="desc">JSON value, concretely represented as a token </td></tr>
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__loop.html" target="_self">ah_loop</a></td><td class="desc">Event loop </td></tr>
<tr id="row_17_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__mbedtls__client.html" target="_self">ah_mbedtls_client</a></td><td class="desc">MbedTLS client context </td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__mbedtls__server.html" target="_self">ah_mbedtls_server</a></td><td class="desc">MbedTLS server context </td></tr>
<tr id="row_19_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__rw.html" target="_self">ah_rw</a></td><td class="desc">R/W pointer set, used to coordinate writes and reads to and from the same buffer </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="unionah__sockaddr.html" target="_self">ah_sockaddr</a></td><td class="desc">Socket address union type </td></tr>
<tr id="row_21_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__sockaddr__any.html" target="_self">ah_sockaddr_any</a></td><td class="desc">Socket address variant that exposes struct fields present on all supported <a class="el" href="unionah__sockaddr.html" title="Socket address union type.">ah_sockaddr</a> variant types </td></tr>
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__sockaddr__ip.html" target="_self">ah_sockaddr_ip</a></td><td class="desc">Socket address variant that exposes struct fields present on all IP-based <a class="el" href="unionah__sockaddr.html" title="Socket address union type.">ah_sockaddr</a> variant types </td></tr>
<tr id="row_23_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__sockaddr__ipv4.html" target="_self">ah_sockaddr_ipv4</a></td><td class="desc">Socket address variant representing an IPv4-based address </td></tr>
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__sockaddr__ipv6.html" target="_self">ah_sockaddr_ipv6</a></td><td class="desc">Socket address variant representing an IPv6-based address </td></tr>
<tr id="row_25_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__task.html" target="_self">ah_task</a></td><td class="desc">Task that can be scheduled for execution in the future </td></tr>
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__accept.html" target="_self">ah_tcp_accept</a></td><td class="desc">TCP listener acceptance </td></tr>
<tr id="row_27_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__conn.html" target="_self">ah_tcp_conn</a></td><td class="desc">TCP connection handle </td></tr>
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__conn__cbs.html" target="_self">ah_tcp_conn_cbs</a></td><td class="desc">TCP connection callback set </td></tr>
<tr id="row_29_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__conn__obs.html" target="_self">ah_tcp_conn_obs</a></td><td class="desc">TCP connection observer </td></tr>
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__in.html" target="_self">ah_tcp_in</a></td><td class="desc">TCP input stream </td></tr>
<tr id="row_31_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__listener.html" target="_self">ah_tcp_listener</a></td><td class="desc">TCP listener handle </td></tr>
<tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__listener__cbs.html" target="_self">ah_tcp_listener_cbs</a></td><td class="desc">TCP listener callback set </td></tr>
<tr id="row_33_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__listener__obs.html" target="_self">ah_tcp_listener_obs</a></td><td class="desc">TCP listener observer </td></tr>
<tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__out.html" target="_self">ah_tcp_out</a></td><td class="desc">TCP output buffer </td></tr>
<tr id="row_35_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__trans.html" target="_self">ah_tcp_trans</a></td><td class="desc">TCP-based transport </td></tr>
<tr id="row_36_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__tcp__trans__vtab.html" target="_self">ah_tcp_trans_vtab</a></td><td class="desc">TCP-based transport virtual function table </td></tr>
<tr id="row_37_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__time.html" target="_self">ah_time</a></td><td class="desc">Reference to a point in time, measured from an arbitrary point in the past </td></tr>
<tr id="row_38_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="unionah__udp__group.html" target="_self">ah_udp_group</a></td><td class="desc">UDP multicast group union type </td></tr>
<tr id="row_39_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__group__ipv4.html" target="_self">ah_udp_group_ipv4</a></td><td class="desc">UDP/IPv4 multicast group </td></tr>
<tr id="row_40_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__group__ipv6.html" target="_self">ah_udp_group_ipv6</a></td><td class="desc">UDP/IPv6 multicast group </td></tr>
<tr id="row_41_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__in.html" target="_self">ah_udp_in</a></td><td class="desc">UDP datagram input buffer </td></tr>
<tr id="row_42_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__out.html" target="_self">ah_udp_out</a></td><td class="desc">UDP datagram output buffer </td></tr>
<tr id="row_43_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__sock.html" target="_self">ah_udp_sock</a></td><td class="desc">UDP socket handle </td></tr>
<tr id="row_44_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__sock__cbs.html" target="_self">ah_udp_sock_cbs</a></td><td class="desc">UDP socket callback set </td></tr>
<tr id="row_45_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__sock__obs.html" target="_self">ah_udp_sock_obs</a></td><td class="desc">UDP socket observer </td></tr>
<tr id="row_46_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__trans.html" target="_self">ah_udp_trans</a></td><td class="desc">UDP-based message transport </td></tr>
<tr id="row_47_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__udp__trans__vtab.html" target="_self">ah_udp_trans_vtab</a></td><td class="desc">UDP-based transport virtual function table </td></tr>
<tr id="row_48_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__unit__ctx.html" target="_self">ah_unit_ctx</a></td><td class="desc">Unit testing context </td></tr>
<tr id="row_49_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structah__unit__res.html" target="_self">ah_unit_res</a></td><td class="desc">Unit testing result accumulator </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<footer>Generated by <a href="https://doxygen.org">Doxygen</a> 1.9.5</footer>
</body>
</html>