Skip to content

[phase 2] Update all examples to use new API naming conventions #661

@aregtech

Description

@aregtech

Important

Refactoring changes should be rebased and merged against this branch:
feature/655-api-modernization-and-refactoring

Summary

Update all example projects to use the new naming conventions (namespaces, snake_case methods, simplified prefixes).

Scope

29 example projects under examples/:

# Example Description
01 01_minimalrpc Minimal RPC
02 02_minimalipc Minimal IPC
03 03_helloservice Hello Service tutorial
04 04_hellothread Threading basics
05 05_buffer Buffer operations
06 06_file File operations
07 07_logging Logging framework
08 08_timer Timer usage
09 09_threads Thread management
10 10_sync Synchronization
11 11_service Service basics
12 12_svcmulti Multiple services
13 13_locsvc Local service
14 14_locmesh Local mesh
15 15_pubsvc Public service
16 16_pubmesh Public mesh
17 17_pubtraffic Public traffic
18 18_pubworker Public worker threads
19 19_pubfsm Public FSM
20 20_winchat Windows chat app
21 21_locwatchdog Local watchdog
22 22_pubwatchdog Public watchdog
23 23_pubdatarate Public data rate
24 24_pubunblock Public unblock
25 25_pubsub Pub/Sub basic
26 26_pubsubmix Pub/Sub mixed
27 27_pubsubmulti Pub/Sub multi
28 28_stlsync STL synchronization
29 29_syncevent Sync events

Total: 203 source files, ~38,000 lines

What changes in each example

  • All #include paths updated for renamed headers
  • All method calls converted to snake_case
  • All type names updated (no IE/TE prefixes)
  • All enum references updated (no e prefix)
  • Namespace using declarations added where appropriate
  • Comments updated to reflect new names

Work order

Process in batches of 5-6 examples per PR to keep reviews manageable:

  1. PR: Examples 01-06 (basics)
  2. PR: Examples 07-12 (services)
  3. PR: Examples 13-18 (public services)
  4. PR: Examples 19-24 (advanced)
  5. PR: Examples 25-29 (pub/sub, sync)

Depends on

  • Framework renaming must be complete
  • Code generator must be updated (generated service code in examples)

Acceptance criteria

  • All 29 examples compile
  • All 29 examples run correctly
  • No old naming conventions remain in example code
  • Example comments and inline documentation are updated

Metadata

Metadata

Assignees

No one assigned

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions