-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
253 lines (232 loc) · 19.4 KB
/
index.html
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to Anjay LwM2M library documentation! — Anjay 3.8.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=86f27845" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=b9c2c5b9" />
<script src="_static/jquery.js?v=8dae8fb0"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=30f795a6"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="1. Introduction" href="Introduction.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: #ffd500" >
<a href="#">
<img src="_static/avsystem_header.png" class="logo" alt="Logo"/>
</a>
<div class="version">
3.8.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="LwM2M.html">2. OMA LwM2M - Brief description</a></li>
<li class="toctree-l1"><a class="reference internal" href="Compiling_client_applications.html">3. Compiling client applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="BasicClient.html">4. Basic client</a></li>
<li class="toctree-l1"><a class="reference internal" href="AdvancedTopics.html">5. Advanced topics</a></li>
<li class="toctree-l1"><a class="reference internal" href="FirmwareUpdateTutorial.html">6. Firmware Update Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tools.html">7. Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms.html">8. Porting guide for non-POSIX platforms</a></li>
<li class="toctree-l1"><a class="reference internal" href="Migrating.html">9. Migrating from older versions</a></li>
<li class="toctree-l1"><a class="reference internal" href="CommercialFeatures.html">10. Commercial features</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #ffd500" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Anjay</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to Anjay LwM2M library documentation!</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-anjay-lwm2m-library-documentation">
<h1>Welcome to Anjay LwM2M library documentation!<a class="headerlink" href="#welcome-to-anjay-lwm2m-library-documentation" title="Link to this heading"></a></h1>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>With release of Anjay 3.0, the <a class="reference external" href="https://github.com/AVSystem/Anjay/blob/master/LICENSE">library’s license terms have changed</a>. Please make sure
that you have reviewed it before updating to the new major release. Previous
versions of Anjay remain with the old, Apache 2.0 license.</p>
</div>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="LwM2M.html">2. OMA LwM2M - Brief description</a></li>
<li class="toctree-l1"><a class="reference internal" href="Compiling_client_applications.html">3. Compiling client applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="BasicClient.html">4. Basic client</a><ul>
<li class="toctree-l2"><a class="reference internal" href="BasicClient/BC-Initialization.html">4.1. Anjay initialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="BasicClient/BC-MandatoryObjects.html">4.2. Installing mandatory Objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="BasicClient/BC-Security.html">4.3. Enabling secure communication</a></li>
<li class="toctree-l2"><a class="reference internal" href="BasicClient/BC-ObjectImplementation.html">4.4. Implementing standard Object</a></li>
<li class="toctree-l2"><a class="reference internal" href="BasicClient/BC-Notifications.html">4.5. Notifications support</a></li>
<li class="toctree-l2"><a class="reference internal" href="BasicClient/BC-Send.html">4.6. Send method</a></li>
<li class="toctree-l2"><a class="reference internal" href="BasicClient/BC-ThreadSafety.html">4.7. Thread safety in Anjay</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="AdvancedTopics.html">5. Advanced topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-AccessControl.html">5.1. Access Control in multi-server environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-AttributeStorage.html">5.2. Attribute storage</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-Certificates.html">5.3. DTLS connection using certificates</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-CustomObjects.html">5.4. Custom LwM2M objects</a><ul>
<li class="toctree-l3"><a class="reference internal" href="AdvancedTopics/AT-CustomObjects/AT_CO_SingleInstanceReadOnly.html">5.4.1. Single-instance read-only object</a></li>
<li class="toctree-l3"><a class="reference internal" href="AdvancedTopics/AT-CustomObjects/AT_CO_SingleInstanceExecutableAndReadOnly.html">5.4.2. Single-instance read-only object with an executable resource</a></li>
<li class="toctree-l3"><a class="reference internal" href="AdvancedTopics/AT-CustomObjects/AT_CO_MultiInstanceReadOnlyFixed.html">5.4.3. Multi-instance read-only object with fixed number of instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="AdvancedTopics/AT-CustomObjects/AT_CO_FixedInstanceWritable.html">5.4.4. Multi-instance writable object with fixed number of instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="AdvancedTopics/AT-CustomObjects/AT_CO_MultiInstanceDynamic.html">5.4.5. Multi-instance writable object with dynamic number of instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="AdvancedTopics/AT-CustomObjects/AT_CO_MultipleResourceInstances.html">5.4.6. Objects with Multiple Instance Resources</a></li>
<li class="toctree-l3"><a class="reference internal" href="AdvancedTopics/AT-CustomObjects/AT_CO_BootstrapAwareness.html">5.4.7. Bootstrap awareness</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-NetworkErrorHandling.html">5.5. Network error handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-OtherFeatures.html">5.6. Other library features</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-Persistence.html">5.7. Persistence support</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-RetransmissionsTimeoutsCaching.html">5.8. Retransmissions, timeouts & response caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-CustomEventLoop.html">5.9. Custom event loop</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-EventLoopNotes.html">5.10. Notes on event loop APIs</a></li>
<li class="toctree-l2"><a class="reference internal" href="AdvancedTopics/AT-IpsoObjects.html">5.11. IPSO objects implementation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="FirmwareUpdateTutorial.html">6. Firmware Update Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="FirmwareUpdateTutorial/FU-Introduction.html">6.1. Firmware Update</a></li>
<li class="toctree-l2"><a class="reference internal" href="FirmwareUpdateTutorial/FU-BasicImplementation.html">6.2. Basic implementation</a></li>
<li class="toctree-l2"><a class="reference internal" href="FirmwareUpdateTutorial/FU-ModesAndProtocols.html">6.3. Download modes and protocols</a></li>
<li class="toctree-l2"><a class="reference internal" href="FirmwareUpdateTutorial/FU-SecureDownloads.html">6.4. Secure downloads</a></li>
<li class="toctree-l2"><a class="reference internal" href="FirmwareUpdateTutorial/FU-PoorConnectivity.html">6.5. Poor network connectivity</a></li>
<li class="toctree-l2"><a class="reference internal" href="FirmwareUpdateTutorial/FU-DownloadResumption.html">6.6. Download resumption</a></li>
<li class="toctree-l2"><a class="reference internal" href="FirmwareUpdateTutorial/FU-AdvancedFirmwareUpdate.html">6.7. Advanced Firmware Update</a><ul>
<li class="toctree-l3"><a class="reference internal" href="FirmwareUpdateTutorial/FU-AdvancedFirmwareUpdate/FU-AFU-ResourceDefinitions.html">6.7.1. Resource definitions</a></li>
<li class="toctree-l3"><a class="reference internal" href="FirmwareUpdateTutorial/FU-AdvancedFirmwareUpdate/FU-AFU-StateDiagram.html">6.7.2. Firmware Update State Diagram</a></li>
<li class="toctree-l3"><a class="reference internal" href="FirmwareUpdateTutorial/FU-AdvancedFirmwareUpdate/FU-AFU-Examples.html">6.7.3. Examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="FirmwareUpdateTutorial/FU-AdvancedFirmwareUpdate/FU-AFU-BasicImplementation.html">6.7.4. Implementation</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Tools.html">7. Tools</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Tools/CliLwM2MServer.html">7.1. LwM2M testing shell</a></li>
<li class="toctree-l2"><a class="reference internal" href="Tools/FactoryProvisioning.html">7.2. Factory Provisioning Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="Tools/StandaloneObjects.html">7.3. Standalone LwM2M Object implementations</a></li>
<li class="toctree-l2"><a class="reference internal" href="Tools/StubGenerator.html">7.4. Anjay Object stub generator</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms.html">8. Porting guide for non-POSIX platforms</a><ul>
<li class="toctree-l2"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/TimeAPI.html">8.1. Time API</a></li>
<li class="toctree-l2"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/ThreadingAPI.html">8.2. Threading API</a></li>
<li class="toctree-l2"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI.html">8.3. Networking API</a><ul>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI/NetworkingAPI-Minimal.html">8.3.1.1. Minimal socket implementation</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI/NetworkingAPI-RemoteHostPort.html">8.3.1.2. Get remote host/port operations</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI/NetworkingAPI-Bind.html">8.3.1.3. Bind operation</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI/NetworkingAPI-ShutdownRemoteHostname.html">8.3.1.4. Remote hostname and shutdown operations</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI/NetworkingAPI-Stats.html">8.3.1.5. Statistics support</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI/NetworkingAPI-IpStickiness.html">8.3.1.6. IP address stickiness support</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI/NetworkingAPI-EventLoopSupport.html">8.3.1.7. Event loop support</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/NetworkingAPI/NetworkingAPI-OtherFeatures.html">8.3.1.8. Other features</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/CustomTLS.html">8.4. Custom (D)TLS layers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/CustomTLS/CustomTLS-Stub.html">8.4.1.1. Introductory stub</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/CustomTLS/CustomTLS-Minimal.html">8.4.1.2. Minimal DTLS implementation</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/CustomTLS/CustomTLS-Resumption.html">8.4.1.3. Session resumption support</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/CustomTLS/CustomTLS-ConfigFeatures.html">8.4.1.4. Advanced configuration features</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/CustomTLS/CustomTLS-CertificatesBasic.html">8.4.1.5. Basic certificate support</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/CustomTLS/CustomTLS-CertificatesAdvanced.html">8.4.1.6. Advanced certificate support</a></li>
<li class="toctree-l3"><a class="reference internal" href="PortingGuideForNonPOSIXPlatforms/CustomTLS/CustomTLS-TCPSupport.html">8.4.1.7. Support for TLS over TCP</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Migrating.html">9. Migrating from older versions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay225.html">9.1. Migrating from Anjay 2.2.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingCustomEntropy.html">9.2. Migrating mbed TLS custom entropy initializers</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay24.html">9.3. Migrating from Anjay 2.3.x or 2.4.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay26.html">9.4. Migrating from Anjay 2.5.x or 2.6.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay27.html">9.5. Migrating from Anjay 2.7.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay28.html">9.6. Migrating from Anjay 2.8.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay214.html">9.7. Migrating from Anjay 2.9.x-2.14.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay215.html">9.8. Migrating from Anjay 2.15.x</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay30.html">9.9. Migrating from Anjay 3.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay32.html">9.10. Migrating from Anjay 3.1 or 3.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay33.html">9.11. Migrating from Anjay 3.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay34.html">9.12. Migrating from Anjay 3.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="Migrating/MigratingFromAnjay37.html">9.13. Migrating from Anjay 3.7</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="CommercialFeatures.html">10. Commercial features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-CorePersistence.html">10.1. Core Persistence</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-CustomHardwareSupport.html">10.2. Custom Hardware Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-EST.html">10.3. Enrollment over Secure Transport</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-FSDM.html">10.4. File System Data Model</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-HSM.html">10.5. Hardware Security Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-IoTSAFE.html">10.6. IoT SAFE</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-NIDD.html">10.7. Non-IP Data Delivery</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-OSCORE.html">10.8. OSCORE</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-SMSBinding.html">10.9. SMS Binding</a></li>
<li class="toctree-l2"><a class="reference internal" href="CommercialFeatures/CF-SmartCardBootstrap.html">10.10. Bootstrapper and SIM bootstrap</a></li>
</ul>
</li>
</ul>
</div>
<section id="links">
<h2>Links<a class="headerlink" href="#links" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/AVSystem/Anjay">Source repository</a></p></li>
<li><p><a class="reference external" href="api/index.html">Doxygen-generated API documentation</a></p></li>
</ul>
</section>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="Introduction.html" class="btn btn-neutral float-right" title="1. Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2017-2024, AVSystem.</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>