[DISPATCH-836] Source file organization suffers from include hell

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Incomplete
• Affects Version/s: 0.8.0
• Fix Version/s: 1.19.0
• Component/s: Container, Router Node, Routing Engine
• Assignee: Jiri Daněk
• Reporter: Charles E. Rolke
• Created: 22/Sep/17 15:49
• Updated: 22/Mar/22 19:12
• Resolved: 31/Jan/22 11:15

Description

Adding an innocent looking #include to some module may unleash a barrage of errors instead of simply defining the header's interface. Reordering and/or adding more #include statements is required to get it right.

A good way to address this is to make certain that each module.h file compiles cleanly on its own. It is tedious and pretty unrewarding to check each file. One strategy to address this problem is for each module to #include module.h as the first include[1]. Then every compile checks that the module.h files compiles cleanly. This strategy is recommended by astitcher and used by qpid-cpp with great results.

[1] One exception to this rule is including the #include Python.h ahead of all others. This is a requirement.

Issue Links

• Testing discovered: DISPATCH-2285 Hide the API defined in address_lookup_utils.c by moving that file into router_core/modules/address_lookup_server directory