Lee Kai Xuan / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-os by erkin yucel

features/nanostack/FEATURE_NANOSTACK/sal-stack-nanostack/docs/05_reference.md@1:3deb71413561, 2017-07-20 (annotated)

Committer:
xuaner
Date:
Thu Jul 20 14:26:57 2017 +0000
Revision:
1:3deb71413561
Parent:
0:f269e3021894 
mbed_os

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 #ARM mbed Networking Stack API Reference Manual
elessair 0:f269e3021894 2
elessair 0:f269e3021894 3 ## About this manual
elessair 0:f269e3021894 4
elessair 0:f269e3021894 5 This manual describes the APIs regarding the ARM mbed Networking stack, for example, 6LoWPAN related APIs, Thread stack related APIs, General network related APIs, Socket APIs, Event OS APIs, Platform API, and Driver API.
elessair 0:f269e3021894 6
elessair 0:f269e3021894 7 As Thread runs on top of the 6LoWPAN stack, most of the networking stack functionality is shared. However, when building the stack you can cherry-pick the features, configurations or functionalities. In such case, please refer to [Build time configurations](quick_start_build.md).
elessair 0:f269e3021894 8
elessair 0:f269e3021894 9 ## Intended audience
elessair 0:f269e3021894 10
elessair 0:f269e3021894 11 This manual has been written for experienced software developers to assist with using the ARM software product range.
elessair 0:f269e3021894 12
elessair 0:f269e3021894 13 ## Using this manual
elessair 0:f269e3021894 14
elessair 0:f269e3021894 15 The reference manual contains several chapters; you can read them in sequence, but they can also be read as stand-alone. They are:
elessair 0:f269e3021894 16
elessair 0:f269e3021894 17 1. [**Introduction to APIs**](06_API_introduction.md): Read this to understand more about the 6LoWPAN stack from API perspective.
elessair 0:f269e3021894 18
elessair 0:f269e3021894 19 2. [**IPv6/6LoWPAN Stack Initialization**](07_API_initialize.md): Read this to understand how to initialize the IPv6/6LoWPAN stack.
elessair 0:f269e3021894 20
elessair 0:f269e3021894 21 3. [**An Event-driven Scheduling Model**](08_API_events.md): Read this to understand more about the event-driven scheduling model. If you are using ARM mbed OS, skip this.
elessair 0:f269e3021894 22
elessair 0:f269e3021894 23 4. [**Platform API**](platform_API.md): Brief description of Platform API. Detailed discussion in Porting section.
elessair 0:f269e3021894 24
elessair 0:f269e3021894 25 5. [**Device Driver API**](driver_api.md): Brief description of Device Driver API. Detailed discussion in Porting section.
elessair 0:f269e3021894 26
elessair 0:f269e3021894 27
elessair 0:f269e3021894 28 6. [**Network API Definitions**](09_API_network_def.md): Read this to understand more about the network API definitions.
elessair 0:f269e3021894 29
elessair 0:f269e3021894 30 7. [**Library Timer API**](10_API_timer.md): Read this to understand more about the timer functionality.
elessair 0:f269e3021894 31
elessair 0:f269e3021894 32 8. [**Sockets Use and Available APIs**](11_API_sockets.md): Read this to understand more about socket use and the available APIs.
elessair 0:f269e3021894 33
elessair 0:f269e3021894 34 9. [**The Network Control Layer**](12_API_network.md): Read this to understand the functions of the network control layer.
elessair 0:f269e3021894 35
elessair 0:f269e3021894 36 10. [**Dynamic Memory API**](13_API_memory.md): Read this for an introduction to the dynamic memory API of the 6LoWPAN stack.
elessair 0:f269e3021894 37
elessair 0:f269e3021894 38 11. [**Data Structures, Types and Variables**](14_API_data.md): Read this to understand the data structure, types and variables used in the socket and RF layers.
elessair 0:f269e3021894 39
elessair 0:f269e3021894 40 12. [**Debug Statistics Interface API**](15_API_debug.md): Read this to understand the debug statistics interface API.
elessair 0:f269e3021894 41
elessair 0:f269e3021894 42 13. [**Thread Related APIs**](thread_APIs.md):Read this to familiarize yourself with the Thread protocol related APIs.
elessair 0:f269e3021894 43
elessair 0:f269e3021894 44