Skip to content

v1.3.0 - API Improvements and Enhanced Documentation

Latest

Choose a tag to compare

@jrepp jrepp released this 08 Nov 21:22
· 8 commits to main since this release

Release 1.3.0

This release includes API improvements, enhanced documentation, and formal RFC conformance declarations.

API Improvements

  • String Size Constants Enhancement: Converted IPV6_STRING_SIZE from runtime extern const to compile-time #define (value: 66), enabling compile-time buffer allocation and improved performance
  • New Constant: Added IPV4_STRING_SIZE define (value: 22) for IPv4-specific string operations

Documentation Enhancements

  • RFC Conformance: Explicitly documented compliance with:
    • RFC 4291: IPv6 Addressing Architecture
    • RFC 5952: IPv6 Address Text Representation
    • RFC 4007: IPv6 Scoped Address Architecture (Zone IDs)
  • Enhanced Feature Documentation:
    • IPv4 addresses with less than 4 octets (e.g., 1 -> 0.0.0.1, 1.2 -> 1.0.0.2)
    • Basic IPv4 with port notation (e.g., 10.1:8080 -> 10.0.0.1:8080)
  • License Header: Added comprehensive MIT license copyright header to the main header file

Backward Compatibility

All existing types and functions remain unchanged:

  • ipv6_flag_t, ipv6_address_t, ipv6_address_full_t
  • ipv6_compare_result_t, ipv6_diag_event_t, ipv6_diag_info_t
  • ✅ All API functions: ipv6_from_str, ipv6_from_str_diag, ipv6_to_str, ipv6_compare

The change to IPV6_STRING_SIZE is backward compatible as the value (66) remains the same, only the definition mechanism has improved.