2020-01-13 09:40:14 +00:00
|
|
|
# UDPConnection
|
|
|
|
|
|
|
|
|
|
Provides a network connection over UDP, with verification of packet support via
|
2020-01-13 10:14:34 +00:00
|
|
|
libsodium (optional). Implemented in C++ (up to C++11 standard), but is
|
|
|
|
|
available via a C api, which should facilitate creating bindings for other
|
|
|
|
|
programming languages if needed.
|
2020-01-13 09:40:14 +00:00
|
|
|
|
|
|
|
|
This library is still a work in progress, so api breaking changes may happen
|
|
|
|
|
in the future.
|
|
|
|
|
|
2020-01-13 09:50:00 +00:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
`src/UDPC.h` is documented with Doxygen style comments. The doxygen docs can be
|
|
|
|
|
created by invoking `doxygen Doxyfile` in the root directory of the project.
|
|
|
|
|
|
2020-01-13 09:40:14 +00:00
|
|
|
## Compiling
|
|
|
|
|
|
2020-01-13 10:26:05 +00:00
|
|
|
### Release builds
|
|
|
|
|
|
2020-01-13 09:40:14 +00:00
|
|
|
mkdir buildRelease
|
|
|
|
|
cd buildRelease
|
|
|
|
|
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_SHARED_LIBS=True ..
|
|
|
|
|
make
|
|
|
|
|
make DESTDIR=install_destination install
|
2020-01-13 09:47:22 +00:00
|
|
|
|
2020-01-13 10:26:05 +00:00
|
|
|
### Debug builds
|
|
|
|
|
|
|
|
|
|
mkdir buildDebug
|
|
|
|
|
cd buildDebug
|
|
|
|
|
cmake -DCMAKE_BUILD_TYPE=Debug ..
|
|
|
|
|
make
|
|
|
|
|
|
2020-01-13 09:47:22 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
The program in `src/test/UDPC_NetworkTest.c` is used for testing UDPConnection
|
|
|
|
|
and is also an example of using the library in a C program.
|
2020-01-13 10:14:34 +00:00
|
|
|
|
|
|
|
|
## Debug Builds
|
|
|
|
|
|
|
|
|
|
NetworkTest only builds when CMAKE\_BUILD\_TYPE is Debug (default).
|
|
|
|
|
|
|
|
|
|
UnitTest only builds in Debug mode and if GTest (a unit testing framework) is
|
|
|
|
|
available.
|
