docs(refactor): Phase 1 - Prepare for internal header migration#611
Merged
Merged
Conversation
Prepare for moving 118 implementation headers to src/internal/ as part of Epic #577 to reduce public API surface from 153 to < 40 headers. Changes: - Add comprehensive header audit document categorizing all 153 headers - Create migration guide with facade API usage examples - Add deprecation warnings to core headers (TCP/UDP client/server) - Document 4-phase refactoring plan The deprecation warnings inform users about upcoming v2.0 changes and direct them to use facade API instead of direct implementation headers. Users can suppress warnings with NETWORK_SYSTEM_SUPPRESS_DEPRECATION_WARNINGS. Files added: - docs/refactoring/HEADER_AUDIT_PHASE1.md - docs/refactoring/MIGRATION_GUIDE_V2.md - docs/refactoring/README.md Files modified: - include/kcenon/network/core/messaging_client.h - include/kcenon/network/core/messaging_server.h - include/kcenon/network/core/messaging_udp_client.h - include/kcenon/network/core/messaging_udp_server.h Related: #610, #577
8 tasks
Contributor
Performance ComparisonBase Branch ResultsNo base results PR Branch ResultsNo PR results |
kcenon
deleted the
refactor/issue-610-phase1-prepare-internal-migration
branch
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
…#611) Prepare for moving 118 implementation headers to src/internal/ as part of Epic #577 to reduce public API surface from 153 to < 40 headers. Changes: - Add comprehensive header audit document categorizing all 153 headers - Create migration guide with facade API usage examples - Add deprecation warnings to core headers (TCP/UDP client/server) - Document 4-phase refactoring plan The deprecation warnings inform users about upcoming v2.0 changes and direct them to use facade API instead of direct implementation headers. Users can suppress warnings with NETWORK_SYSTEM_SUPPRESS_DEPRECATION_WARNINGS. Files added: - docs/refactoring/HEADER_AUDIT_PHASE1.md - docs/refactoring/MIGRATION_GUIDE_V2.md - docs/refactoring/README.md Files modified: - include/kcenon/network/core/messaging_client.h - include/kcenon/network/core/messaging_server.h - include/kcenon/network/core/messaging_udp_client.h - include/kcenon/network/core/messaging_udp_server.h Related: #610, #577
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #610
Summary
This PR implements Phase 1 of the internal header migration plan (Epic #577), preparing the foundation for moving 118 implementation headers to
src/internal/to reduce the public API surface from 153 to < 40 headers.Key Changes
Comprehensive Header Audit (
docs/refactoring/HEADER_AUDIT_PHASE1.md)Migration Guide (
docs/refactoring/MIGRATION_GUIDE_V2.md)Deprecation Warnings
messaging_client.hmessaging_server.hmessaging_udp_client.hmessaging_udp_server.hNETWORK_SYSTEM_SUPPRESS_DEPRECATION_WARNINGSGoals Achieved
No Breaking Changes
This PR does not break any existing code. It only:
Migration Path
For Users
docs/refactoring/MIGRATION_GUIDE_V2.mdNETWORK_SYSTEM_SUPPRESS_DEPRECATION_WARNINGSduring transitionFor Maintainers
This sets up the foundation for Phases 2-4:
Test Plan
NETWORK_SYSTEM_SUPPRESS_DEPRECATION_WARNINGSRelated Issues
Timeline
Next Steps
After this PR is merged: