diff --git a/libs/server-sdk-redis-source/docs/doc.md b/libs/server-sdk-redis-source/docs/doc.md new file mode 100644 index 000000000..5a8f3b11f --- /dev/null +++ b/libs/server-sdk-redis-source/docs/doc.md @@ -0,0 +1,6 @@ +# Overview + +The Server-side SDK Redis Source can be used as a source of SDK data +instead of the normal LaunchDarkly Streaming or Polling data sources. + +To create a Redis Source, see [RedisDataSource](@ref launchdarkly::server_side::integrations::RedisDataSource). diff --git a/libs/server-sdk-redis-source/docs/html/annotated.html b/libs/server-sdk-redis-source/docs/html/annotated.html new file mode 100644 index 000000000..a08fd332d --- /dev/null +++ b/libs/server-sdk-redis-source/docs/html/annotated.html @@ -0,0 +1,84 @@ + + +
+ + + + +
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
▼Nlaunchdarkly | |
▼Nserver_side | |
▼Nintegrations | |
CRedisDataSource | RedisDataSource represents a data source for the Server-Side SDK backed by Redis. It is meant to be used in place of the standard LaunchDarkly Streaming or Polling data sources |
CLDServerLazyLoadRedisResult | Stores the result of calling LDDServerLazyLoadRedisSource_New |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
This is the complete list of members for launchdarkly::server_side::integrations::RedisDataSource, including all inherited members.
+All(ISerializedItemKind const &kind) const override (defined in launchdarkly::server_side::integrations::RedisDataSource) | launchdarkly::server_side::integrations::RedisDataSource | |
Create(std::string uri, std::string prefix) | launchdarkly::server_side::integrations::RedisDataSource | static |
Get(ISerializedItemKind const &kind, std::string const &itemKey) const override (defined in launchdarkly::server_side::integrations::RedisDataSource) | launchdarkly::server_side::integrations::RedisDataSource | |
Identity() const override (defined in launchdarkly::server_side::integrations::RedisDataSource) | launchdarkly::server_side::integrations::RedisDataSource | |
Initialized() const override (defined in launchdarkly::server_side::integrations::RedisDataSource) | launchdarkly::server_side::integrations::RedisDataSource | |
~RedisDataSource() override (defined in launchdarkly::server_side::integrations::RedisDataSource) | launchdarkly::server_side::integrations::RedisDataSource |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
RedisDataSource represents a data source for the Server-Side SDK backed by Redis. It is meant to be used in place of the standard LaunchDarkly Streaming or Polling data sources. + More...
+ +#include <redis_source.hpp>
+Static Public Member Functions | |
static tl::expected< std::unique_ptr< RedisDataSource >, std::string > | Create (std::string uri, std::string prefix) |
Creates a new RedisDataSource, or returns an error if construction failed. More... | |
RedisDataSource represents a data source for the Server-Side SDK backed by Redis. It is meant to be used in place of the standard LaunchDarkly Streaming or Polling data sources.
+Call RedisDataSource::Create to obtain a new instance. This instance can be passed into the SDK's DataSystem configuration via the LazyLoad builder.
+This implementation is backed by Redis++, a C++ wrapper for the hiredis library.
+
+
|
+ +static | +
Creates a new RedisDataSource, or returns an error if construction failed.
+uri | Redis URI. The URI is passed to the underlying Redis++ client verbatim. See Redis++ API Reference for details on the possible URI formats. |
prefix | Prefix to use when reading SDK data from Redis. This allows multiple LaunchDarkly environments to be stored in the same database (under different prefixes.) |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
File in src/bindings | Includes file in include |
---|---|
redis / redis_source.cpp | launchdarkly / server_side / bindings / c / integrations / redis / redis_source.h |
redis / redis_source.cpp | launchdarkly / server_side / integrations / redis / redis_source.hpp |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
File in src/bindings/redis | Includes file in include |
---|---|
redis_source.cpp | launchdarkly / server_side / bindings / c / integrations / redis / redis_source.h |
redis_source.cpp | launchdarkly / server_side / integrations / redis / redis_source.hpp |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+Files | |
file | redis_source.h [code] |
LaunchDarkly Server-side Redis Source C Binding. | |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+Files | |
file | redis_source.hpp [code] |
Server-Side Redis Source. | |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
▼ include | |
▼ launchdarkly | |
▼ server_side | |
▼ bindings | |
▼ c | |
▼ integrations | |
▼ redis | |
redis_source.h | LaunchDarkly Server-side Redis Source C Binding |
▼ integrations | |
▼ redis | |
redis_source.hpp | Server-Side Redis Source |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
This page explains how to interpret the graphs that are generated by doxygen.
+Consider the following example:
This will result in the following graph:
+The boxes in the above graph have the following meaning:
+The arrows have the following meaning:
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
▼CISerializedDataReader | |
Claunchdarkly::server_side::integrations::RedisDataSource | RedisDataSource represents a data source for the Server-Side SDK backed by Redis. It is meant to be used in place of the standard LaunchDarkly Streaming or Polling data sources |
CLDServerLazyLoadRedisResult | Stores the result of calling LDDServerLazyLoadRedisSource_New |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
The Server-side SDK Redis Source can be used as a source of SDK data instead of the normal LaunchDarkly Streaming or Polling data sources.
+To create a Redis Source, see RedisDataSource.
+
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
+ + |
+ + |
+ C++ Server-Side SDK Redis Source
+
+ Provide SDK data via Redis
+ |
+
LaunchDarkly Server-side Redis Source C Binding. +More...
+#include <launchdarkly/bindings/c/export.h>
Go to the source code of this file.
++Classes | |
struct | LDServerLazyLoadRedisResult |
Stores the result of calling LDDServerLazyLoadRedisSource_New. More... | |
+Macros | |
+#define | LDSERVER_LAZYLOAD_REDISSOURCE_ERROR_MESSAGE_SIZE 256 |
+Typedefs | |
+typedef struct _LDServerLazyLoadRedisSource * | LDServerLazyLoadRedisSource |
+Functions | |
LDServerLazyLoadRedisSource_New (char const *uri, char const *prefix, struct LDServerLazyLoadRedisResult *out_result) | |
Creates a new Redis data source suitable for usage in the SDK's Lazy Load data system. More... | |
+ | LDServerLazyLoadRedisSource_Free (LDServerLazyLoadRedisSource source) |
Frees a Redis data source pointer. Only necessary to call if not passing ownership to SDK configuration. | |
LaunchDarkly Server-side Redis Source C Binding.
+LDServerLazyLoadRedisSource_New | +( | +char const * | +uri, | +
+ | + | char const * | +prefix, | +
+ | + | struct LDServerLazyLoadRedisResult * | +out_result | +
+ | ) | ++ |
Creates a new Redis data source suitable for usage in the SDK's Lazy Load data system.
+In this system, the SDK will query Redis for flag/segment data as required, with an in-memory cache to reduce the number of queries.
+Data is never written back to Redis.
+uri | Redis URI string. Must not be NULL or empty string. |
prefix | Prefix to use when reading SDK data from Redis. This allows multiple SDK environments to coexist in the same database, or for the SDK's data to coexist with other unrelated data. Must not be NULL. |
out_result | Pointer to struct where the source pointer or an error message should be stored. |