launchdarkly::server_side::hooks::Hook Class Reference

#include <hook.hpp>

Inheritance diagram for launchdarkly::server_side::hooks::Hook:

Public Member Functions
virtual HookMetadata const &	Metadata () const =0
virtual EvaluationSeriesData	BeforeEvaluation (EvaluationSeriesContext const &series_context, EvaluationSeriesData data)
virtual EvaluationSeriesData	AfterEvaluation (EvaluationSeriesContext const &series_context, EvaluationSeriesData data, EvaluationDetail< Value > const &detail)
virtual void	AfterTrack (TrackSeriesContext const &series_context)

Detailed Description

Base interface for hook implementations.

All stage methods have default implementations that take no action, allowing hook implementations to only override the stages they need.

This interface is designed for forward compatibility - new stages can be added without breaking existing hook implementations.

IMPORTANT LIFETIME CONSIDERATIONS:

• All context objects passed to hook stages are valid only during the execution of that stage.
• Do not store references, pointers, or string_views from context objects.
• If you need data beyond the immediate execution of a stage, copy it to owned types (std::string, Value, etc.).
• EvaluationSeriesData should only be used within the stage or returned to be passed to the next stage.

Member Function Documentation

AfterEvaluation()

EvaluationSeriesData launchdarkly::server_side::hooks::Hook::AfterEvaluation ( EvaluationSeriesContext const &  series_context, EvaluationSeriesData  data, EvaluationDetail< Value > const &  detail  )

virtual

Called after a flag has been evaluated.

Parameters

series_context	Context for this evaluation (valid only during this call).
data	Data from the before stage.
detail	The evaluation result.

Returns

Data to pass to the next stage (currently unused).

Reimplemented in launchdarkly::server_side::bindings::CHookWrapper.

AfterTrack()

void launchdarkly::server_side::hooks::Hook::AfterTrack ( TrackSeriesContext const &  series_context )

virtual

Called after a custom event has been enqueued via Track.

Parameters

series_context

Context for this track call (valid only during this call).

Reimplemented in launchdarkly::server_side::bindings::CHookWrapper.

BeforeEvaluation()

EvaluationSeriesData launchdarkly::server_side::hooks::Hook::BeforeEvaluation ( EvaluationSeriesContext const &  series_context, EvaluationSeriesData  data  )

virtual

Called before a flag is evaluated.

Parameters

series_context	Context for this evaluation (valid only during this call).
data	Data from previous stage (empty for first stage).

Returns

Data to pass to the next stage.

Reimplemented in launchdarkly::server_side::bindings::CHookWrapper.

Metadata()

virtual HookMetadata const& launchdarkly::server_side::hooks::Hook::Metadata ( ) const

pure virtual

Returns metadata about this hook.

Returns

Reference to hook metadata.

Implemented in launchdarkly::server_side::bindings::CHookWrapper.

---

The documentation for this class was generated from the following files:

• include/launchdarkly/server_side/hooks/hook.hpp
• src/hooks/hook.cpp