ttv::tracking::TrackingRequestTask Class Reference

#include <trackingrequesttask.h>

Inheritance diagram for ttv::tracking::TrackingRequestTask:

Public Types
typedef std::function< void(TrackingRequestTask *source, const uint32_t &batchStartId, const uint32_t &batchEndId, const std::string &serverUrl, TTV_ErrorCode ec)>	Callback
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	TrackingRequestTask (const std::string &serverUrl, const std::string &batchJson, const std::string &authToken, uint32_t batchStartId, uint32_t batchEndId, Callback callback)
void	ProcessResponse (uint statusCode, const std::vector< char > &response) override
void	OnComplete () override
virtual void	Run () override
virtual void	Abort ()

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 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::string	mAuthToken
std::string	mServerUrl
std::string	mBatchJson
uint32_t	mBatchStartId
uint32_t	mBatchEndId

Member Typedef Documentation

Callback

typedef std::function<void(TrackingRequestTask* source, const uint32_t& batchStartId, const uint32_t& batchEndId, const std::string& serverUrl, TTV_ErrorCode ec)> ttv::tracking::TrackingRequestTask::Callback

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

TrackingRequestTask()

ttv::tracking::TrackingRequestTask::TrackingRequestTask	(	const std::string &	serverUrl,
		const std::string &	batchJson,
		const std::string &	authToken,
		uint32_t	batchStartId,
		uint32_t	batchEndId,
		Callback	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

virtual void ttv::tracking::TrackingRequestTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::tracking::TrackingRequestTask::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::tracking::TrackingRequestTask::OnComplete ( )

overridevirtual

Reimplemented from ttv::HttpTask.

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::tracking::TrackingRequestTask::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

mAuthToken

std::string ttv::tracking::TrackingRequestTask::mAuthToken

private

mBatchEndId

uint32_t ttv::tracking::TrackingRequestTask::mBatchEndId

private

mBatchJson

std::string ttv::tracking::TrackingRequestTask::mBatchJson

private

mBatchStartId

uint32_t ttv::tracking::TrackingRequestTask::mBatchStartId

private

mCallback

Callback ttv::tracking::TrackingRequestTask::mCallback

private

mServerUrl

std::string ttv::tracking::TrackingRequestTask::mServerUrl

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/tracking/tracking_common/include/twitchsdk/tracking/internal/task/trackingrequesttask.h