trackingapi.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-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/core/coreapi.h"
#include "twitchsdk/core/module.h"
#include "twitchsdk/tracking/trackingerrortypes.h"
#include "twitchsdk/tracking/trackingapilistener.h"

#include <sstream>

namespace ttv
{
    class TaskRunner;

    namespace tracking
    {
        class TrackingAPI;
    }
}


class ttv::tracking::TrackingAPI : public ttv::ModuleBase
{

public:
    TrackingAPI();
    virtual ~TrackingAPI();

    static const char* kSpadeUrl;

    // 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 SetMaxBytesInBatch(uint32_t batchSize);
    TTV_ErrorCode SetFlushIntervalInMs(uint32_t flushInterval);
    TTV_ErrorCode SetListener(const std::shared_ptr<ITrackingAPIListener>& listener);

    TTV_ErrorCode TrackEvent(const std::string& eventName, const std::map<std::string, TrackingValue>& params);
    TTV_ErrorCode TrackEvent(const std::string& eventName, const std::map<std::string, TrackingValue>& params, uint32_t& eventId);
    TTV_ErrorCode FlushEvents();

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

private:
    TTV_ErrorCode TrackEventInternal(const std::string& eventName, const std::map<std::string, TrackingValue>& params, uint32_t& eventId);
    TTV_ErrorCode FlushEventsInternal();

    class CoreApiClient : public ICoreApiClient
    {
    public:
        CoreApiClient();

        // ICoreApiClient implementation
        virtual std::string GetClientName();
    };

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

    std::stringstream mEventStream;
    uint32_t mQueuedBytes;
    uint32_t mBatchStartId;
    uint32_t mBatchEndId;

    uint32_t mMaxBytesInBatch;
    uint32_t mFlushIntervalInMs;

    ttv::WaitForExpiry mFlushTimer;
    std::shared_ptr<ITrackingAPIListener> mListener;

    std::shared_ptr<IMutex> mMutex;
};