Follow-up on "Fix for multibag replay stagnation (#2158)"

- Return player storage options by value in the 'get_storage_options()'
 to avoid returning dangling reference.

Signed-off-by: Michael Orlov <michael.orlov@apex.ai>

Author: MichaelOrlov

rosbag2_transport/include/rosbag2_transport/player.hpp

@@ -380,9 +380,10 @@ class Player : public rclcpp::Node
   size_t get_number_of_registered_on_play_msg_post_callbacks();
 
   /// \brief Getter for the first of the currently stored storage options
-  /// \return Reference to the first item in the StorageOptions vector
+  /// \return Copy of the first item in the StorageOptions vector
+  [[deprecated("Use rosabg2_transport::Player::get_all_storage_options() instead")]]
   ROSBAG2_TRANSPORT_PUBLIC
-  const rosbag2_storage::StorageOptions & get_storage_options();
+  rosbag2_storage::StorageOptions get_storage_options();
 
   /// \brief Getter for the currently stored storage options
   /// \return Copy of the currently stored storage options

rosbag2_transport/src/rosbag2_transport/player.cpp

@@ -242,7 +242,7 @@ class PlayerImpl
 
   /// \brief Getter for the first of the currently stored storage options
   /// \return Copy of the first of the currently stored storage options
-  const rosbag2_storage::StorageOptions & get_storage_options();
+  rosbag2_storage::StorageOptions get_storage_options();
 
   /// \brief Getter for the currently stored storage options
   /// \return Copy of the currently stored storage options
@@ -2179,10 +2179,10 @@ void PlayerImpl::publish_clock_update(const rclcpp::Time & time)
   }
 }
 
-const rosbag2_storage::StorageOptions & PlayerImpl::get_storage_options()
+rosbag2_storage::StorageOptions PlayerImpl::get_storage_options()
 {
   auto all_storage_options = get_all_storage_options();
-  if (all_storage_options.size() < 1) {
+  if (all_storage_options.empty()) {
     throw std::runtime_error("Storage options not available.");
   }
   return all_storage_options[0];
@@ -2448,7 +2448,7 @@ size_t Player::get_number_of_registered_on_play_msg_post_callbacks()
   return pimpl_->get_number_of_registered_on_play_msg_post_callbacks();
 }
 
-const rosbag2_storage::StorageOptions & Player::get_storage_options()
+rosbag2_storage::StorageOptions Player::get_storage_options()
 {
   return pimpl_->get_storage_options();
 }