ttv::GetStreamTask Class Reference

#include <getstreamtask.h>

Inheritance diagram for ttv::GetStreamTask:

Classes
struct	Result

Public Types
typedef std::function< void(GetStreamTask *source, TTV_ErrorCode ec, const std::shared_ptr< Result > &result)>	Callback
typedef TTV_TaskCallback	TaskCallback

Public Member Functions
	GetStreamTask (ChannelId channelId, const std::string &oauthToken, Callback callback)
	GetStreamTask (const std::string &channelName, const std::string &oauthToken, 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 void	ProcessResponse (uint status, const std::vector< char > &response) 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
std::shared_ptr< Result >	mResult
Callback	mCallback
std::string	mChannelName
ChannelId	mChannelId

---

Class Documentation

ttv::GetStreamTask::Result

struct ttv::GetStreamTask::Result

Class Members
unique_ptr< StreamInfo >	streamInfo

Member Typedef Documentation

Callback

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

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

GetStreamTask() [1/2]

ttv::GetStreamTask::GetStreamTask	(	ChannelId	channelId,
		const std::string &	oauthToken,
		Callback	callback
	)

GetStreamTask() [2/2]

ttv::GetStreamTask::GetStreamTask	(	const std::string &	channelName,
		const std::string &	oauthToken,
		Callback	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

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

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

virtual const char* ttv::GetStreamTask::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::GetStreamTask::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::GetStreamTask::ProcessResponse ( uint  status, const std::vector< char > &  response  )

overrideprotectedvirtual

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

mCallback

Callback ttv::GetStreamTask::mCallback

private

mChannelId

ChannelId ttv::GetStreamTask::mChannelId

private

mChannelName

std::string ttv::GetStreamTask::mChannelName

private

mResult

std::shared_ptr<Result> ttv::GetStreamTask::mResult

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/core/core_common/include/twitchsdk/core/task/getstreamtask.h