stephenseo/UDPConnection
1
0
Fork 0
Code Issues Pull requests Actions Projects Releases Wiki Activity
UDPConnection/README.md
Stephen Seo 3575ee9d26 Update README.md
2020-01-13 18:50:00 +09:00

878 B
Raw Blame History

UDPConnection

Provides a network connection over UDP, with verification of packet support via libsodium (optional). Implemented in C++, but is available via a C api, which should facilitate creating bindings for other programming languages if needed.

This library is still a work in progress, so api breaking changes may happen in the future.

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.

Compiling

mkdir buildRelease
cd buildRelease
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr -DBUILD_SHARED_LIBS=True ..
make
make DESTDIR=install_destination install

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.