ttv::ads::ReportAdEventTask Class Reference

#include <reportadeventtask.h>

Inheritance diagram for ttv::ads::ReportAdEventTask:

Public Types
using	Callback = std::function< void(ReportAdEventTask *source, TTV_ErrorCode ec)>
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	ReportAdEventTask (const std::string &adUrlTemplate, const std::map< std::string, std::string > &macroSubstitutions, const Callback &callback)
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)
virtual void	ProcessResponse (uint statusCode, const std::vector< char > &response)

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
std::string	mUrl
Callback	mCallback

Member Typedef Documentation

Callback

using ttv::ads::ReportAdEventTask::Callback = std::function<void(ReportAdEventTask* source, TTV_ErrorCode ec)>

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ReportAdEventTask()

ttv::ads::ReportAdEventTask::ReportAdEventTask	(	const std::string &	adUrlTemplate,
		const std::map< std::string, std::string > &	macroSubstitutions,
		const Callback &	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

virtual void ttv::ads::ReportAdEventTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::ads::ReportAdEventTask::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::ads::ReportAdEventTask::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()

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

protectedvirtualinherited

Reimplemented in ttv::social::SocialFriendRequestsTask, ttv::social::SocialRecommendedFriendsTask, ttv::chat::ChatGetDisplayInfoTask, ttv::chat::ChatReplayTask, ttv::social::SocialUpdateFriendTask, ttv::ads::FetchAdsTask, ttv::chat::ChatRaidTask, ttv::broadcast::GameStreamsTask, ttv::social::SocialGetFriendsPresenceTask, ttv::chat::ChatPropertiesTask, ttv::chat::ChatChannelUsersTask, ttv::chat::ChatGetBlockListTask, ttv::chat::ChatGetBadgesTask, ttv::social::SocialPostPresenceTask, ttv::chat::ChatGetBitsConfigTask, ttv::chat::ChatGetEmoticonsTask, ttv::broadcast::ChannelInfoTask, ttv::broadcast::MatchGameNamesTask, ttv::broadcast::RecordingStatusTask, ttv::social::SocialPresenceSettingsTask, ttv::broadcast::IngestListTask, ttv::chat::ChatRoomUpdateInfoTask, ttv::chat::ChatRoomUpdateViewTask, ttv::SimpleJsonHttpTask, ttv::chat::ChatRoomFetchMessagesTask, ttv::GetStreamTask, ttv::chat::ChatModUserTask, ttv::chat::ChatRoomUpdateModeTask, ttv::GetChannelTask, ttv::GetUserTask, ttv::chat::ChatBanUserTask, ttv::ValidateOAuthTask, ttv::chat::ChatAddNewRoomTask, ttv::chat::ChatFetchChannelModeratorsTask, ttv::chat::ChatFetchChannelRoomsTask, ttv::chat::ChatRoomDeleteMessageTask, ttv::chat::ChatRoomDeleteRoomTask, ttv::chat::ChatRoomEditMessageTask, ttv::chat::ChatRoomFetchInfoTask, ttv::chat::ChatRoomJoinChannelTask, ttv::chat::ChatRoomLeaveChannelTask, ttv::chat::ChatRoomSendMessageTask, ttv::chat::ChatUnbanUserTask, ttv::chat::ChatUpdateColorTask, ttv::GetProfileImageUrlTask, ttv::GetVodTask, ttv::UploadProfileImageTask, ttv::experiment::FetchExperimentsTask, and ttv::tracking::TrackingRequestTask.

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::ads::ReportAdEventTask::mCallback

private

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protectedinherited

mUrl

std::string ttv::ads::ReportAdEventTask::mUrl

private

mUserData

void* ttv::Task::mUserData

protectedinherited

---

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

• modules/ads/ads_common/include/twitchsdk/ads/internal/task/reportadeventtask.h