e2ap: minor comment adjustments

Author: yagoda

include/srsran/e2/e2sm/e2sm.h

@@ -27,7 +27,6 @@ class e2sm_handler
   virtual asn1::e2sm_kpm::e2_sm_kpm_event_trigger_definition_s
   handle_packed_event_trigger_definition(const srsran::byte_buffer& buf) = 0;
   /// @brief Pack the RAN function description.
-  /// @param buf[in] The buffer to pack the RAN function description into.
   virtual asn1::unbounded_octstring<true> pack_ran_function_description() = 0;
 };
 

include/srsran/e2/subscription/e2_subscription.h

@@ -18,13 +18,14 @@
 
 namespace srsran {
 
+/// This defines the RIC action struct.
 struct ric_action_t {
   srsran::byte_buffer           action_definition;
   uint16_t                      ric_action_id;
   asn1::e2ap::ri_caction_type_e ric_action_type;
 };
 
-// here we define a subscription struct
+/// Here we define a subscription struct.
 struct e2_subscription_info_t {
   asn1::e2ap::ri_crequest_id_s request_id;
   std::vector<ric_action_t>    action_list;
@@ -43,7 +44,7 @@ class e2_subscription_proc
   /// \brief Handle the incoming subscription message.
   virtual e2_subscribe_reponse_message handle_subscription_setup(const asn1::e2ap::ricsubscription_request_s& msg) = 0;
   /// \brief start the subscription request
-  virtual int start_subscription(int ric_instance_id, e2_event_manager& ev_mng, uint16_t ran_func_id) = 0;
+  virtual void start_subscription(int ric_instance_id, e2_event_manager& ev_mng, uint16_t ran_func_id) = 0;
 };
 
 class e2_subscriber_mgmt

lib/e2/common/e2_subscription_manager_impl.cpp

@@ -59,17 +59,16 @@ e2_subscription_manager_impl::handle_subscription_setup(const asn1::e2ap::ricsub
   return outcome;
 }
 
-int e2_subscription_manager_impl::start_subscription(int               ric_instance_id,
-                                                     e2_event_manager& ev_mng,
-                                                     uint16_t          ran_func_id)
+void e2_subscription_manager_impl::start_subscription(int               ric_instance_id,
+                                                      e2_event_manager& ev_mng,
+                                                      uint16_t          ran_func_id)
 {
   subscriptions[ric_instance_id].indication_task =
       launch_async<e2_indication_procedure>(notif,
                                             *(e2sm_iface_list[supported_ran_functions[ran_func_id]]),
                                             ev_mng,
                                             subscriptions[ric_instance_id].subscription_info,
                                             logger);
-  return 0;
 }
 
 bool e2_subscription_manager_impl::action_supported(const ri_caction_to_be_setup_item_s& action,

lib/e2/common/e2_subscription_manager_impl.h

@@ -32,8 +32,7 @@ class e2_subscription_manager_impl : public e2_subscription_manager
   /// \brief  Starts the subscription procedure associated with the given ric instance id.
   /// \param[in] ric_instance_id  The ric instance id.
   /// \param[in] ev_mng The event manager that will be used to end the subscription procedure.
-  /// \return true if the subscription procedure was started successfully, false otherwise.
-  int start_subscription(int ric_instance_id, e2_event_manager& ev_mng, uint16_t ran_func_id) override;
+  void start_subscription(int ric_instance_id, e2_event_manager& ev_mng, uint16_t ran_func_id) override;
 
   /// \brief checks whether the given action is supported.
   /// \param[in] action The action to check.

lib/e2/procedures/e2_subscription_setup_procedure.h

@@ -36,10 +36,10 @@ class e2_subscription_setup_procedure
   void send_e2_subscription_setup_response(const e2_subscribe_reponse_message& response);
   void send_e2_subscription_setup_failure(const e2_subscribe_reponse_message& failure);
 
-  srslog::basic_logger&    logger;
-  e2_message_notifier&     ric_notif;
-  e2_subscription_proc&    subscription_mngr;
-  timer_factory            timers;
+  srslog::basic_logger& logger;
+  e2_message_notifier&  ric_notif;
+  e2_subscription_proc& subscription_mngr;
+  timer_factory         timers;
 };
 
 } // namespace srsran

tests/unittests/e2/common/e2_test_helpers.h

@@ -123,7 +123,7 @@ class dummy_e2_subscription_mngr : public e2_subscription_manager
     get_subscription_result(msg);
     return msg;
   }
-  int start_subscription(int ric_instance_id, e2_event_manager& ev_mng, uint16_t ran_func_id) override { return 0; }
+  void start_subscription(int ric_instance_id, e2_event_manager& ev_mng, uint16_t ran_func_id) override {}
 
   void add_e2sm_service(std::string oid, std::unique_ptr<e2sm_interface> e2sm_iface) override {}