Skip to content

Commit 1eb7aef

Browse files
Polish
Signed-off-by: Volker Christian <[email protected]>
1 parent 7fdfba7 commit 1eb7aef

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Main focus (but not only) of the framework is on *Machine to Machine* (M2M) comm
88

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

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

203203
```cpp
204204
net::in::stream::legacy::SocketClient<SocketContextFactory>
205205
```
206206

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

209209
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.
210210

@@ -715,7 +715,7 @@ cd <DIR>
715715
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
716716
```
717717

718-
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>.
718+
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\>.
719719

720720
In this example the values of the placeholder are:
721721

@@ -1288,9 +1288,9 @@ The `const core::socket::State& state` object passed to the callback reports the
12881288
```cpp
12891289
state == core::socket::State::OK
12901290
```
1291-
1291+
12921292
The `ServerSocket` instance has been created successfully and is ready for accepting incoming client connections.
1293-
1293+
12941294
```cpp
12951295
state == core::socket::State::DISABLED
12961296
```
@@ -1300,13 +1300,13 @@ The `ServerSocket` instance is disabled
13001300
```cpp
13011301
state == core::socket::State::ERROR
13021302
```
1303-
1303+
13041304
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.
1305-
1305+
13061306
```cpp
13071307
state == core::socket::State::FATAL
13081308
```
1309-
1309+
13101310
A nonee recoverable error has occurred. No listen-retry is done.
13111311

13121312
#### Common `listen()` Methods
@@ -1465,25 +1465,25 @@ The `const core::socket::State& state` value passed to the callback reports the
14651465
```cpp
14661466
state == core::socket::State::OK
14671467
```
1468-
1468+
14691469
The `ClientSocket` instance has been created and connected to the peer successfully.
1470-
1470+
14711471
```cpp
14721472
state == core::socket::State::DISABLED
14731473
```
1474-
1474+
14751475
The `ClientSocket` instance is disabled
1476-
1476+
14771477
```cpp
14781478
state == core::socket::State::ERROR
14791479
```
1480-
1480+
14811481
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.
1482-
1482+
14831483
```
14841484
state == core::socket::State::FATAL
14851485
```
1486-
1486+
14871487
A non recoverable error has occurred. No connect-retry is done.
14881488

14891489
#### Common `connect()` Methods
@@ -2057,7 +2057,7 @@ One can switch between sections by just specifying a different section name.
20572057
20582058
### Configuration via a Configuration File
20592059
2060-
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)).
2060+
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)).
20612061
20622062
#### Configuration File Format
20632063

0 commit comments

Comments
 (0)