ttv::experiment::FetchExperimentsTask Class Reference

#include <fetchexperimentstask.h>

Inheritance diagram for ttv::experiment::FetchExperimentsTask:

Public Types
using	Callback = std::function< void(FetchExperimentsTask *source, TTV_ErrorCode ec, const std::shared_ptr< ExperimentSet > &result)>
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	FetchExperimentsTask (Callback callback)
void	ProcessResponse (uint statusCode, const std::vector< char > &response) override
void	OnComplete () override
virtual void	Run () override
virtual void	Abort ()

Static Public Member Functions
static TTV_ErrorCode	ParseExperimentSet (const std::string &json, ExperimentSet &result)

Protected Member Functions
virtual const char *	GetTaskName () const override
virtual void	FillHttpRequestInfo (HttpRequestInfo &requestInfo) override
virtual bool	HeadersCallback (uint statusCode, const std::map< std::string, std::string > &headers)
virtual void	ResponseCallback (uint statusCode, const std::vector< char > &response)
virtual bool	ProcessHeaders (uint statusCode, const std::map< std::string, std::string > &headers)

Static Protected Member Functions
static TTV_ErrorCode	ParseExperiment (const json::Value &jsonExperiment, Experiment &experiment)
static bool	Is2XX (uint32_t statusCode)
static bool	Is3XX (uint32_t statusCode)
static bool	Is4XX (uint32_t statusCode)

Protected Attributes
TTV_ErrorCode	mTaskStatus
void *	mUserData
std::atomic_bool	mAborted

Private Attributes
Callback	mCallback
std::shared_ptr< ExperimentSet >	mResult

Member Typedef Documentation

Callback

using ttv::experiment::FetchExperimentsTask::Callback = std::function<void(FetchExperimentsTask* source, TTV_ErrorCode ec, const std::shared_ptr<ExperimentSet>& result)>

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

FetchExperimentsTask()

ttv::experiment::FetchExperimentsTask::FetchExperimentsTask

(

Callback

callback

)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

virtual void ttv::experiment::FetchExperimentsTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::experiment::FetchExperimentsTask::GetTaskName ( ) const

inlineoverrideprotectedvirtual

Implements ttv::Task.

HeadersCallback()

virtual bool ttv::HttpTask::HeadersCallback ( uint  statusCode, const std::map< std::string, std::string > &  headers  )

protectedvirtualinherited

Is2XX()

static bool ttv::HttpTask::Is2XX ( uint32_t  statusCode )

inlinestaticprotectedinherited

Is3XX()

static bool ttv::HttpTask::Is3XX ( uint32_t  statusCode )

inlinestaticprotectedinherited

Is4XX()

static bool ttv::HttpTask::Is4XX ( uint32_t  statusCode )

inlinestaticprotectedinherited

OnComplete()

void ttv::experiment::FetchExperimentsTask::OnComplete ( )

overridevirtual

Reimplemented from ttv::HttpTask.

ParseExperiment()

static TTV_ErrorCode ttv::experiment::FetchExperimentsTask::ParseExperiment ( const json::Value &  jsonExperiment, Experiment &  experiment  )

staticprotected

ParseExperimentSet()

static TTV_ErrorCode ttv::experiment::FetchExperimentsTask::ParseExperimentSet ( const std::string &  json, ExperimentSet &  result  )

static

ProcessHeaders()

virtual bool ttv::HttpTask::ProcessHeaders ( uint  statusCode, const std::map< std::string, std::string > &  headers  )

protectedvirtualinherited

Reimplemented in ttv::social::SocialFriendRequestsTask, ttv::social::SocialRecommendedFriendsTask, ttv::social::SocialUpdateFriendTask, ttv::social::SocialGetFriendsPresenceTask, ttv::chat::ChatChannelUsersTask, and ttv::social::SocialPostPresenceTask.

ProcessResponse()

void ttv::experiment::FetchExperimentsTask::ProcessResponse ( uint  statusCode, const std::vector< char > &  response  )

overridevirtual

Reimplemented from ttv::HttpTask.

ResponseCallback()

virtual void ttv::HttpTask::ResponseCallback ( uint  statusCode, const std::vector< char > &  response  )

protectedvirtualinherited

Reimplemented in ttv::ads::FetchAdsTask, ttv::chat::ChatReplayTask, ttv::chat::ChatSendWhisperTask, and ttv::chat::ChatSetBroadcasterLanguageEnabledTask.

Run()

virtual void ttv::HttpTask::Run ( )

overridevirtualinherited

Implements ttv::Task.

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mCallback

Callback ttv::experiment::FetchExperimentsTask::mCallback

private

mResult

std::shared_ptr<ExperimentSet> ttv::experiment::FetchExperimentsTask::mResult

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

mUserData

void* ttv::Task::mUserData

protectedinherited

---

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

• modules/experiment/experiment_common/include/twitchsdk/experiment/internal/task/fetchexperimentstask.h