No description

Find a file

Stephen Seo 80e67e845c Distinguish manual variables and pkgconf variables Variables checked to manually set libsodium paths have been changed to prevent conflict with variables set by searching for libsodium via pkgconfig.		2020-01-16 11:31:22 +09:00
src	Fix verification message when using libsodium	2020-01-15 16:31:38 +09:00
.gitignore	Update .gitignore	2019-12-04 15:08:25 +09:00
.gitmodules	Remove unused TSQueue and RingBuffer	2019-11-06 14:42:35 +09:00
CMakeLists.txt	Distinguish manual variables and pkgconf variables	2020-01-16 11:31:22 +09:00
Doxyfile	Fix doxygen documentation	2020-01-13 19:22:08 +09:00
LICENSE	Add LICENSE and README.md	2020-01-13 18:41:38 +09:00
README.md	Update README.md	2020-01-13 19:26:05 +09:00

README.md

UDPConnection

Provides a network connection over UDP, with verification of packet support via 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.

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

Release builds

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

Debug builds

mkdir buildDebug
cd buildDebug
cmake -DCMAKE_BUILD_TYPE=Debug ..
make

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.

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.