Skip to main content

Documentation Index

Fetch the complete documentation index at: https://launchdarkly-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This topic explains how to safely shut down different LaunchDarkly SDKs. This feature is available for client-side, server-side, and edge SDKs.

​
Shut down the Launch

Darkly client LaunchDarkly SDKs provide language-specific methods to shut down their instances safely. In most applications, you do not have to manually shut down an SDK. LaunchDarkly SDKs automatically flush pending analytics events to LaunchDarkly at regular intervals. However, when your application is about to terminate, you should shut down the LaunchDarkly client. For most SDKs, this ensures that the client releases any resources it is using, and that it delivers any pending analytics to LaunchDarkly. If your application terminates without this shutdown step, flag evaluations and contexts or users may not appear on the Contexts list, because they are derived from analytics events. To learn more, read Analytics events. Do not attempt to evaluate flags or otherwise use the LaunchDarkly client after it has shut down, as doing so may result in undefined behavior. Shut down the client at a point in your application’s lifecycle where the client is no longer needed. Details about each SDK’s configuration are available in the SDK-specific sections below.

​
Client-side SDKs

This feature is available in the following client-side SDKs:

​
.NET (client-side)

To shut down:
      client.Dispose();

​
Android

To shut down:
      client.close();

​
C++ (client-side)

In the C++ SDK v3.0, the client will be automatically closed.If you are using the C binding, you must specifically close the client. The operation blocks until all resources are free.To shut down:
      LDClientSDK_Free(client);

​
Electron

To shut down:
      await client.close();

​
Flutter

To shut down:
      await client.close();
To learn more, read close.

​
iOS

To shut down:
      client.close()

​
Java

Script
To shut down:
      await client.close();

​
Node.js (client-side)

To shut down:
      await client.close();

​
React Native

Calling close flushes all queued events and shuts all open network connections.To shut down:
      await client.close();
To learn more, read close.

​
Server-side SDKs

This feature is available in the following server-side SDKs:

​
.NET (server-side)

Dispose safely shuts down the client instance.To shut down:
      client.Dispose();

​
C++ (server-side)

In the C++ SDK v3.0, the SDK will be automatically closed.If you are using the C binding, you must specifically close the client. The operation blocks until all resources are free.To shut down:
      LDServerSDK_Free(client);

​
Erlang

stop_instance(), stop_instance(Tag), and stop_all_instances() all safely shut down client instances and release the resources associated with them.To shut down:
      ldclient:stop_all_instances()

      % Stops the default instance
      ldclient:stop_instance()

      % Stops a named instance
      ldclient:stop_instance(my_instance)

​
Go

When your application is about to terminate, shut down the LDClient with Close().To shut down:
      client.Close()

​
Haskell

To shut down:
      close client

​
Java

Close safely shuts down the client instance and releases all resources associated with the client.To shut down:
      client.close();

​
Node.js (server-side)

Unlike other LaunchDarkly SDKs, the Node.js (server-side) SDK does not automatically send pending analytics events to LaunchDarkly when it shuts down. To send analytics events, you first need to call flush.To shut down:
      client.close();

​
Python

To shut down:
      ldclient.get().close()

​
Ruby

Shutting down frees the resources the worker threads were using and provides an explicit signal for the Ruby SDK to send the remaining event data back to LaunchDarkly.To shut down:
      client.close

​
Rust

To shut down:
      client.close();

​
Edge SDKs

This feature is available in the following edge SDKs:

​
Cloudflare

close safely shuts down the client instance:
      client.close();

​
Fastly

close safely shuts down the client instance:
      client.close();
Typically, you do not need to call this method, because the client will close safely when the worker exists. However, you must flush events before your worker exits to ensure that they are sent back to LaunchDarkly.

​
Vercel

close safely shuts down the client instance:
      client.close();