Skip to content

Commit

Permalink
Polish
Browse files Browse the repository at this point in the history
Signed-off-by: Volker Christian <[email protected]>
  • Loading branch information
VolkerChristian committed Jan 2, 2025
1 parent 7fdfba7 commit 1eb7aef
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Main focus (but not only) of the framework is on *Machine to Machine* (M2M) comm

# Table of Content
<!--ts-->
* [Simple NODE in C++ (SNode.C)](#simple-node-in-c-snodec)
* [Simple NODE in C++ (SNode.C)](#simple-node-in-c++-snode.c)
* [Table of Content](#table-of-content)
* [License](#license)
* [Copyright](#copyright)
Expand Down Expand Up @@ -198,13 +198,13 @@ For the *server role* we just need to create an object of type
net::in::stream::legacy::SocketServer<SocketContextFactory>
```

called [*server instance*](#SocketServer-Classes) and for the *client role* an object of type
called [*server instance*](#socketserver-classes) and for the *client role* an object of type

```cpp
net::in::stream::legacy::SocketClient<SocketContextFactory>
```

is required, called [*client instance*](#SocketClient-Classes).
is required, called [*client instance*](#socketclient-classes).

A class `SocketContextFactory` is used for both instances as template argument. Such a `SocketContextFactory` needs to be provided by the user and is used internally by the `SocketServer` and the `SocketClient` instances to create a concrete `SocketContext` object for each established connection.

Expand Down Expand Up @@ -715,7 +715,7 @@ cd <DIR>
wget -qO - https://downloads.openwrt.org/releases/23.05.0-rc2/targets/ipq40xx/generic/openwrt-sdk-23.05.0-rc2-ipq40xx-generic_gcc-12.3.0_musl_eabi.Linux-x86_64.tar.xz | tar Jx
```

to create the SDK directory `openwrt-sdk-<version>-<architecture>-<atype>_<compiler>-<cverstion>_<libc>_<abi>.Linux-x86_64` what from now on is referred as <SDK_DIR>.
to create the SDK directory `openwrt-sdk-<version>-<architecture>-<atype>_<compiler>-<cverstion>_<libc>_<abi>.Linux-x86_64` what from now on is referred as \<SDK_DIR\>.

In this example the values of the placeholder are:

Expand Down Expand Up @@ -1288,9 +1288,9 @@ The `const core::socket::State& state` object passed to the callback reports the
```cpp
state == core::socket::State::OK
```

The `ServerSocket` instance has been created successfully and is ready for accepting incoming client connections.

```cpp
state == core::socket::State::DISABLED
```
Expand All @@ -1300,13 +1300,13 @@ The `ServerSocket` instance is disabled
```cpp
state == core::socket::State::ERROR
```

During switching to the listening state a recoverable error has occurred. In case a *retry* is configured for this instance the listen attempt is retried automatically.

```cpp
state == core::socket::State::FATAL
```

A nonee recoverable error has occurred. No listen-retry is done.

#### Common `listen()` Methods
Expand Down Expand Up @@ -1465,25 +1465,25 @@ The `const core::socket::State& state` value passed to the callback reports the
```cpp
state == core::socket::State::OK
```

The `ClientSocket` instance has been created and connected to the peer successfully.

```cpp
state == core::socket::State::DISABLED
```

The `ClientSocket` instance is disabled

```cpp
state == core::socket::State::ERROR
```

During switching to the connected state a recoverable error has occurred. In case a *retry* is configured for this instance the connect attempt is retried automatically.

```
state == core::socket::State::FATAL
```

A non recoverable error has occurred. No connect-retry is done.

#### Common `connect()` Methods
Expand Down Expand Up @@ -2057,7 +2057,7 @@ One can switch between sections by just specifying a different section name.
### Configuration via a Configuration File
For every application a configuration file can be generated by appending the switch `-w` or `--write-config` to the command line. Optionally `--write-config` takes a filename as value. If no filename is provided a default filename is used (see [Default Name of a Configuration File](#Default-Name-of-a-Configuration-File)).
For every application a configuration file can be generated by appending the switch `-w` or `--write-config` to the command line. Optionally `--write-config` takes a filename as value. If no filename is provided a default filename is used (see [Default Name of a Configuration File](#default-name-of-a-configuration-file)).
#### Configuration File Format
Expand Down

0 comments on commit 1eb7aef

Please sign in to comment.