Minor fix, TODO comment

Recent changes caused a packet timeout to be either 1 second or double
the heartbeat interval time (the maximum of the two). This is kind of a
problem since packet timeout should be ideally decided based on the
peer's heartbeat interval time, not this instance's heartbeat interval
time.

Some "scaffolding" code should be added:

  - Heartbeat packets should send the current instance's heartbeat
    interval time.
  - Max capacity of cached sent packets should be increased based on
    the peer's heartbeat interval and the rate of received non-heartbeat
    packets.
  - Maybe have a function to tell UDPC the intended usage regarding
    latency: focus on low-latency default behavior, or focus on high
    latency low packet-send-rate behavior.

The current changes should be reverted on master and the new changes
should be held back for now until this is all set up.

Minor improvements to unit test (con-timeout)

Add getters (heartbeat and timeout), unit tests

Add UDPC_set_con_timeout_millis(...)

Add new function to set the connection timeout time. By default, this
timeout time is 10 seconds. If a packet hasn't been received for this
duration, then the connection is considered "timed out" and is dropped.

Previously this time was a constant 10 seconds. This commit allows
changing the connection timeout time. However, it cannot be less than
the heartbeat interval time.

Refactor heartbeat related code (constants)

Merge branch 'dev', version 1.4

Fix timeouts with long heartbeat interval durations.

Version 1.4

Fix packet timeout with large heartbeat times

Remove unused includes

Merge branch 'dev', version 1.3

Update UDPC.h doxygen documentation

Update README.md

Update LICENSE year

Add option to set heartbeat interval in test

Add function to change heartbeat interval

Use std::shared_mutex for peerPKWhitelist

Unlike most mutex usages in UDPC, this mutex sometimes does read-only
operations, so it makes sense to use a std::shared_mutex here.

Use constexpr for constants

Update CMake version, c++ std 17, version 1.3

Update README.md

Remove links to git.seodisparate.com as I no longer host a repository
(and conan repository) there.

Update release action/workflow

Version 1.2

Conan configuration was changed, so bump version for it.

Minor fix to info in release action/workflow

Release versions of UDPC without libsodium

Update release info in release action/workflow

Add forgejo workflow to build and publish library

Update version to 1.1

Specify "SOVERSION" for shared lib so that libUDPC.so.1 is the default
instead of libUDPC.so.1.0 .

Update README.md

Update README.md

Update README.md

Add link to published conan package

Rework unit-tests to not use GTest

Have forgejo action/workflow use "any_archLinux"

std::atomic doesn't need volatile

Reduce verbosity of unit test logs

Allow move for TSLQIter

Should fix builds of UDPConnection.cpp with "-std=c++11".

Github action: ensure current ref is checked out

Use apt-get, add libsodium dep to github action

Add Github action to run UnitTests

Add action/workflow to run UnitTest

Add UnitTest file for CXX11_shared_spin_lock

Tweak compare_exchange_weak(...) in spin-lock

Fix invalid use of mutex in TSLQueue

Mutex was removed in favor of the custom SharedSpinLock.

Don't fail on "try" fns if failed to get spinLock

In SharedSpinLock: Only fail on "try" fns after spinLock was acquired
and condition is not met.

Refactor shared-spin-lock to use atomic "spinLock"

Minor refactorings

Reland C++11 "shared_lock" with iter remove fix

On iterator remove, the iterator will trade the read lock for a write
lock, and trade back for a read lock once the remove has been completed.

Add note in docs about update for UDPC_init(...)

Update LICENSE year

Update debug optimization flag

UnitTest for start/stop threaded update and fix

Enforce thread-safety on destroy context

Use mutex when enabling/disabling threaded-update

Use atomic_bool for auto-updating "flag"

Add note about usage of UDPC header in docs

Note in documentation about thread safety

Basically, all functions should be thread-safe unless mentioned
otherwise.

Fixes to .forgejo/workflows/doxygen.yaml

