Skip to content

Commit 5b1e2fc

Browse files
committed
Fixed cross references.
1 parent 455d65d commit 5b1e2fc

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
# 💡 What is RSPLIB?
1212

13-
[Reliable Server Pooling (RSerPool)](#what-is-reliable-server-pooling-rserpool) is the new IETF framework for server pool management and session failover handling. In particular, it can be used for realising highly available services and load distribution. RSPLIB is the reference implementation of RSerPool. It includes:
13+
[Reliable Server Pooling (RSerPool)](#-what-is-reliable-server-pooling-rserpool) is the new IETF framework for server pool management and session failover handling. In particular, it can be used for realising highly available services and load distribution. RSPLIB is the reference implementation of RSerPool. It includes:
1414

1515
* The library librsplib, which is the RSerPool implementation itself;
1616
* The library libcpprspserver, which is a C++ wrapper library to easily write server applications based on librsplib;
@@ -191,7 +191,7 @@ Ensure that your firewall settings allow UDP packets to/from the registrar (ASAP
191191
rspregistrar
192192
```
193193

194-
See [Registrar](#registrar) for registrar parameters.
194+
See [Registrar](#-registrar) for registrar parameters.
195195

196196
## Start at least one pool element
197197

@@ -240,14 +240,14 @@ It takes a set of common parameters as well as some service-specific arguments.
240240

241241
The following example PE services are provided:
242242

243-
* [Echo Service](#echo-service): A simple echo service. The server-side returns the received payload as-is, i.e. echoes it.
244-
* [Discard Service](#discard-service): A simple discard service. The server-side just ignores the received payload.
245-
* [Daytime Service](#daytime-service): A simple daytime service. The server-side responds with the current date and time.
246-
* [Character Generator (CharGen) Service](#character-generator-service): A simple character generator service. The server-side generates test data.
247-
* [Ping Pong Service](#ping-pong-service): A simple request-response service.
248-
* [Scripting Service](#scripting-service): An example workload-offloading service. It is for example used by [SimProcTC](https://github.com/dreibh/simproctc).
249-
* [Fractal Generator Service](#fractal-generator-service): The fractal graphics computation service, for testing and illustratively demonstrating RSerPool features. It is also used for the [RSerPool Demo Tool](https://github.com/dreibh/rserpooldemo).
250-
* [Calculation Application (CalcApp) Service](#calculation-application-service): A simulated calculation application, for evaluating load distribution. Details can be found in «[Reliable Server Pooling – Evaluation, Optimization and Extension of a Novel IETF Architecture](https://duepublico2.uni-due.de/servlets/MCRFileNodeServlet/duepublico_derivate_00016326/Dre2006_final.pdf)».
243+
* [Echo Service](#-echo-service): A simple echo service. The server-side returns the received payload as-is, i.e. echoes it.
244+
* [Discard Service](#-discard-service): A simple discard service. The server-side just ignores the received payload.
245+
* [Daytime Service](#-daytime-service): A simple daytime service. The server-side responds with the current date and time.
246+
* [Character Generator (CharGen) Service](#-character-generator-service): A simple character generator service. The server-side generates test data.
247+
* [Ping Pong Service](#-ping-pong-service): A simple request-response service.
248+
* [Scripting Service](#-scripting-service): An example workload-offloading service. It is for example used by [SimProcTC](https://github.com/dreibh/simproctc).
249+
* [Fractal Generator Service](#-fractal-generator-service): The fractal graphics computation service, for testing and illustratively demonstrating RSerPool features. It is also used for the [RSerPool Demo Tool](https://github.com/dreibh/rserpooldemo).
250+
* [Calculation Application (CalcApp) Service](#-calculation-application-service): A simulated calculation application, for evaluating load distribution. Details can be found in «[Reliable Server Pooling – Evaluation, Optimization and Extension of a Novel IETF Architecture](https://duepublico2.uni-due.de/servlets/MCRFileNodeServlet/duepublico_derivate_00016326/Dre2006_final.pdf)».
251251

252252
Notes:
253253

@@ -267,8 +267,8 @@ Notes:
267267
* ```-logcolor=on|off```: Turns ANSI colorization of the logging output on or off.
268268
* ```-logfile=<filename>```: Writes logging output to a file (default is stdout).
269269
* ```-poolhandle=<poolhandle>```: Sets the PH to a non-default value; otherwise, the default setting will be the service-specific default (see below).
270-
* ```-cspserver=<address>:<port>```: See [Component Status Protocol](#component-status-protocol) below.
271-
* ```-cspinterval=<milliseconds>```: See [Component Status Protocol](#component-status-protocol) below.
270+
* ```-cspserver=<address>:<port>```: See [Component Status Protocol](#-component-status-protocol) below.
271+
* ```-cspinterval=<milliseconds>```: See [Component Status Protocol](#-component-status-protocol) below.
272272
* ```-registrar=<address>:<port>```: Adds a static PR entry into the Registrar Table. It is possible to add multiple entries.
273273
* ```-asapannounce=<address>:<port>```: Sets the multicast address and port the ASAP instance listens for ASAP Server Announces on.
274274
* ```-rereginterval=<milliseconds>```: Sets the PE's re-registration interval (in milliseconds).
@@ -430,18 +430,18 @@ The pool users provides some common options for all programs:
430430
* ```-logcolor=on|off```: Turns ANSI colorization of the logging output on or off.
431431
* ```-logfile=<filename>```: Writes logging output to a file (default is stdout).
432432
* ```-poolhandle=<poolhandle>```: Sets the PH to a non-default value; otherwise, the default setting will be the service-specific default (see below).
433-
* ```-cspserver=<address>:<port>```: See [Component Status Protocol](#component-status-protocol) below.
434-
* ```-cspinterval=<milliseconds>```: See [Component Status Protocol](#component-status-protocol) below.
433+
* ```-cspserver=<address>:<port>```: See [Component Status Protocol](#-component-status-protocol) below.
434+
* ```-cspinterval=<milliseconds>```: See [Component Status Protocol](#-component-status-protocol) below.
435435
* ```-registrar=<address>:<port>```: Adds a static PR entry into the Registrar Table. It is possible to add multiple entries.
436436

437437

438438
## Terminal Client
439439

440440
The PU for the
441-
[Echo Service](#echo-service),
442-
[Discard Service](#discard-service),
443-
[Daytime Service](#daytime-service), or
444-
[Character Generator Service](#character-generator-service)
441+
[Echo Service](#-echo-service),
442+
[Discard Service](#-discard-service),
443+
[Daytime Service](#-daytime-service), or
444+
[Character Generator Service](#-character-generator-service)
445445
can be started by:
446446

447447
```bash
@@ -467,7 +467,7 @@ Notes:
467467

468468
## Ping Pong Client
469469

470-
The PU for the [Ping Pong Service](#ping-pong-service) can be started by:
470+
The PU for the [Ping Pong Service](#-ping-pong-service) can be started by:
471471

472472
```
473473
pingpongclient
@@ -492,7 +492,7 @@ man pingpongclient
492492

493493
## Scripting Client
494494

495-
The PU for the [Scripting Service](#scripting-service) can be started by:
495+
The PU for the [Scripting Service](#-scripting-service) can be started by:
496496

497497
```
498498
scriptingclient
@@ -525,7 +525,7 @@ The Scripting Service is used e.g. by the following open source tools, which pro
525525

526526
## Fractal Generator Client
527527

528-
The PU for the [Fractal Generator Service](#fractal-generator-service) can be started by:
528+
The PU for the [Fractal Generator Service](#-fractal-generator-service) can be started by:
529529

530530
```bash
531531
fractalpooluser <OPTIONS> ...
@@ -554,7 +554,7 @@ man fractalpooluser
554554

555555
## Calculation Application Client
556556

557-
The PU for the [Calculation Application Service](#calculation-application-service) (CalcApp) can be started by:
557+
The PU for the [Calculation Application Service](#-calculation-application-service) (CalcApp) can be started by:
558558

559559
```
560560
calcappclient
@@ -601,8 +601,8 @@ rspregistrar <OPTIONS> ...
601601
* ```-loglevel=0-9```: Sets the logging verbosity from 0 (none) to 9 (very verbose).
602602
* ```-logcolor=on|off```: Turns ANSI colorization of the logging output on or off.
603603
* ```-logfile=<filename>```: Writes logging output to a file (default is stdout).
604-
* ```-cspserver=<address>:<port>```: See [Component Status Protocol](#component-status-protocol) below.
605-
* ```-cspinterval=<milliseconds>```: See [Component Status Protocol](#component-status-protocol) below.
604+
* ```-cspserver=<address>:<port>```: See [Component Status Protocol](#-component-status-protocol) below.
605+
* ```-cspinterval=<milliseconds>```: See [Component Status Protocol](#-component-status-protocol) below.
606606

607607

608608
## ASAP Parameters

0 commit comments

Comments
 (0)