client.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
 
#include <launchdarkly/boolean.h>
#include <launchdarkly/config.h>
#include <launchdarkly/export.h>
#include <launchdarkly/json.h>
#include <launchdarkly/user.h>
 
struct LDClient;
 
#define LDPrimaryEnvironmentName "default"
 
typedef enum
{
    LDStatusInitializing = 0,
    LDStatusInitialized,
    LDStatusFailed,
    LDStatusShuttingdown,
    LDStatusShutdown
} LDStatus;
 
typedef struct
{
    int            variationIndex;
    struct LDJSON *reason;
} LDVariationDetails;
 
LD_EXPORT(struct LDClient *) LDClientGet(void);
 
LD_EXPORT(struct LDClient *) LDClientGetForMobileKey(const char *const keyName);
 
LD_EXPORT(struct LDClient *)
LDClientInit(
    struct LDConfig *const config,
    struct LDUser *const   user,
    const unsigned int     maxwaitmilli);
 
LD_EXPORT(char *) LDClientSaveFlags(struct LDClient *const client);
 
LD_EXPORT(LDBoolean)
LDClientRestoreFlags(struct LDClient *const client, const char *const data);
 
LD_EXPORT(void)
LDClientIdentify(struct LDClient *const client, struct LDUser *const user);
 
LD_EXPORT(void) LDClientFlush(struct LDClient *const client);
 
LD_EXPORT(LDBoolean) LDClientIsInitialized(struct LDClient *const client);
 
LD_EXPORT(LDBoolean)
LDClientAwaitInitialized(
    struct LDClient *const client, const unsigned int timeoutmilli);
 
LD_EXPORT(LDBoolean) LDClientIsOffline(struct LDClient *const client);
 
LD_EXPORT(void) LDClientSetOffline(struct LDClient *const client);
 
LD_EXPORT(void) LDClientSetOnline(struct LDClient *const client);
 
LD_EXPORT(void)
LDClientSetBackground(
    struct LDClient *const client, const LDBoolean background);
 
LD_EXPORT(void) LDClientClose(struct LDClient *const client);
 
LD_EXPORT(void) LDSetClientStatusCallback(void(callback)(int status));
 
 
typedef void (*LDstatusfn)(LDStatus status, void *userData);
 
 
LD_EXPORT(void) LDSetClientStatusCallbackUserData(LDstatusfn callback, void *userData);
 
LD_EXPORT(void)
LDClientAlias(
    struct LDClient *    client,
    const struct LDUser *currentUser,
    const struct LDUser *previousUser);
 
LD_EXPORT(void)
LDClientTrack(struct LDClient *const client, const char *const name);
 
LD_EXPORT(void)
LDClientTrackData(
    struct LDClient *const client,
    const char *const      name,
    struct LDJSON *const   data);
 
LD_EXPORT(void)
LDClientTrackMetric(
    struct LDClient *const client,
    const char *const      name,
    struct LDJSON *const   data,
    const double           metric);
 
LD_EXPORT(struct LDJSON *) LDAllFlags(struct LDClient *const client);
 
LD_EXPORT(LDBoolean)
LDBoolVariation(
    struct LDClient *const client,
    const char *const      featureKey,
    const LDBoolean        fallback);
 
LD_EXPORT(int)
LDIntVariation(
    struct LDClient *const client,
    const char *const      featureKey,
    const int              fallback);
 
LD_EXPORT(double)
LDDoubleVariation(
    struct LDClient *const client,
    const char *const      featureKey,
    const double           fallback);
 
LD_EXPORT(char *)
LDStringVariationAlloc(
    struct LDClient *const client,
    const char *const      featureKey,
    const char *const      fallback);
 
LD_EXPORT(char *)
LDStringVariation(
    struct LDClient *const client,
    const char *const      featureKey,
    const char *const      fallback,
    char *const            resultBuffer,
    const size_t           resultBufferSize);
 
LD_EXPORT(struct LDJSON *)
LDJSONVariation(
    struct LDClient *const     client,
    const char *const          featureKey,
    const struct LDJSON *const fallback);
 
LD_EXPORT(LDBoolean)
LDBoolVariationDetail(
    struct LDClient *const    client,
    const char *const         featureKey,
    const LDBoolean           fallback,
    LDVariationDetails *const details);
 
LD_EXPORT(int)
LDIntVariationDetail(
    struct LDClient *const    client,
    const char *const         featureKey,
    const int                 fallback,
    LDVariationDetails *const details);
 
LD_EXPORT(double)
LDDoubleVariationDetail(
    struct LDClient *const    client,
    const char *const         featureKey,
    const double              fallback,
    LDVariationDetails *const details);
 
LD_EXPORT(char *)
LDStringVariationAllocDetail(
    struct LDClient *const    client,
    const char *const         featureKey,
    const char *const         fallback,
    LDVariationDetails *const details);
 
LD_EXPORT(char *)
LDStringVariationDetail(
    struct LDClient *const    client,
    const char *const         featureKey,
    const char *const         fallback,
    char *const               resultBuffer,
    const size_t              resultBufferSize,
    LDVariationDetails *const details);
 
LD_EXPORT(struct LDJSON *)
LDJSONVariationDetail(
    struct LDClient *const     client,
    const char *const          key,
    const struct LDJSON *const fallback,
    LDVariationDetails *const  details);
 
LD_EXPORT(void) LDFreeDetailContents(LDVariationDetails details);
 
typedef void (*LDlistenerfn)(const char *const flagKey, const int status);
 
LD_EXPORT(LDBoolean)
LDClientRegisterFeatureFlagListener(
    struct LDClient *const client,
    const char *const      flagKey,
    LDlistenerfn           listener);
 
LD_EXPORT(void)
LDClientUnregisterFeatureFlagListener(
    struct LDClient *const client,
    const char *const      flagKey,
    LDlistenerfn           listener);