You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Stephen Seo 211715fc56 Fix potential nullptr deref in free_PacketInfo_ptr		1 month ago
.github/workflows	Add gh-pages workflow for Doxygen documentation	2 years ago
src	Fix potential nullptr deref in free_PacketInfo_ptr	1 month ago
.gitignore	Update .gitignore	2 years ago
.gitmodules	Remove unused TSQueue and RingBuffer	4 years ago
CMakeLists.txt	Distinguish manual variables and pkgconf variables	3 years ago
Doxyfile	Fix doxygen documentation	3 years ago
LICENSE	Update LICENSE year	1 month ago
README.md	Update README.md	2 years ago

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