chatreplay.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/component.h"
#include "twitchsdk/core/timer.h"
#include "twitchsdk/chat/chattypes.h"
#include "twitchsdk/chat/chatlistener.h"
#include "twitchsdk/chat/ichatreplay.h"

#include <memory>
#include <atomic>

namespace ttv
{
    class ChannelRepository;
    class TaskRunner;
    class UserRepository;
    class SettingRepository;
    class PagedRequestFetcher;

    namespace chat
    {
        class ChatReplay;
        class BitsConfigRepository;
    }
}


class ttv::chat::ChatReplay : public Component, public IChatReplay
{
public:
    using DisposerFunc = std::function<void()>;

public:
    ChatReplay(const std::shared_ptr<User>& user);

    void SetDisposer(DisposerFunc&& func) { mDisposerFunc = func; }

    // Call these setters + SetTaskRunner before Initialize()
    void SetVodId(const std::string& vodId);
    void SetTokenizationOptions(const TokenizationOptions& tokenizationOptions) { mTokenizationOptions = tokenizationOptions; }
    void AddListener(const std::shared_ptr<IChatReplayListener>& listener) { mListeners.AddListener(listener); }
    void SetChannelRepository(const std::shared_ptr<ChannelRepository>& repository) { mChannelRepository = repository; }
    void SetBitsConfigRepository(const std::shared_ptr<BitsConfigRepository>& repository) { mBitsConfigRepository = repository; }

    std::string GetVodId() const { return mVodId; }

    // Component Overrides
    virtual TTV_ErrorCode Initialize() override;
    virtual void Update() override;
    virtual TTV_ErrorCode Shutdown() override;
    virtual void CompleteShutdown() override;
    virtual std::string GetLoggerName() const override;

    // IChatReplay Implementation
    virtual TTV_ErrorCode Dispose() override;
    virtual TTV_ErrorCode Play() override;
    virtual TTV_ErrorCode Pause() override;
    virtual TTV_ErrorCode Seek(Timestamp timestamp) override;
    virtual TTV_ErrorCode NudgePlayhead(uint64_t timestampMilliseconds) override;
    virtual TTV_ErrorCode GetCurrentTime(Timestamp& timestamp) const override;
    virtual TTV_ErrorCode DeleteMessage(const std::string& messageId) override;
    virtual TTV_ErrorCode GetChannelId(UserId& result) const override;
    virtual TTV_ErrorCode GetReplayState(ChatReplayState& result) const override;

private:
    struct ReplayMessageBatch
    {
        uint64_t baseTimestamp;
        std::vector<ReplayMessage> messages;
    };
    TTV_ErrorCode FetchVod();
    TTV_ErrorCode FetchBitsConfig();
    TTV_ErrorCode FetchChatReplayMessagesAtMillisecond(uint64_t timestamp);
    void Advance();
    void SetReplayState(ChatReplayState state);

    std::string mVodId;
    std::shared_ptr<User> mUser;
    EventSource<IChatReplayListener> mListeners;
    std::vector<ReplayMessageBatch> mFetchedLists;
    std::shared_ptr<ChannelRepository> mChannelRepository;
    std::shared_ptr<BitsConfigRepository> mBitsConfigRepository;
    std::shared_ptr<PagedRequestFetcher> mChatReplayMessagesFetcher;
    std::shared_ptr<BitsConfiguration> mBitsConfiguration;

    RetryTimer mFetchVodRetryTimer;
    RetryTimer mFetchBitsConfigRetryTimer;
    WaitForExpiry mFetchMessagesRetryTimer;
    
    DisposerFunc mDisposerFunc;
    
    TokenizationOptions mTokenizationOptions;
    
    uint64_t mLastUpdateTimeMilliseconds; // last system update time
    uint64_t mPlayheadTimeMilliseconds; // current time in vod
    uint64_t mLastLoadedTimeMilliseconds;
    Timestamp mVodRecordedAtSeconds;
    
    uint32_t mSeekCount;
    UserId mUserId;
    ChannelId mChannelId;
    ChatReplayState mReplayState;

    bool mVodFetchInFlight;
    bool mBitsConfigFetchInFlight;
    bool mHasFetchedVod;
    bool mHasFetchedBitsConfig;
    bool mHasNoMessages;
};