Skip to content

Commit

Permalink
Auto update markdown TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
@VolkerChristian @github-actions
VolkerChristian authored and github-actions[bot] committed Sep 22, 2023
1 parent 0687bfe commit 3f5cc17
Showing 1 changed file with 3 additions and 118 deletions.
121 changes: 3 additions & 118 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,124 +8,9 @@ Main focus (but not only) of the framework is "Machine to Machine" (M2M) communi

# Table of Content
<!--ts-->
* [Simple NODE in C++ (SNode.C)](#simple-node-in-c-snodec)
* [Table of Content](#table-of-content)
* [License](#license)
* [Copyright](#copyright)
* [Quick Starting Guide](#quick-starting-guide)
* [An "Echo" Application](#an-echo-application)
* [SocketServer and SocketClient Instances](#socketserver-and-socketclient-instances)
* [SocketContextFactories](#socketcontextfactories)
* [Echo-Server <em>SocketContextFactory</em>](#echo-server-socketcontextfactory)
* [Echo-Client <em>SocketContextFactory</em>](#echo-client-socketcontextfactory)
* [SocketContexts](#socketcontexts)
* [Echo-Server <em>SocketContext</em>](#echo-server-socketcontext)
* [Echo-Client <em>SocketContext</em>](#echo-client-socketcontext)
* [Main Applications for Server and Client](#main-applications-for-server-and-client)
* [Echo-Server Main Application](#echo-server-main-application)
* [Echo-Client Main Application](#echo-client-main-application)
* [CMakeLists.txt file for Building and Installing our <em>echoserver</em> and <em>echoclient</em>](#cmakeliststxt-file-for-building-and-installing-our-echoserver-and-echoclient)
* [Summary](#summary)
* [Installation](#installation)
* [Supported Systems and Hardware](#supported-systems-and-hardware)
* [Minimum required Compiler Versions](#minimum-required-compiler-versions)
* [Requirements and Dependencies](#requirements-and-dependencies)
* [Tools](#tools)
* [Mandatory](#mandatory)
* [Optional](#optional)
* [Libraries](#libraries)
* [Mandatory](#mandatory-1)
* [Optional](#optional-1)
* [In-Framework](#in-framework)
* [Installation on Debian Style Systems (x86-64, Arm)](#installation-on-debian-style-systems-x86-64-arm)
* [Requirements and Dependencies](#requirements-and-dependencies-1)
* [SNode.C](#snodec)
* [Deploment on OpenWRT](#deploment-on-openwrt)
* [Cross Compile SNode.C](#cross-compile-snodec)
* [Download SDK](#download-sdk)
* [Patch Feeds](#patch-feeds)
* [Install Packages](#install-packages)
* [Configure the SDK](#configure-the-sdk)
* [Cross Compile](#cross-compile)
* [Prepare Deployment (only once)](#prepare-deployment-only-once)
* [Deploy SNode.C](#deploy-snodec)
* [Design Decisions and Features](#design-decisions-and-features)
* [Network Layer](#network-layer)
* [Transport Layer](#transport-layer)
* [Connection Layer](#connection-layer)
* [Application Layer](#application-layer)
* [Existing <em>SocketServer</em> and <em>SocketClient</em> Classes](#existing-socketserver-and-socketclient-classes)
* [Common Aspects of Server and Client Classes](#common-aspects-of-server-and-client-classes)
* [<em>SocketAddress</em>](#socketaddress)
* [<em>SocketConnection</em>](#socketconnection)
* [Most Important common <em>SocketConnection</em> Methods](#most-important-common-socketconnection-methods)
* [Constructors of <em>SocketServer</em> and <em>SocketClient</em> Classes](#constructors-of-socketserver-and-socketclient-classes)
* [Constructors of <em>SocketServer</em> Classes](#constructors-of-socketserver-classes)
* [Constructors of <em>SocketClient</em> Classes](#constructors-of-socketclient-classes)
* [Constructor Callbacks](#constructor-callbacks)
* [The <em>onConnect</em> Callback](#the-onconnect-callback)
* [The <em>onConnected</em> Callback](#the-onconnected-callback)
* [The <em>onDisconnected</em> Callback](#the-ondisconnected-callback)
* [Attaching the Callbacks during Instance Creation](#attaching-the-callbacks-during-instance-creation)
* [Attaching the Callbacks to Already Existing <em>SocketServer</em> and <em>SocketClient</em> Instances](#attaching-the-callbacks-to-already-existing-socketserver-and-socketclient-instances)
* [SocketServer Classes](#socketserver-classes)
* [SocketServer Header Files](#socketserver-header-files)
* [Listen Methods](#listen-methods)
* [Common <em>listen</em> Methods](#common-listen-methods)
* [IPv4 specific <em>listen</em> Methods](#ipv4-specific-listen-methods)
* [IPv6 specific <em>listen</em> Methods](#ipv6-specific-listen-methods)
* [Unix Domain Socket specific <em>listen</em> Methods](#unix-domain-socket-specific-listen-methods)
* [Bluetooth RFCOMM specific <em>listen</em> Methods](#bluetooth-rfcomm-specific-listen-methods)
* [Bluetooth L2CAP specific <em>listen</em> Methods](#bluetooth-l2cap-specific-listen-methods)
* [SocketClient Classes](#socketclient-classes)
* [SocketClient Header Files](#socketclient-header-files)
* [Connect Methods](#connect-methods)
* [Common <em>connect</em> Methods](#common-connect-methods)
* [IPv4 specific <em>connect</em> Methods](#ipv4-specific-connect-methods)
* [IPv6 specific <em>connect</em> Methods](#ipv6-specific-connect-methods)
* [Unix Domain Socket specific <em>connect</em> Methods](#unix-domain-socket-specific-connect-methods)
* [Bluetooth RFCOMM specific <em>connect</em> Methods](#bluetooth-rfcomm-specific-connect-methods)
* [Bluetooth L2CAP specific <em>connect</em> Methods](#bluetooth-l2cap-specific-connect-methods)
* [Configuration](#configuration)
* [Three different Options for Configuration](#three-different-options-for-configuration)
* [Configuration using the C++ API](#configuration-using-the-c-api)
* [List of all Configuration Items](#list-of-all-configuration-items)
* [Configuration via the Command Line](#configuration-via-the-command-line)
* [Application Configuration](#application-configuration)
* [Instance Configuration](#instance-configuration)
* [Sections](#sections)
* [Using the Parameterless <em>listen</em> Methods when no Configuration File exists](#using-the-parameterless-listen-methods-when-no-configuration-file-exists)
* [Using the Parameterless <em>connect</em> Methods when no Configuration File exists](#using-the-parameterless-connect-methods-when-no-configuration-file-exists)
* [Anatomy of the Command Line Interface](#anatomy-of-the-command-line-interface)
* [Configuration via a Configuration File](#configuration-via-a-configuration-file)
* [Configuration File Format](#configuration-file-format)
* [Default Name of a Configuration File](#default-name-of-a-configuration-file)
* [Default Location of Configuration Files](#default-location-of-configuration-files)
* [Important Configuration Sections](#important-configuration-sections)
* [SSL/TLS Configuration (Section <em>tls</em>)](#ssltls-configuration-section-tls)
* [SSL/TLS In-Code Configuration](#ssltls-in-code-configuration)
* [SSL/TLS Command Line Configuration](#ssltls-command-line-configuration)
* [Using SSL/TLS with Other Network Layers](#using-ssltls-with-other-network-layers)
* [Socket Configuration (Section <em>socket</em>)](#socket-configuration-section-socket)
* [Common <em>socket</em> Options for <em>SocketServer</em> and <em>SocketClient</em> Instances](#common-socket-options-for-socketserver-and-socketclient-instances)
* [Specific <em>socket</em> Options for IPv4 and IPv6 <em>SocketServer</em>](#specific-socket-options-for-ipv4-and-ipv6-socketserver)
* [Specific <em>socket</em> Options for IPv6 <em>SocketServer</em> and <em>SocketClient</em>](#specific-socket-options-for-ipv6-socketserver-and-socketclient)
* [Using More Than One Instance in an Application](#using-more-than-one-instance-in-an-application)
* [Application Leyer Protocols APIs](#application-leyer-protocols-apis)
* [Basic HTTP-Server and HTTP-Client API](#basic-http-server-and-http-client-api)
* [Highlevel WEB-API a'la Node.JS-Express](#highlevel-web-api-ala-nodejs-express)
* [WebSockets](#websockets)
* [Basic MQTT-Server an MQTT-Client API](#basic-mqtt-server-an-mqtt-client-api)
* [MQTT Over WebSocket](#mqtt-over-websocket)
* [Database Support](#database-support)
* [MariaDB](#mariadb)
* [Example Applications](#example-applications)
* [HTTP/S Web-Server for Static HTML-Pages](#https-web-server-for-static-html-pages)
* [Receive Data via HTTP-Post Request](#receive-data-via-http-post-request)
* [Extract Server and Client Information (host name, IP, port, SSL/TLS information)](#extract-server-and-client-information-host-name-ip-port-ssltls-information)
* [Using Regular Expressions in Routes](#using-regular-expressions-in-routes)

<!-- Added by: runner, at: Wed Sep 13 18:31:54 UTC 2023 -->


<!-- Added by: runner, at: Fri Sep 22 06:25:01 UTC 2023 -->

<!--te-->

Expand Down

0 comments on commit 3f5cc17

Please sign in to comment.