Skip to content

chore: update client-side docs to indicate ownership of objects #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 29, 2023
Merged

chore: update client-side docs to indicate ownership of objects #221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions libs/client-sdk/include/launchdarkly/client_side/bindings/c/config/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@ extern "C" { // only need to export C interface if
typedef struct _LDClientConfig* LDClientConfig;

/**
* Free the configuration. Configurations passed into an LDClient do not need to
* be freed.
* Frees an unused configuration. Configurations passed into an LDClient must
* not be be freed.
*
* @param config Config to free.
*/
LD_EXPORT(void) LDClientConfig_Free(LDClientConfig config);
Expand Down
27 changes: 19 additions & 8 deletions libs/client-sdk/include/launchdarkly/client_side/bindings/c/sdk.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,14 @@ typedef struct _LDClientSDK* LDClientSDK;
/**
* Constructs a new client-side LaunchDarkly SDK from a configuration and
* context.
* @param config The configuration. Must not be NULL.
* @param context The initial context. Must not be NULL.
* @return New SDK instance.
* @param config The configuration. Ownership is transferred. Do not free or
* access the LDClientConfig in any way after this call; behavior is undefined.
* Must not be NULL.
* @param context The initial context. Ownership is transferred. Do not free or
* access the LDContext in any way after this call; behavior is undefined. Must
* not be NULL.
* @return New SDK instance. Must be freed with LDClientSDK_Free when no longer
* needed.
*/
LD_EXPORT(LDClientSDK)
LDClientSDK_New(LDClientConfig config, LDContext context);
Expand Down Expand Up @@ -135,7 +140,9 @@ LD_EXPORT(void) LDClientSDK_TrackEvent(LDClientSDK sdk, char const* event_name);
* feature in numeric custom metrics, and will also be returned as part of the
* custom event for Data Export.
* @param data A JSON value containing additional data associated with the
* event. Must not be NULL.
* event. Ownership is transferred. Do not free or
* access the LDValue in any way after this call; behavior is undefined. Must
* not be NULL.
*/
LD_EXPORT(void)
LDClientSDK_TrackMetric(LDClientSDK sdk,
Expand All @@ -149,7 +156,9 @@ LDClientSDK_TrackMetric(LDClientSDK sdk,
* @param sdk SDK. Must not be NULL.
* @param event_name Must not be NULL.
* @param data A JSON value containing additional data associated with the
* event. Must not be NULL.
* event. Do not free or
* access the LDValue in any way after this call; behavior is undefined. Must
* not be NULL.
*/
LD_EXPORT(void)
LDClientSDK_TrackData(LDClientSDK sdk, char const* event_name, LDValue data);
Expand Down Expand Up @@ -354,7 +363,8 @@ LDClientSDK_DoubleVariationDetail(LDClientSDK sdk,
* Returns the JSON value of a feature flag for a given flag key.
* @param sdk SDK. Must not be NULL.
* @param flag_key The unique key for the feature flag. Must not be NULL.
* @param default_value The default value of the flag. The value is copied.
* @param default_value The default value of the flag. Ownership is retained by
* the caller; a copy is made internally. Must not be NULL.
* @return The variation for the current context, or a copy of default_value if
* the flag is disabled in the LaunchDarkly control panel. The returned value
* must be freed using LDValue_Free.
Expand All @@ -369,7 +379,8 @@ LDClientSDK_JsonVariation(LDClientSDK sdk,
* that also describes the way the value was determined.
* @param sdk SDK. Must not be NULL.
* @param flag_key The unique key for the feature flag. Must not be NULL.
* @param default_value The default value of the flag. The value is copied.
* @param default_value The default value of the flag. Ownership is retained by
* the caller; a copy is made internally. Must not be NULL.
* @param detail Out parameter to store the details. May pass LD_DISCARD_DETAILS
* or NULL to discard the details. The details object must be freed with
* LDEvalDetail_Free.
Expand Down Expand Up @@ -402,7 +413,7 @@ LDClientSDK_JsonVariationDetail(LDClientSDK sdk,
* }
* @endcode
* @param sdk SDK. Must not be NULL.
* @return Value of type Object.
* @return Value of type Object. Must be freed with LDValue_Free.
*/
LD_EXPORT(LDValue)
LDClientSDK_AllFlags(LDClientSDK sdk);
Expand Down