ttv::broadcast::MetaDataTask Class Reference

#include <metadatatask.h>

Inheritance diagram for ttv::broadcast::MetaDataTask:

Classes
struct	Result

Public Types
enum	EventClass { EventClass::Action, EventClass::Start, EventClass::End }
typedef std::function< void(MetaDataTask *source, TTV_ErrorCode ec, const std::shared_ptr< Result > &result)>	Callback
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	MetaDataTask (const std::string &authToken, uint64_t streamId, EventClass eventClass, const std::string &name, int64_t streamTime, unsigned long sequenceNumber, const std::string &humanDescription, json::Value &&metaData, Callback callback)
virtual void	OnComplete () override
virtual const char *	GetTaskName () const override
virtual void	Run () override
virtual void	Abort ()

Protected Member Functions
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::shared_ptr< Result >	mResult
Callback	mCallback
uint64_t	mStreamId
EventClass	mEventClass
std::string	mName
int64_t	mStreamTime
unsigned long	mSequenceNumber
std::string	mHumanDescription
json::Value	mMetaData

---

Class Documentation

ttv::broadcast::MetaDataTask::Result

struct ttv::broadcast::MetaDataTask::Result

Member Typedef Documentation

Callback

typedef std::function<void(MetaDataTask* source, TTV_ErrorCode ec, const std::shared_ptr<Result>& result)> ttv::broadcast::MetaDataTask::Callback

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Member Enumeration Documentation

EventClass

enum ttv::broadcast::MetaDataTask::EventClass

strong

Enumerator
Action
Start
End

Constructor & Destructor Documentation

MetaDataTask()

ttv::broadcast::MetaDataTask::MetaDataTask	(	const std::string &	authToken,
		uint64_t	streamId,
		EventClass	eventClass,
		const std::string &	name,
		int64_t	streamTime,
		unsigned long	sequenceNumber,
		const std::string &	humanDescription,
		json::Value &&	metaData,
		Callback	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

virtual void ttv::broadcast::MetaDataTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::broadcast::MetaDataTask::GetTaskName ( ) const

inlineoverridevirtual

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()

virtual void ttv::broadcast::MetaDataTask::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::broadcast::MetaDataTask::mCallback

private

mEventClass

EventClass ttv::broadcast::MetaDataTask::mEventClass

private

mHumanDescription

std::string ttv::broadcast::MetaDataTask::mHumanDescription

private

mMetaData

json::Value ttv::broadcast::MetaDataTask::mMetaData

private

mName

std::string ttv::broadcast::MetaDataTask::mName

private

mResult

std::shared_ptr<Result> ttv::broadcast::MetaDataTask::mResult

private

mSequenceNumber

unsigned long ttv::broadcast::MetaDataTask::mSequenceNumber

private

mStreamId

uint64_t ttv::broadcast::MetaDataTask::mStreamId

private

mStreamTime

int64_t ttv::broadcast::MetaDataTask::mStreamTime

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/broadcast/broadcast_common/include/twitchsdk/broadcast/internal/task/metadatatask.h