Clean up

Author: TimofteBogdan1900

src/someipd/BUILD.bazel

@@ -28,17 +28,13 @@ exports_files(
     visibility = ["//visibility:public"],
 )
 
-# ============================================================================
+
 # Core Types (stack-independent SOME/IP types and constants)
-# ============================================================================
 cc_library(
     name = "someipd_types",
     hdrs = ["someipd_types.h"],
 )
 
-# ============================================================================
-# Abstract Interfaces (Bridge pattern implementor interfaces)
-# ============================================================================
 cc_library(
     name = "i_network_stack",
     hdrs = ["i_network_stack.h"],
@@ -50,9 +46,6 @@ cc_library(
     hdrs = ["i_internal_ipc.h"],
 )
 
-# ============================================================================
-# Config Reader (stack-independent)
-# ============================================================================
 cc_library(
     name = "someipd_config",
     srcs = ["someipd_config_reader.cpp"],
@@ -63,9 +56,6 @@ cc_library(
     ],
 )
 
-# ============================================================================
-# Gateway Routing (Bridge pattern abstraction — core routing logic)
-# ============================================================================
 cc_library(
     name = "gateway_routing",
     srcs = ["gateway_routing.cpp"],
@@ -78,9 +68,7 @@ cc_library(
     ],
 )
 
-# ============================================================================
-# vsomeip Adapter (Adapter pattern — SOME/IP network stack)
-# ============================================================================
+
 cc_library(
     name = "vsomeip_adapter",
     srcs = ["vsomeip_adapter.cpp"],
@@ -91,9 +79,7 @@ cc_library(
     ],
 )
 
-# ============================================================================
-# mw::com Adapter (Adapter pattern — internal IPC framework)
-# ============================================================================
+
 cc_library(
     name = "mwcom_adapter",
     srcs = ["mwcom_adapter.cpp"],
@@ -106,9 +92,6 @@ cc_library(
     ],
 )
 
-# ============================================================================
-# Main Binary
-# ============================================================================
 cc_binary(
     name = "someipd",
     srcs = ["main.cpp"],

src/someipd/gateway_routing.cpp

@@ -85,7 +85,7 @@ InstanceId GatewayRouting::LookupInstanceId(ServiceId service_id) const {
     }
     return kAnyInstance;
 }
-
+// exchange event data
 void GatewayRouting::ProcessMessages(std::atomic<bool>& shutdown_requested) {
     static constexpr std::size_t kMaxSampleCount = 10;
 
@@ -131,8 +131,8 @@ void GatewayRouting::ProcessMessages(std::atomic<bool>& shutdown_requested) {
 
 void GatewayRouting::Run(std::atomic<bool>& shutdown_requested) {
     network_stack_->StartProcessing();
-    SetupSubscriptions();
-    SetupOfferings();
+    SetupSubscriptions(); // once per service, not per message
+    SetupOfferings();     // once per service, not per message
     ProcessMessages(shutdown_requested);
     network_stack_->StopProcessing();
 }

src/someipd/gateway_routing.h

@@ -25,16 +25,18 @@ namespace score::someip_gateway::someipd {
 /// Bridge abstraction that decouples the routing logic from both the SOME/IP
 /// network stack and the internal IPC framework.
 ///
-/// GatewayRouting holds references to two abstract interfaces — INetworkStack
-/// and IInternalIpc — and delegates all stack-specific and IPC-specific work to
-/// them.  The two implementation dimensions (network stack and IPC framework)
-/// can be varied independently by injecting different adapters.
+/// Abstraction:GatewayRouting
+/// Implementor: IInternalIpc and INetworkStack (Abstract interfaces)
+/// Concrete Implementor (A/B): MwcomAdapter and VsomeipAdapter.
+/// Delegation: network_stack_->RequestService(...) or internal_ipc_->SendToGatewayd(...), ... etc
+/// Client: main.cpp instantiates GatewayRouting() and calls Run()
+
 class GatewayRouting {
    public:
     GatewayRouting(std::unique_ptr<INetworkStack> network_stack,
                    std::unique_ptr<IInternalIpc> internal_ipc, SomeipDConfig config);
 
-    /// Run the routing loop. Blocks until @p shutdown_requested becomes true.
+    /// Run the routing loop. Blocks until shutdown_requested becomes true.
     void Run(std::atomic<bool>& shutdown_requested);
 
    private:
@@ -45,8 +47,6 @@ class GatewayRouting {
 
     SomeipDConfig config_;
     std::unique_ptr<IInternalIpc> internal_ipc_;
-    // Declared last so it is destroyed first — ensures the network stack is
-    // stopped before IPC resources are torn down.
     std::unique_ptr<INetworkStack> network_stack_;
 };
 

src/someipd/i_internal_ipc.h

@@ -27,7 +27,7 @@ class IInternalIpc {
     virtual ~IInternalIpc() = default;
 
     /// Initialize the IPC runtime, discover services, and establish connections.
-    virtual bool Init(int argc, const char* argv[]) = 0;
+    virtual void Init(int argc, const char* argv[]) = 0;
 
     /// Send a raw SOME/IP message to gatewayd (inbound path: network → someipd → gatewayd).
     virtual bool SendToGatewayd(const std::byte* data, std::size_t size) = 0;

src/someipd/main.cpp

@@ -86,10 +86,7 @@ int main(int argc, const char* argv[]) {
 
     auto internal_ipc =
         std::make_unique<MwcomAdapter>("someipd/gatewayd_messages", "someipd/someipd_messages", 10);
-    if (!internal_ipc->Init(argc, argv)) {
-        score::mw::log::LogError() << "IPC initialization failed";
-        return EXIT_FAILURE;
-    }
+    internal_ipc->Init(argc, argv);
 
     GatewayRouting routing(std::move(network_stack), std::move(internal_ipc), std::move(config));
     routing.Run(shutdown_requested);

src/someipd/mwcom_adapter.cpp

@@ -28,7 +28,7 @@ MwcomAdapter::MwcomAdapter(std::string proxy_instance_specifier,
       skeleton_instance_specifier_(std::move(skeleton_instance_specifier)),
       max_sample_count_(max_sample_count) {}
 
-bool MwcomAdapter::Init(int argc, const char* argv[]) {
+void MwcomAdapter::Init(int argc, const char* argv[]) {
     score::mw::com::runtime::InitializeRuntime(argc, argv);
 
     auto handles = Proxy::FindService(
@@ -41,8 +41,6 @@ bool MwcomAdapter::Init(int argc, const char* argv[]) {
         score::mw::com::InstanceSpecifier::Create(skeleton_instance_specifier_).value());
     skeleton_.emplace(std::move(create_result).value());
     (void)skeleton_->OfferService();
-
-    return true;
 }
 
 bool MwcomAdapter::SendToGatewayd(const std::byte* data, std::size_t size) {

src/someipd/mwcom_adapter.h

@@ -27,12 +27,18 @@ namespace score::someip_gateway::someipd {
 ///
 /// All mw::com-specific headers and API calls are isolated here.
 /// To switch to a different IPC framework, provide another IInternalIpc adapter.
+///
+///
+/// Target (IInternalIpc)
+/// Adapter (MwcomAdapter)
+/// Adaptee (SomeipMessageTransferProxy & SomeipMessageTransferSkeleton)
+/// Client main.cpp
 class MwcomAdapter : public IInternalIpc {
    public:
     MwcomAdapter(std::string proxy_instance_specifier, std::string skeleton_instance_specifier,
                  std::size_t max_sample_count);
 
-    bool Init(int argc, const char* argv[]) override;
+    void Init(int argc, const char* argv[]) override;
     bool SendToGatewayd(const std::byte* data, std::size_t size) override;
     void ReceiveFromGatewayd(MessageCallback callback, std::size_t max_count) override;
 

src/someipd/someipd_config.h

@@ -31,7 +31,6 @@ struct ServiceEventConfig {
 struct ServiceConfig {
     ServiceId service_id;
     InstanceId instance_id;
-    /// UDP port for unreliable (UDP) transport. 0 means no external transport configured.
     std::uint16_t unreliable_port{0};
     std::vector<ServiceEventConfig> events;
 };
@@ -44,9 +43,6 @@ struct SomeipDConfig {
     std::vector<ServiceConfig> subscribed_services;
 };
 
-/// @brief Parse the someipd service configuration from a JSON file.
-/// @param config_path Absolute or relative path to the someipd config JSON file.
-/// @throws std::runtime_error if the file cannot be opened or parsed.
 SomeipDConfig ReadSomeipDConfig(const std::string& config_path);
 
 }  // namespace score::someip_gateway::someipd

src/someipd/someipd_types.h

@@ -18,13 +18,13 @@
 
 namespace score::someip_gateway::someipd {
 
-/// Stack-independent SOME/IP type aliases.
+/// Hopefully ;) Stack-independent SOME/IP type aliases.
 using ServiceId = std::uint16_t;
 using InstanceId = std::uint16_t;
 using EventId = std::uint16_t;
 using EventGroupId = std::uint16_t;
 
-/// SOME/IP protocol constants (per SOME/IP specification, stack-independent).
+/// Hopefully ;) SOME/IP protocol constants (per SOME/IP specification, stack-independent).
 constexpr std::size_t kSomeipFullHeaderSize = 16;
 constexpr std::size_t kMaxMessageSize = 1500;
 constexpr InstanceId kAnyInstance = 0xFFFF;

src/someipd/vsomeip_adapter.h

@@ -26,6 +26,12 @@ namespace score::someip_gateway::someipd {
 ///
 /// All vsomeip-specific headers and API calls are isolated here.
 /// To switch to a different SOME/IP stack, provide another INetworkStack adapter.
+///
+/// Target (INetworkStack)
+/// Adapter (VsomeipAdapter)
+/// Adaptee (vsomeip::application & vsomeip::payload)
+/// Client main.cpp , it instantiate the adapter
+
 class VsomeipAdapter : public INetworkStack {
    public:
     explicit VsomeipAdapter(std::string app_name);