RPC features

Author: xianshijing-lk

CMakeLists.txt

@@ -169,6 +169,7 @@ add_library(livekit
   include/livekit/local_participant.h
   include/livekit/remote_participant.h
   include/livekit/livekit.h
+  include/livekit/rpc_error.h
   include/livekit/stats.h
   include/livekit/track.h
   include/livekit/track_publication.h
@@ -198,6 +199,7 @@ add_library(livekit
   src/track_publication.cpp
   src/local_track_publication.cpp
   src/remote_track_publication.cpp
+  src/rpc_error.cpp
   src/video_frame.cpp
   src/video_source.cpp
   src/video_stream.cpp

README.md

@@ -41,8 +41,16 @@ All build actions are managed by the provided build.sh script.
 
 ## 🧪 Run Example
 
+### Generate Tokens
+Before running any participant, create JWT tokens with the proper identity and room name, example
 ```bash
-./build/examples/SimpleRoom --url ws://localhost:7880 --token <jwt-token>
+lk token create -r test -i your_own_identity  --join --valid-for 99999h --dev --room=your_own_room
+```
+
+### SimpleRoom
+
+```bash
+./build/examples/SimpleRoom --url $URL --token <jwt-token>
 ```
 
 You can also provide the URL and token via environment variables:
@@ -54,6 +62,33 @@ export LIVEKIT_TOKEN=<jwt-token>
 
 Press Ctrl-C to exit the example.
 
+### SimpleRpc
+The SimpleRpc example demonstrates how to:
+- Connect multiple participants to the same LiveKit room
+- Register RPC handlers (e.g., arrival, square-root, divide, long-calculation)
+- Send RPC requests from one participant to another
+- Handle success, application errors, unsupported methods, and timeouts
+- Observe round-trip times (RTT) for each RPC call
+
+#### 🔑 Generate Tokens
+Before running any participant, create JWT tokens with "caller", "greeter" and "math-genius" identities and room name.
+```bash
+lk token create -r test -i caller --join --valid-for 99999h --dev --room=your_own_room
+lk token create -r test -i greeter --join --valid-for 99999h --dev --room=your_own_room
+lk token create -r test -i math-genius --join --valid-for 99999h --dev --room=your_own_room
+```
+
+#### ▶ Start Participants
+Every participant is run as a separate terminal process, note --role needs to match the token identity.
+```bash
+./build/examples/SimpleRpc --url $URL --token <jwt-token> --role=math-genius
+```
+The caller will automatically:
+- Wait for the greeter and math-genius to join
+- Perform RPC calls
+- Print round-trip times
+- Annotate expected successes or expected failures
+
 ##  🧰 Recommended Setup
 ### macOS
 ```bash

examples/CMakeLists.txt

@@ -4,6 +4,8 @@ project (livekit-examples)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+#################### SimpleRoom example ##########################
+
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 include(sdl3)
 
@@ -32,3 +34,22 @@ add_custom_command(TARGET SimpleRoom POST_BUILD
             ${CMAKE_SOURCE_DIR}/data
             ${CMAKE_CURRENT_BINARY_DIR}/data
 )
+
+#################### SimpleRpc example ##########################
+
+include(FetchContent)
+FetchContent_Declare(
+  nlohmann_json
+  URL https://github.com/nlohmann/json/releases/download/v3.11.3/json.tar.xz
+)
+FetchContent_MakeAvailable(nlohmann_json)
+
+add_executable(SimpleRpc
+  simple_rpc/main.cpp
+)
+
+target_link_libraries(SimpleRpc
+  PRIVATE
+    nlohmann_json::nlohmann_json
+    livekit
+)

examples/simple_room/main.cpp

@@ -42,7 +42,7 @@ namespace {
 
 std::atomic<bool> g_running{true};
 
-void print_usage(const char *prog) {
+void printUsage(const char *prog) {
   std::cerr << "Usage:\n"
             << "  " << prog << " <ws-url> <token>\n"
             << "or:\n"
@@ -52,9 +52,9 @@ void print_usage(const char *prog) {
             << "  LIVEKIT_URL, LIVEKIT_TOKEN\n";
 }
 
-void handle_sigint(int) { g_running.store(false); }
+void handleSignal(int) { g_running.store(false); }
 
-bool parse_args(int argc, char *argv[], std::string &url, std::string &token) {
+bool parseArgs(int argc, char *argv[], std::string &url, std::string &token) {
   // 1) --help
   for (int i = 1; i < argc; ++i) {
     std::string a = argv[i];
@@ -215,8 +215,8 @@ class SimpleRoomDelegate : public livekit::RoomDelegate {
 
 int main(int argc, char *argv[]) {
   std::string url, token;
-  if (!parse_args(argc, argv, url, token)) {
-    print_usage(argv[0]);
+  if (!parseArgs(argc, argv, url, token)) {
+    printUsage(argv[0]);
     return 1;
   }
 
@@ -238,7 +238,7 @@ int main(int argc, char *argv[]) {
   std::cout << "Connecting to: " << url << std::endl;
 
   // Handle Ctrl-C to exit the idle loop
-  std::signal(SIGINT, handle_sigint);
+  std::signal(SIGINT, handleSignal);
 
   livekit::Room room{};
   SimpleRoomDelegate delegate(media);