Update README.md

Use rsync setting up seodisparate doxygen docs

Add Forgejo workflow for doxygen docs

Revert "Impl "RWLock" for use in TSLQueue"

This reverts commit cf27a6bb76f4dae2344d6061eb199e2b35eb754a.

The use of "shared_lock" in TSLQueue is unsafe because of two things:

  - The TSLQueue iterator takes a "read" lock.
  - The TSLQueue iterator can erase the current element.

Revert "Replace unnecessary use of atomic in "shared_lock""

This reverts commit b50e50b5fbdeaa3990984a6bda052bbb92c234a9.

Replace unnecessary use of atomic in "shared_lock"

Impl "RWLock" for use in TSLQueue

This project supports C++11, and std::shared_lock was made available in
C++17, thus a "shared_spin_lock" was created with similar functionality.
This "shared_spin_lock" is used in TSLQueue.

Fix CMakeLists.txt, handle -Weffc++ warnings

Update README.md

Add docs for UDPC_no* functions

Update README.md

Refactor addr logprint via template specialization

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).

Conditionally use UDPC_atostr internally

Previous implementation used UDPC_atostr() frequently. This commit
changes the implementation to only call UDPC_atostr() if the log level
of the code logging to output will cause the log to be output.

Add documentation for UDPC_atostr...

Fix potential memory corruption bug

UDPC_atostr(...) uses a uint32_t as an offset into a buffer inside the
UDPC Context such that there can be at most 32 different addr-strings.
The call is thread-safe, up to a point (at most 32 concurrent calls will
return correct strings). The problem was that the offset was not being
reset to 0 and was always being incremented by 40. Should the offset
overflow, the offset into the buffer will be "mis-aligned" such that the
32nd offset into the buffer can possibly overwrite memory past the
buffer's end if the addr string is long enough.

The fix is to use a mutex instead of an atomic uint32_t to lock a
code-block that will always prevent overflow (using modulus operator).

I think the speed-loss is negligable (using a lock instead of an atomic
uint32_t) since it isn't expected for programs using UDPC to use
UDPC_atostr(...) very frequently.

Fix potential nullptr deref in free_PacketInfo_ptr

Add UDPC_free_PacketInfo_ptr(...)

Also add unit test for this function.

Update LICENSE year

Refactor UDPC::get_empty_pinfo()

Impl handling Ctrl-C for Windows in NetworkTest

Better handling of receiving packets in recv loop

On error processing a received packet, continue to receive packets in
the loop. If no packet was received, the loop ends.

Update documentation about UDPC_update(ctx)

Receive packets in loop til none left in interval

Also some formatting fixes (max 80 chars in edited code).

Update LICENSE

Handle SIGINT (Ctrl-C) in NetworkTest

Update README.md

Add gh-pages workflow for Doxygen documentation

Update .gitignore

Fix README.md

Update README.md

Update year in LICENSE

Add |id| to PacketInfo

Use dll_export (for builds for Windows)

Attempt to make NetworkTest work on Windows

Add/fix more documentation

Minor fixes

Fix check addr endianness in a4toa6 function

Impl create id with hostname

Previously, ids could only be created with an ip address. Now they can
be made with a hostname, which will be looked up by UDPC.

Also fix client still requesting connections even if
accept-new-connections flag is false.

Minor fix to documentation

Use memcpy instead of pointer casted assignment

std::memcpy is used over int pointer casted assignment due to possible
alignment issues that may cause the casted pointer to be invalid.

Change how UDPC_PacketInfo handles it's data

The "data" member variable in UDPC_PacketInfo is now handled as a
pointer to dynamic data, instead of an array with a fixed size. Every
time a UDPC_PacketInfo is received from the context,
UDPC_free_PacketInfo() must be called on it to avoid a memory leak.

Fix compilation fail on no libsodium

Fix use of C++14/C++17, only C++11 is supported