experimentapi.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2017 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/experiment/experimenttypes.h"
#include "twitchsdk/core/coreapi.h"
#include "twitchsdk/core/module.h"


namespace ttv
{
    class TaskRunner;

    namespace experiment
    {
        class ExperimentAPI;
    }
}


class ttv::experiment::ExperimentAPI : public ttv::ModuleBase
{
public:
    using FetchExperimentsCallback = std::function<void(TTV_ErrorCode ec, const std::shared_ptr<ExperimentSet>& result)>;

public:
    ExperimentAPI();
    virtual ~ExperimentAPI();

    // IModule implementation
    virtual std::string GetModuleName() const override;
    virtual TTV_ErrorCode Initialize(const InitializeCallback& callback) override;
    virtual TTV_ErrorCode Shutdown(const ShutdownCallback& callback) override;
    virtual TTV_ErrorCode Update() override; 

    TTV_ErrorCode SetCoreApi(const std::shared_ptr<CoreAPI>& coreApi);
    TTV_ErrorCode SetAnalyticsId(const std::string& id);

    TTV_ErrorCode FetchExperiments(const FetchExperimentsCallback& callback);
    TTV_ErrorCode SetExperiments(const ExperimentSet& experiments);
    TTV_ErrorCode DeserializeExperiments(const std::string& json, ExperimentSet& result);
    TTV_ErrorCode DetermineBucket(const std::string& experiment, std::string& result);
    TTV_ErrorCode SetOverride(const std::string& experimentGuid, const std::string& groupValue);
    TTV_ErrorCode GetOverride(const std::string& experimentGuid, std::string& result);
    TTV_ErrorCode GetOverrides(std::map<std::string, std::string>& result);
    TTV_ErrorCode RemoveOverride(const std::string& experimentGuid);
    TTV_ErrorCode ClearOverrides();

protected:
    // ModuleBase overrides
    virtual bool CheckShutdown() override;
    virtual void CompleteShutdown() override;

private:
    class CoreApiClient : public ICoreApiClient
    {
    public:
        // ICoreApiClient implementation
        virtual std::string GetClientName();
    };

    std::shared_ptr<CoreAPI> mCoreApi;
    std::shared_ptr<TaskRunner> mTaskRunner;
    std::shared_ptr<CoreApiClient> mCoreApiClient;

    ExperimentSet mExperimentSet; // The last fetched experiment set.
    std::string mAnalyticsId; // The unique id used for hashing and generating buckets for experiments.
    std::map<std::string, std::string> mOverrides;
};