sdk.h

Go to the documentation of this file.

 
// NOLINTBEGIN modernize-use-using
#pragma once
 
#include <launchdarkly/server_side/bindings/c/all_flags_state/all_flags_state.h>
#include <launchdarkly/server_side/bindings/c/config/builder.h>
#include <launchdarkly/server_side/bindings/c/hook_context.h>
 
#include <launchdarkly/bindings/c/context.h>
#include <launchdarkly/bindings/c/data/evaluation_detail.h>
#include <launchdarkly/bindings/c/data_source/error_info.h>
#include <launchdarkly/bindings/c/export.h>
#include <launchdarkly/bindings/c/listener_connection.h>
#include <launchdarkly/bindings/c/memory_routines.h>
#include <launchdarkly/bindings/c/shared_function_argument_macro_definitions.h>
#include <launchdarkly/bindings/c/status.h>
#include <launchdarkly/bindings/c/value.h>
 
#include <stddef.h>
#include <stdint.h>
#include <time.h>
 
#ifdef __cplusplus
extern "C" {  // only need to export C interface if
// used by C++ source code
#endif
 
typedef struct _LDServerSDK* LDServerSDK;
 
LD_EXPORT(LDServerSDK)
LDServerSDK_New(LDServerConfig config);
 
LD_EXPORT(char const*)
LDServerSDK_Version(void);
 
LD_EXPORT(bool)
LDServerSDK_Start(LDServerSDK sdk,
                  unsigned int milliseconds,
                  bool* out_succeeded);
 
LD_EXPORT(bool)
LDServerSDK_Initialized(LDServerSDK sdk);
 
LD_EXPORT(void)
LDServerSDK_TrackEvent(LDServerSDK sdk,
                       LDContext context,
                       char const* event_name);
 
LD_EXPORT(void)
LDServerSDK_TrackMetric(LDServerSDK sdk,
                        LDContext context,
                        char const* event_name,
                        double metric_value,
                        LDValue data);
 
LD_EXPORT(void)
LDServerSDK_TrackData(LDServerSDK sdk,
                      LDContext context,
                      char const* event_name,
                      LDValue data);
 
LD_EXPORT(void)
LDServerSDK_Flush(LDServerSDK sdk, unsigned int reserved);
 
LD_EXPORT(void)
LDServerSDK_Identify(LDServerSDK sdk, LDContext context);
 
LD_EXPORT(bool)
LDServerSDK_BoolVariation(LDServerSDK sdk,
                          LDContext context,
                          char const* flag_key,
                          bool default_value);
 
LD_EXPORT(bool)
LDServerSDK_BoolVariationDetail(LDServerSDK sdk,
                                LDContext context,
                                char const* flag_key,
                                bool default_value,
                                LDEvalDetail* out_detail);
 
LD_EXPORT(char*)
LDServerSDK_StringVariation(LDServerSDK sdk,
                            LDContext context,
                            char const* flag_key,
                            char const* default_value);
 
LD_EXPORT(char*)
LDServerSDK_StringVariationDetail(LDServerSDK sdk,
                                  LDContext context,
                                  char const* flag_key,
                                  char const* default_value,
                                  LDEvalDetail* out_detail);
 
LD_EXPORT(int)
LDServerSDK_IntVariation(LDServerSDK sdk,
                         LDContext context,
                         char const* flag_key,
                         int default_value);
 
LD_EXPORT(int)
LDServerSDK_IntVariationDetail(LDServerSDK sdk,
                               LDContext context,
                               char const* flag_key,
                               int default_value,
                               LDEvalDetail* out_detail);
 
LD_EXPORT(double)
LDServerSDK_DoubleVariation(LDServerSDK sdk,
                            LDContext context,
                            char const* flag_key,
                            double default_value);
 
LD_EXPORT(double)
LDServerSDK_DoubleVariationDetail(LDServerSDK sdk,
                                  LDContext context,
                                  char const* flag_key,
                                  double default_value,
                                  LDEvalDetail* out_detail);
 
LD_EXPORT(LDValue)
LDServerSDK_JsonVariation(LDServerSDK sdk,
                          LDContext context,
                          char const* flag_key,
                          LDValue default_value);
 
LD_EXPORT(LDValue)
LDServerSDK_JsonVariationDetail(LDServerSDK sdk,
                                LDContext context,
                                char const* flag_key,
                                LDValue default_value,
                                LDEvalDetail* out_detail);
 
LD_EXPORT(void)
LDServerSDK_TrackEvent_WithHookContext(LDServerSDK sdk,
                                       LDContext context,
                                       char const* event_name,
                                       LDHookContext hook_context);
 
LD_EXPORT(void)
LDServerSDK_TrackMetric_WithHookContext(LDServerSDK sdk,
                                        LDContext context,
                                        char const* event_name,
                                        double metric_value,
                                        LDValue data,
                                        LDHookContext hook_context);
 
LD_EXPORT(void)
LDServerSDK_TrackData_WithHookContext(LDServerSDK sdk,
                                      LDContext context,
                                      char const* event_name,
                                      LDValue data,
                                      LDHookContext hook_context);
 
LD_EXPORT(bool)
LDServerSDK_BoolVariation_WithHookContext(LDServerSDK sdk,
                                          LDContext context,
                                          char const* flag_key,
                                          bool default_value,
                                          LDHookContext hook_context);
 
LD_EXPORT(bool)
LDServerSDK_BoolVariationDetail_WithHookContext(LDServerSDK sdk,
                                                LDContext context,
                                                char const* flag_key,
                                                bool default_value,
                                                LDHookContext hook_context,
                                                LDEvalDetail* out_detail);
 
LD_EXPORT(char*)
LDServerSDK_StringVariation_WithHookContext(LDServerSDK sdk,
                                            LDContext context,
                                            char const* flag_key,
                                            char const* default_value,
                                            LDHookContext hook_context);
 
LD_EXPORT(char*)
LDServerSDK_StringVariationDetail_WithHookContext(LDServerSDK sdk,
                                                  LDContext context,
                                                  char const* flag_key,
                                                  char const* default_value,
                                                  LDHookContext hook_context,
                                                  LDEvalDetail* out_detail);
 
LD_EXPORT(int)
LDServerSDK_IntVariation_WithHookContext(LDServerSDK sdk,
                                         LDContext context,
                                         char const* flag_key,
                                         int default_value,
                                         LDHookContext hook_context);
 
LD_EXPORT(int)
LDServerSDK_IntVariationDetail_WithHookContext(LDServerSDK sdk,
                                               LDContext context,
                                               char const* flag_key,
                                               int default_value,
                                               LDHookContext hook_context,
                                               LDEvalDetail* out_detail);
 
LD_EXPORT(double)
LDServerSDK_DoubleVariation_WithHookContext(LDServerSDK sdk,
                                            LDContext context,
                                            char const* flag_key,
                                            double default_value,
                                            LDHookContext hook_context);
 
LD_EXPORT(double)
LDServerSDK_DoubleVariationDetail_WithHookContext(LDServerSDK sdk,
                                                  LDContext context,
                                                  char const* flag_key,
                                                  double default_value,
                                                  LDHookContext hook_context,
                                                  LDEvalDetail* out_detail);
 
LD_EXPORT(LDValue)
LDServerSDK_JsonVariation_WithHookContext(LDServerSDK sdk,
                                          LDContext context,
                                          char const* flag_key,
                                          LDValue default_value,
                                          LDHookContext hook_context);
 
LD_EXPORT(LDValue)
LDServerSDK_JsonVariationDetail_WithHookContext(LDServerSDK sdk,
                                                LDContext context,
                                                char const* flag_key,
                                                LDValue default_value,
                                                LDHookContext hook_context,
                                                LDEvalDetail* out_detail);
 
LD_EXPORT(LDAllFlagsState)
LDServerSDK_AllFlagsState(LDServerSDK sdk,
                          LDContext context,
                          enum LDAllFlagsState_Options options);
 
LD_EXPORT(void)
LDServerSDK_Free(LDServerSDK sdk);
 
typedef struct _LDServerDataSourceStatus* LDServerDataSourceStatus;
 
enum LDServerDataSourceStatus_State {
    LD_SERVERDATASOURCESTATUS_STATE_INITIALIZING = 0,
 
    LD_SERVERDATASOURCESTATUS_STATE_VALID = 1,
 
    LD_SERVERDATASOURCESTATUS_STATE_INTERRUPTED = 2,
 
    LD_SERVERDATASOURCESTATUS_STATE_OFF = 3
};
 
LD_EXPORT(enum LDServerDataSourceStatus_State)
LDServerDataSourceStatus_GetState(LDServerDataSourceStatus status);
 
LD_EXPORT(LDDataSourceStatus_ErrorInfo)
LDServerDataSourceStatus_GetLastError(LDServerDataSourceStatus status);
 
LD_EXPORT(time_t)
LDServerDataSourceStatus_StateSince(LDServerDataSourceStatus status);
 
typedef void (*ServerDataSourceStatusCallbackFn)(
    LDServerDataSourceStatus status,
    void* user_data);
 
struct LDServerDataSourceStatusListener {
    ServerDataSourceStatusCallbackFn StatusChanged;
 
    void* UserData;
};
 
LD_EXPORT(void)
LDServerDataSourceStatusListener_Init(
    struct LDServerDataSourceStatusListener* listener);
 
LD_EXPORT(LDListenerConnection)
LDServerSDK_DataSourceStatus_OnStatusChange(
    LDServerSDK sdk,
    struct LDServerDataSourceStatusListener listener);
 
LD_EXPORT(LDServerDataSourceStatus)
LDServerSDK_DataSourceStatus_Status(LDServerSDK sdk);
 
LD_EXPORT(void)
LDServerDataSourceStatus_Free(LDServerDataSourceStatus status);
 
typedef struct _LDServerBigSegmentStoreStatus* LDServerBigSegmentStoreStatus;
 
LD_EXPORT(bool)
LDServerBigSegmentStoreStatus_Available(LDServerBigSegmentStoreStatus status);
 
LD_EXPORT(bool)
LDServerBigSegmentStoreStatus_Stale(LDServerBigSegmentStoreStatus status);
 
LD_EXPORT(void)
LDServerBigSegmentStoreStatus_Free(LDServerBigSegmentStoreStatus status);
 
typedef void (*ServerBigSegmentStoreStatusCallbackFn)(
    LDServerBigSegmentStoreStatus status,
    void* user_data);
 
struct LDServerBigSegmentStoreStatusListener {
    ServerBigSegmentStoreStatusCallbackFn StatusChanged;
 
    void* UserData;
};
 
LD_EXPORT(void)
LDServerBigSegmentStoreStatusListener_Init(
    struct LDServerBigSegmentStoreStatusListener* listener);
 
LD_EXPORT(LDListenerConnection)
LDServerSDK_BigSegmentStoreStatus_OnStatusChange(
    LDServerSDK sdk,
    struct LDServerBigSegmentStoreStatusListener listener);
 
LD_EXPORT(LDServerBigSegmentStoreStatus)
LDServerSDK_BigSegmentStoreStatus_Status(LDServerSDK sdk);
 
#ifdef __cplusplus
}
#endif
 
// NOLINTEND modernize-use-using