sdk.h

Go to the documentation of this file.

 
// NOLINTBEGIN modernize-use-using
#pragma once
 
#include <launchdarkly/client_side/bindings/c/config/builder.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/flag_listener.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 _LDClientSDK* LDClientSDK;
 
LD_EXPORT(LDClientSDK)
LDClientSDK_New(LDClientConfig config, LDContext context);
 
LD_EXPORT(char const*)
LDClientSDK_Version(void);
 
LD_EXPORT(bool)
LDClientSDK_Start(LDClientSDK sdk,
                  unsigned int milliseconds,
                  bool* out_succeeded);
 
LD_EXPORT(bool)
LDClientSDK_Initialized(LDClientSDK sdk);
 
LD_EXPORT(void)
LDClientSDK_TrackEvent(LDClientSDK sdk, char const* event_name);
 
LD_EXPORT(void)
LDClientSDK_TrackMetric(LDClientSDK sdk,
                        char const* event_name,
                        double metric_value,
                        LDValue data);
 
LD_EXPORT(void)
LDClientSDK_TrackData(LDClientSDK sdk, char const* event_name, LDValue data);
 
LD_EXPORT(void)
LDClientSDK_Flush(LDClientSDK sdk, unsigned int reserved);
 
LD_EXPORT(bool)
LDClientSDK_Identify(LDClientSDK sdk,
                     LDContext context,
                     unsigned int milliseconds,
                     bool* out_succeeded);
 
LD_EXPORT(bool)
LDClientSDK_BoolVariation(LDClientSDK sdk,
                          char const* flag_key,
                          bool default_value);
 
LD_EXPORT(bool)
LDClientSDK_BoolVariationDetail(LDClientSDK sdk,
                                char const* flag_key,
                                bool default_value,
                                LDEvalDetail* out_detail);
 
LD_EXPORT(char*)
LDClientSDK_StringVariation(LDClientSDK sdk,
                            char const* flag_key,
                            char const* default_value);
 
LD_EXPORT(char*)
LDClientSDK_StringVariationDetail(LDClientSDK sdk,
                                  char const* flag_key,
                                  char const* default_value,
                                  LDEvalDetail* out_detail);
 
LD_EXPORT(int)
LDClientSDK_IntVariation(LDClientSDK sdk,
                         char const* flag_key,
                         int default_value);
 
LD_EXPORT(int)
LDClientSDK_IntVariationDetail(LDClientSDK sdk,
                               char const* flag_key,
                               int default_value,
                               LDEvalDetail* out_detail);
 
LD_EXPORT(int)
LDClientSDK_DoubleVariation(LDClientSDK sdk,
                            char const* flag_key,
                            double default_value);
 
LD_EXPORT(int)
LDClientSDK_DoubleVariationDetail(LDClientSDK sdk,
                                  char const* flag_key,
                                  double default_value,
                                  LDEvalDetail* out_detail);
 
LD_EXPORT(LDValue)
LDClientSDK_JsonVariation(LDClientSDK sdk,
                          char const* flag_key,
                          LDValue default_value);
 
LD_EXPORT(LDValue)
LDClientSDK_JsonVariationDetail(LDClientSDK sdk,
                                char const* flag_key,
                                LDValue default_value,
                                LDEvalDetail* out_detail);
 
LD_EXPORT(LDValue)
LDClientSDK_AllFlags(LDClientSDK sdk);
 
LD_EXPORT(void)
LDClientSDK_Free(LDClientSDK sdk);
 
LD_EXPORT(LDListenerConnection)
LDClientSDK_FlagNotifier_OnFlagChange(LDClientSDK sdk,
                                      char const* flag_key,
                                      struct LDFlagListener listener);
 
typedef struct _LDDataSourceStatus* LDDataSourceStatus;
 
enum LDDataSourceStatus_State {
    LD_DATASOURCESTATUS_STATE_INITIALIZING = 0,
 
    LD_DATASOURCESTATUS_STATE_VALID = 1,
 
    LD_DATASOURCESTATUS_STATE_INTERRUPTED = 2,
 
    LD_DATASOURCESTATUS_STATE_OFFLINE = 3,
 
    LD_DATASOURCESTATUS_STATE_SHUTDOWN = 4,
 
    LD_DATASOURCESTATUS_STATE_UNUSED_MAXVALUE =
        INT32_MAX /* Used to ensure the underlying type is
                   * at least 32 bits. */
};
 
LD_EXPORT(char const*)
LDDataSourceStatus_State_Name(enum LDDataSourceStatus_State state,
                              char const* default_if_unknown);
 
LD_EXPORT(enum LDDataSourceStatus_State)
LDDataSourceStatus_GetState(LDDataSourceStatus status);
 
LD_EXPORT(LDDataSourceStatus_ErrorInfo)
LDDataSourceStatus_GetLastError(LDDataSourceStatus status);
 
LD_EXPORT(time_t)
LDDataSourceStatus_StateSince(LDDataSourceStatus status);
 
typedef void (*DataSourceStatusCallbackFn)(LDDataSourceStatus status,
                                           void* user_data);
 
struct LDDataSourceStatusListener {
    DataSourceStatusCallbackFn StatusChanged;
 
    void* UserData;
};
 
LD_EXPORT(void)
LDDataSourceStatusListener_Init(struct LDDataSourceStatusListener* listener);
 
LD_EXPORT(LDListenerConnection)
LDClientSDK_DataSourceStatus_OnStatusChange(
    LDClientSDK sdk,
    struct LDDataSourceStatusListener listener);
 
LD_EXPORT(LDDataSourceStatus)
LDClientSDK_DataSourceStatus_Status(LDClientSDK sdk);
 
LD_EXPORT(void)
LDDataSourceStatus_Free(LDDataSourceStatus status);
 
#ifdef __cplusplus
}
#endif
 
// NOLINTEND modernize-use-using