Better API alignment with Rust

Author: alan-george-lk

include/livekit/room.h

@@ -204,7 +204,7 @@ class LIVEKIT_API Room {
   ///
   /// @return Future resolving with publisher + subscriber stats on success,
   ///         or a typed error code + message on failure.
-  std::future<Result<SessionStats, GetSessionStatsError>> getSessionStats() const;
+  std::future<Result<SessionStats, GetSessionStatsError>> getStats() const;
 
   /* Register a handler for incoming text streams on a specific topic.
    *

include/livekit/session_stats_error.h

@@ -21,7 +21,7 @@
 
 namespace livekit {
 
-/// Categorical reason code for a failed `Room::getSessionStats()` call.
+/// Categorical reason code for a failed `Room::getStats()` call.
 enum class GetSessionStatsErrorCode : std::uint32_t {
   /// Catch-all: the FFI returned an error message that does not map to a more
   /// specific code.
@@ -37,7 +37,7 @@ enum class GetSessionStatsErrorCode : std::uint32_t {
   INTERNAL = 3,
 };
 
-/// Typed error returned by `Room::getSessionStats()`.
+/// Typed error returned by `Room::getStats()`.
 ///
 /// Surfaces the error reason as a `GetSessionStatsErrorCode` plus an
 /// implementation-defined message for diagnostics/logging.

src/room.cpp

@@ -267,7 +267,7 @@ ConnectionState Room::connectionState() const {
   return connection_state_;
 }
 
-std::future<Result<SessionStats, GetSessionStatsError>> Room::getSessionStats() const {
+std::future<Result<SessionStats, GetSessionStatsError>> Room::getStats() const {
   std::shared_ptr<FfiHandle> handle;
   {
     const std::scoped_lock<std::mutex> g(lock_);

src/tests/integration/test_session_stats.cpp

@@ -171,8 +171,8 @@ TEST_F(SessionStatsIntegrationTest, PublishAudioThenFetchSessionStats) {
 
   std::this_thread::sleep_for(kStatsWarmup);
 
-  auto sender_fut = sender_room->getSessionStats();
-  auto receiver_fut = receiver_room->getSessionStats();
+  auto sender_fut = sender_room->getStats();
+  auto receiver_fut = receiver_room->getStats();
 
   auto sender_result = sender_fut.get();
   auto receiver_result = receiver_fut.get();
@@ -185,10 +185,9 @@ TEST_F(SessionStatsIntegrationTest, PublishAudioThenFetchSessionStats) {
     sender_room->localParticipant()->unpublishTrack(track->publication()->sid());
   }
 
-  ASSERT_TRUE(sender_result.ok()) << "Sender getSessionStats failed: code="
-                                  << static_cast<int>(sender_result.error().code)
+  ASSERT_TRUE(sender_result.ok()) << "Sender getStats failed: code=" << static_cast<int>(sender_result.error().code)
                                   << " msg=" << sender_result.error().message;
-  ASSERT_TRUE(receiver_result.ok()) << "Receiver getSessionStats failed: code="
+  ASSERT_TRUE(receiver_result.ok()) << "Receiver getStats failed: code="
                                     << static_cast<int>(receiver_result.error().code)
                                     << " msg=" << receiver_result.error().message;
 
@@ -201,7 +200,7 @@ TEST_F(SessionStatsIntegrationTest, PublishAudioThenFetchSessionStats) {
 
 TEST_F(SessionStatsIntegrationTest, NotConnectedReturnsNotConnected) {
   Room room;
-  auto fut = room.getSessionStats();
+  auto fut = room.getStats();
   auto result = fut.get();
   EXPECT_FALSE(result.ok());
   EXPECT_EQ(result.error().code, GetSessionStatsErrorCode::NOT_CONNECTED);