No description

Find a file

Stephen Seo 77d69cabbc Impl "unsafe" versions of UDPC_atostr(...) These "unsafe" versions are guaranteed to not have the returned address strings be overwritten by UDPC, but they must be manually free'd later (as mentioned in the documentation).		2023-06-22 13:25:26 +09:00
.github/workflows	Add gh-pages workflow for Doxygen documentation	2021-09-09 18:10:07 +09:00
src	Impl "unsafe" versions of UDPC_atostr(...)	2023-06-22 13:25:26 +09:00
.gitignore	Update .gitignore	2021-08-30 12:07:27 +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	Update LICENSE year	2023-04-18 14:05:52 +09:00
README.md	Update README.md	2021-09-09 18:13:38 +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

See the gh-pages generated Doxygen documentation here.

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.

Links

https://github.com/Stephen-Seo/UDPConnection
https://git.seodisparate.com/stephenseo/UDPConnection