udp-over-tcp/CHANGELOG.md

Changelog

All changes to the software that can be noticed from the users' perspective should have an entry in this file. Except very minor things that will not affect functionality.

Format

The format is based on Keep a Changelog.

Entries should have the imperative form, just like commit messages. Start each entry with words like add, fix, increase, force etc.. Not added, fixed, increased, forced etc.

Line wrap the file at 100 chars. That is over here -> |

Categories each change fall into

• Added: for new features.
• Changed: for changes in existing functionality.
• Deprecated: for soon-to-be removed features.
• Removed: for now removed features.
• Fixed: for any bug fixes.
• Security: in case of vulnerabilities.

[Unreleased]

Changed

• Change the public API of ApplyTcpOptionsError. So this is a breaking change. This stops exposing the internal details of the type which allows future changes to not be breaking.

[0.4.0] - 2024-01-02

Changed

• Add (optional) statsd metrics reporting support to tcp2udp binary and library module when the statsd cargo feature is enabled.
• Breaking: Make options structs and error enums #[non_exhaustive] in order to allow adding more fields to them later without being breaking changes then.

[0.3.1] - 2023-10-25

Changed

• Use cool down period if TCP accept fails. This avoids excessive CPU usage e.g. when there are no free file descriptors available to be allocated.

[0.3.0] - 2023-02-28

Added

• Add support for disabling the Nagle algorithm by setting TcpOptions.nodelay = true, and expose it as a --nodelay flag on the udp2tcp and tcp2udp binaries.

Fixed

• When tcp2udp is run, select the address family for the UDP socket based on the destination address. Previously, AF_INET was always used by default.

Changed

• Upgrade to clap 4 instead of structopt.
• MSRV increased to 1.64.0 due to clap upgrade.

[0.2.0] - 2022-03-23

Added

• Add a helper build script (build-static-bins.sh) to build the binaries as statically linked executables on Linux
• Add TCP recv timeout support. Allows setting an upper limit on how long the library/program will wait for data on the TCP socket before closing the connection.

Changed

• Make structopt dependency optional, but require it for the binaries. Allows using the library part without pulling in structopt.

Fixed

• Destroy all sockets when Udp2Tcp::run future is dropped
• Move socket buffers to the heap to avoid crashes on machines with too small stack sizes in debug builds.

... And more. We never really cut any 0.1.0 release

[0.1.0] - ?

There never was a real 0.1.0 release. We just kept using the main branch commits