Update README.md

This commit is contained in:
Stephen Seo 2023-07-03 12:03:52 +09:00
parent 972ec73e88
commit 4887cc2ae5

View file

@ -5,8 +5,41 @@ libsodium (optional). Implemented in C++ (up to C++11 standard), but is
available via a C api, which should facilitate creating bindings for other available via a C api, which should facilitate creating bindings for other
programming languages if needed. programming languages if needed.
This library is still a work in progress, so api breaking changes may happen ~~This library is still a work in progress, so api breaking changes may happen
in the future. in the future.~~
This library is usable. Try testing it out using the `NetworkTest` binary which
is built when Debug builds are enabled (the default) with CMake.
$ ./NetworkTest
[-c | -s] - client or server (default server)
-ll <addr> - listen addr
-lp <port> - listen port
-cl <addr> - connection addr (client only)
-clh <hostname> - connection hostname (client only)
-cp <port> - connection port (client only)
-t <tick_count>
-n - do not add payload to packets
-l (silent|error|warning|info|verbose|debug) - log level, default debug
-e - enable receiving events
-ls - enable libsodium
-ck <pubkey_file> - add pubkey to whitelist
-sk <pubkey> <seckey> - start with pub/sec key pair
-p <"fallback" or "strict"> - set auth policy
--hostname <hostname> - dont run test, just lookup hostname
A typical test can be done with the following parameters:
Server:
./NetworkTest -s -ll ::1 -lp 9000 -t 50 -e
Client:
./NetworkTest -c -ll ::1 -lp 9001 -cl ::1 -cp 9000 -t 40 -e
`NetworkTest` gracefully shuts down on SIGINT (Ctrl-C).
The source of `NetworkTest` can be found in `src/test/UDPC_NetworkTest.c`.
## Documentation ## Documentation