aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/nRF5_SDK_15.0.0_a53641a/components/iot/socket/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/iot/socket/README.md')
-rw-r--r--thirdparty/nRF5_SDK_15.0.0_a53641a/components/iot/socket/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/iot/socket/README.md b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/iot/socket/README.md
new file mode 100644
index 0000000..9ec0b8d
--- /dev/null
+++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/iot/socket/README.md
@@ -0,0 +1,28 @@
+# Socket module
+
+The socket module contains the BSD socket implementation for the IoT SDK. The purpose of the socket
+API is to
+
+* Provide a common API for all platforms
+* Simplify porting of pc network applications
+
+The socket API hides details of the underlying transport, but supports proprietary extensions for
+controlling configuration settings and using underlying transport layers.
+
+<pre>
+socket/
+ api/ - Public socket API headers
+ common/ - Common implementation of API and implementation code shared by all platforms (main socket API implementation, with hooks for different transports)
+ libraries/ - Generic libraries that are not tied to a specific platform
+ portdb/ - Port database to track and allocate socket ports
+ addr_util/ - Common address utilities
+ mbuf/ - Memory buffer utilities
+ transport/ - Transport/network stack hooks
+ ipv6/ - Nordic IPv6 stack transport hook
+ lwip/ - LwIP transport hook
+ test/ - Integration tests shared between transport stacks
+ platform/ - Platform specific code
+ ble/ - BLE specific code (only wrappers around sd_ble_app_evt_())
+ config/ - Configuration socket implementations
+ medium/ - Medium configuration socket implementation
+</pre>