ttv::HttpTask Class Reference

#include <httptask.h>

Inheritance diagram for ttv::HttpTask:

Classes
struct	HttpRequestInfo

Public Types
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	HttpTask ()
	HttpTask (const std::string &authToken)
	HttpTask (TaskCallback callback, void *userData, const char *authToken)
virtual	~HttpTask ()
virtual void	Run () override
virtual void	OnComplete () override
virtual void	Abort ()
virtual const char *	GetTaskName () const =0

Protected Member Functions
virtual void	FillHttpRequestInfo (HttpRequestInfo &requestInfo)=0
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
TaskCallback	mCallback
void *	mUserData
std::atomic_bool	mAborted

Private Attributes
std::string	mAuthToken

Member Typedef Documentation

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

HttpTask() [1/3]

ttv::HttpTask::HttpTask

(

)

HttpTask() [2/3]

ttv::HttpTask::HttpTask

(

const std::string &

authToken

)

HttpTask() [3/3]

ttv::HttpTask::HttpTask	(	TaskCallback	callback,
		void *	userData,
		const char *	authToken
	)

~HttpTask()

virtual ttv::HttpTask::~HttpTask ( )

virtual

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

virtual void ttv::HttpTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

protectedpure virtual

Implemented in ttv::social::SocialFriendRequestsTask, ttv::social::SocialRecommendedFriendsTask, ttv::ads::FetchAdsTask, ttv::broadcast::MetaDataTask, ttv::chat::ChatGetDisplayInfoTask, ttv::chat::ChatRaidTask, ttv::chat::ChatReplayTask, ttv::social::SocialUpdateFriendTask, 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::broadcast::ChannelInfoTask, ttv::broadcast::MatchGameNamesTask, ttv::broadcast::RecordingStatusTask, ttv::social::SocialPresenceSettingsTask, ttv::broadcast::IngestListTask, ttv::broadcast::SetStreamInfoTask, ttv::chat::ChatRoomUpdateInfoTask, ttv::chat::ChatRoomUpdateViewTask, ttv::broadcast::RunCommercialTask, ttv::SimpleJsonHttpTask, ttv::chat::ChatReplayDeleteTask, ttv::chat::ChatRoomFetchMessagesTask, ttv::chat::ChatSetBroadcasterLanguageEnabledTask, ttv::GetStreamTask, ttv::chat::ChatChangeUserBlockTask, 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, ttv::ads::ReportAdEventTask, and ttv::tracking::TrackingRequestTask.

GetTaskName()

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

pure virtualinherited

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.

HeadersCallback()

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

protectedvirtual

Is2XX()

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

inlinestaticprotected

Is3XX()

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

inlinestaticprotected

Is4XX()

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

inlinestaticprotected

OnComplete()

virtual void ttv::HttpTask::OnComplete ( )

overridevirtual

Implements ttv::Task.

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::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::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::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.

ProcessHeaders()

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

protectedvirtual

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  )

protectedvirtual

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  )

protectedvirtual

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

Run()

virtual void ttv::HttpTask::Run ( )

overridevirtual

Implements ttv::Task.

Member Data Documentation

mAborted

std::atomic_bool ttv::Task::mAborted

protectedinherited

mAuthToken

std::string ttv::HttpTask::mAuthToken

private

mCallback

TaskCallback ttv::Task::mCallback

protectedinherited

mTaskStatus

TTV_ErrorCode ttv::HttpTask::mTaskStatus

protected

mUserData

void* ttv::Task::mUserData

protectedinherited

---

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

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