ttv::Task Class Reference

#include <task.h>

Inheritance diagram for ttv::Task:

Public Types
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	Task ()
	Task (TaskCallback callback, void *userData)
virtual	~Task ()
virtual void	Run ()=0
virtual void	Abort ()
virtual void	OnComplete ()=0
virtual const char *	GetTaskName () const =0

Protected Attributes
TaskCallback	mCallback
void *	mUserData
std::atomic_bool	mAborted

Member Typedef Documentation

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

Constructor & Destructor Documentation

Task() [1/2]

ttv::Task::Task ( )

inline

Task() [2/2]

ttv::Task::Task ( TaskCallback  callback, void *  userData  )

inline

~Task()

virtual ttv::Task::~Task ( )

virtual

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtual

GetTaskName()

virtual const char* ttv::Task::GetTaskName ( ) const

pure virtual

Implemented in ttv::social::SocialFriendRequestsTask, ttv::social::SocialRecommendedFriendsTask, ttv::ads::FetchAdsTask, ttv::broadcast::MetaDataTask, ttv::chat::ChatGetDisplayInfoTask, ttv::chat::ChatGetUnreadMessageCountTask, ttv::chat::ChatRaidTask, ttv::chat::ChatReplayTask, ttv::social::SocialUpdateFriendTask, ttv::chat::ChatGetUserThreadsTask, ttv::chat::ChatGetThreadMessagesTask, ttv::chat::ChatUpdateUserThreadTask, ttv::broadcast::GameStreamsTask, ttv::chat::ChatPropertiesTask, ttv::social::SocialGetFriendsPresenceTask, ttv::chat::ChatChannelUsersTask, ttv::chat::ChatSendWhisperTask, ttv::chat::ChatGetBlockListTask, ttv::chat::ChatGetBadgesTask, ttv::chat::ChatGetBitsConfigTask, ttv::chat::ChatGetEmoticonsTask, ttv::social::SocialPostPresenceTask, ttv::social::SocialPresenceSettingsTask, ttv::broadcast::ChannelInfoTask, ttv::broadcast::MatchGameNamesTask, ttv::broadcast::RecordingStatusTask, ttv::chat::ChatRoomUpdateInfoTask, ttv::chat::ChatRoomUpdateViewTask, ttv::broadcast::IngestListTask, ttv::broadcast::SetStreamInfoTask, ttv::LambdaTask, ttv::broadcast::RunCommercialTask, ttv::chat::ChatReplayDeleteTask, ttv::chat::ChatRoomFetchMessagesTask, ttv::chat::ChatSetBroadcasterLanguageEnabledTask, ttv::SimpleJsonHttpTask, ttv::chat::ChatChangeUserBlockTask, ttv::chat::ChatModUserTask, ttv::chat::ChatRoomUpdateModeTask, ttv::GetStreamTask, ttv::chat::ChatBanUserTask, ttv::GetUserTask, 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::GetChannelTask, ttv::GetProfileImageUrlTask, ttv::ValidateOAuthTask, ttv::GetVodTask, ttv::experiment::FetchExperimentsTask, ttv::ads::ReportAdEventTask, ttv::UploadProfileImageTask, and ttv::tracking::TrackingRequestTask.

OnComplete()

virtual void ttv::Task::OnComplete ( )

pure virtual

Implemented in ttv::social::SocialFriendRequestsTask, ttv::social::SocialRecommendedFriendsTask, ttv::chat::ChatGetDisplayInfoTask, ttv::chat::ChatReplayTask, ttv::social::SocialUpdateFriendTask, ttv::ads::FetchAdsTask, ttv::chat::ChatGetUnreadMessageCountTask, ttv::chat::ChatGetUserThreadsTask, ttv::chat::ChatRaidTask, ttv::chat::ChatApiTask, ttv::chat::ChatGetThreadMessagesTask, ttv::chat::ChatUpdateUserThreadTask, ttv::broadcast::MetaDataTask, ttv::social::SocialGetFriendsPresenceTask, ttv::chat::ChatPropertiesTask, ttv::chat::ChatSendWhisperTask, ttv::chat::ChatGetBlockListTask, ttv::social::SocialPostPresenceTask, ttv::broadcast::GameStreamsTask, ttv::broadcast::ChannelInfoTask, ttv::social::SocialPresenceSettingsTask, ttv::broadcast::SetStreamInfoTask, ttv::chat::ChatChannelUsersTask, ttv::chat::ChatSetBroadcasterLanguageEnabledTask, ttv::HttpTask, ttv::chat::ChatReplayDeleteTask, ttv::GetChannelTask, ttv::GetUserTask, ttv::chat::ChatChangeUserBlockTask, ttv::ValidateOAuthTask, ttv::broadcast::MatchGameNamesTask, ttv::broadcast::RecordingStatusTask, ttv::chat::ChatGetBitsConfigTask, ttv::chat::ChatGetEmoticonsTask, ttv::GetProfileImageUrlTask, ttv::broadcast::IngestListTask, ttv::GetVodTask, ttv::LambdaTask, ttv::broadcast::RunCommercialTask, ttv::chat::ChatGetBadgesTask, ttv::chat::ChatRoomUpdateInfoTask, ttv::chat::ChatRoomUpdateViewTask, ttv::SimpleJsonHttpTask, ttv::UploadProfileImageTask, ttv::GetStreamTask, ttv::chat::ChatModUserTask, ttv::chat::ChatRoomUpdateModeTask, ttv::chat::ChatBanUserTask, ttv::chat::ChatAddNewRoomTask, ttv::chat::ChatFetchChannelModeratorsTask, ttv::chat::ChatFetchChannelRoomsTask, ttv::chat::ChatRoomDeleteMessageTask, ttv::chat::ChatRoomDeleteRoomTask, ttv::chat::ChatRoomEditMessageTask, ttv::chat::ChatRoomFetchInfoTask, ttv::chat::ChatRoomFetchMessagesTask, ttv::chat::ChatRoomJoinChannelTask, ttv::chat::ChatRoomLeaveChannelTask, ttv::chat::ChatRoomSendMessageTask, ttv::chat::ChatUnbanUserTask, ttv::chat::ChatUpdateColorTask, ttv::ads::ReportAdEventTask, ttv::experiment::FetchExperimentsTask, and ttv::tracking::TrackingRequestTask.

Run()

virtual void ttv::Task::Run ( )

pure virtual

Implemented in ttv::chat::ChatApiTask, ttv::HttpTask, and ttv::LambdaTask.

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protected

mCallback

TaskCallback ttv::Task::mCallback

protected

mUserData

void* ttv::Task::mUserData

protected

---

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

• modules/core/core_common/include/twitchsdk/core/task/task.h