Prefix token_source example files; pin SDK commit

alan-george-lk · cursoragent · alan-george-lk · commit 6876b08fc39a · 2026-06-25T15:14:14.000-06:00
Rename the per-type token source examples and shared helper to a
token_source_ prefix so source filenames match their executable target
names, and update the CMake source list, includes, and README references.

Pin the README build instructions to client-sdk-cpp commit bbf6a41 and
update the caching example comment to reference invalidate() now that
force_refresh was dropped from the SDK API.

Co-authored-by: Cursor &lt;cursoragent@cursor.com&gt;
diff --git a/token_source/CMakeLists.txt b/token_source/CMakeLists.txt
@@ -12,19 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# One executable per token source type. Each shares common.h for the logging
-# delegate and the connect/observe session loop.
+# One executable per token source type. Each shares token_source_common.h for
+# the logging delegate and the connect/observe session loop.
 
 # Resolve the SDK lib directory so -llivekit_ffi is found at link time.
 get_filename_component(_lk_cmake_dir "${LiveKit_DIR}" DIRECTORY)  # .../lib/cmake
 get_filename_component(_lk_lib_dir  "${_lk_cmake_dir}" DIRECTORY) # .../lib
 
 set(_token_source_examples
-  token_source_literal   literal.cpp
-  token_source_endpoint  endpoint.cpp
-  token_source_sandbox   sandbox.cpp
-  token_source_custom    custom.cpp
-  token_source_caching   caching.cpp
+  token_source_literal   token_source_literal.cpp
+  token_source_endpoint  token_source_endpoint.cpp
+  token_source_sandbox   token_source_sandbox.cpp
+  token_source_custom    token_source_custom.cpp
+  token_source_caching   token_source_caching.cpp
 )
 
 list(LENGTH _token_source_examples _count)
diff --git a/token_source/README.md b/token_source/README.md
@@ -16,11 +16,11 @@ disconnects.
 
 | Example | Type | When to use |
 |---|---|---|
-| `literal.cpp` | `LiteralTokenSource` | You already have a URL + JWT (minted out of band, e.g. `lk token create`). The SDK consumes them as-is. |
-| `endpoint.cpp` | `EndpointTokenSource` | Recommended for production. The SDK POSTs request options to your backend token endpoint, which returns the URL + a fresh JWT. API keys stay server-side. |
-| `sandbox.cpp` | `SandboxTokenSource` | Local development only. Uses LiveKit Cloud's sandbox token server. Not for production. |
-| `custom.cpp` | `CustomTokenSource` | You have an internal auth/token system. Plug in your own async callback that returns credentials. |
-| `caching.cpp` | `CachingTokenSource` | A decorator that adds JWT-aware caching around any configurable source (endpoint/sandbox/custom) to cut down on fetch calls. |
+| `token_source_literal.cpp` | `LiteralTokenSource` | You already have a URL + JWT (minted out of band, e.g. `lk token create`). The SDK consumes them as-is. |
+| `token_source_endpoint.cpp` | `EndpointTokenSource` | Recommended for production. The SDK POSTs request options to your backend token endpoint, which returns the URL + a fresh JWT. API keys stay server-side. |
+| `token_source_sandbox.cpp` | `SandboxTokenSource` | Local development only. Uses LiveKit Cloud's sandbox token server. Not for production. |
+| `token_source_custom.cpp` | `CustomTokenSource` | You have an internal auth/token system. Plug in your own async callback that returns credentials. |
+| `token_source_caching.cpp` | `CachingTokenSource` | A decorator that adds JWT-aware caching around any configurable source (endpoint/sandbox/custom) to cut down on fetch calls. |
 
 `LiteralTokenSource` is *fixed* (no per-call options); the others are
 *configurable* and accept
@@ -48,13 +48,16 @@ committed to source.
 The token source API is newer than the latest published SDK release, so build
 these examples against a **local SDK build** of the
 [`feature/token_source_api`](https://github.com/livekit/client-sdk-cpp/tree/feature/token_source_api)
-branch rather than a downloaded release.
+branch rather than a downloaded release. The commands below pin the branch to
+commit [`bbf6a41`](https://github.com/livekit/client-sdk-cpp/commit/bbf6a41fae42607ee19ff44ccddac786767b34e3)
+so the examples build against a known-good API; drop the `git checkout` of the
+hash to track the branch tip instead.
 
 ```bash
 # 1. Build and install the SDK from the feature branch.
 git clone https://github.com/livekit/client-sdk-cpp.git
 cd client-sdk-cpp
-git checkout feature/token_source_api
+git checkout bbf6a41fae42607ee19ff44ccddac786767b34e3
 git submodule update --init --recursive
 ./build.sh release --bundle --prefix "$HOME/livekit-sdk-install"
 
diff --git a/token_source/token_source_caching.cpp b/token_source/token_source_caching.cpp
@@ -18,8 +18,8 @@
 // configurable token source (endpoint, sandbox, or custom).
 //
 // Repeated fetches for the same request options reuse the cached token until it
-// nears expiry or a force-refresh is requested, cutting down calls to your
-// backend. This example wraps an EndpointTokenSource.
+// nears expiry or you call invalidate() to drop the cached credentials, cutting
+// down calls to your backend. This example wraps an EndpointTokenSource.
 //
 // Environment:
 //   LIVEKIT_TOKEN_ENDPOINT          Token endpoint URL
@@ -34,7 +34,7 @@
 #include <string>
 #include <utility>
 
-#include "common.h"
+#include "token_source_common.h"
 
 namespace {
 
diff --git a/token_source/token_source_common.h b/token_source/token_source_common.h
diff --git a/token_source/token_source_custom.cpp b/token_source/token_source_custom.cpp
@@ -36,7 +36,7 @@
 #include <iostream>
 #include <string>
 
-#include "common.h"
+#include "token_source_common.h"
 
 namespace {
 
diff --git a/token_source/token_source_endpoint.cpp b/token_source/token_source_endpoint.cpp
@@ -34,7 +34,7 @@
 #include <string>
 #include <utility>
 
-#include "common.h"
+#include "token_source_common.h"
 
 namespace {
 
diff --git a/token_source/token_source_literal.cpp b/token_source/token_source_literal.cpp
@@ -30,7 +30,7 @@
 #include <iostream>
 #include <string>
 
-#include "common.h"
+#include "token_source_common.h"
 
 namespace {
 
diff --git a/token_source/token_source_sandbox.cpp b/token_source/token_source_sandbox.cpp
@@ -31,7 +31,7 @@
 #include <iostream>
 #include <string>
 
-#include "common.h"
+#include "token_source_common.h"
 
 namespace {
 
