ttv::chat::ChatChannelUsersTask Class Reference

#include <chatchanneluserstask.h>

Inheritance diagram for ttv::chat::ChatChannelUsersTask:

Classes
struct	Result

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

Public Member Functions
	ChatChannelUsersTask (const std::string &channelName, Callback callback)
virtual 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	ProcessHeaders (uint statusCode, const std::map< std::string, std::string > &headers) override
virtual void	ProcessResponse (uint statusCode, 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)

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 Member Functions
void	ParseUserList (ttv::json::Value jGroup, std::vector< std::string > &users)

Private Attributes
std::shared_ptr< Result >	mResult
Callback	mCallback
std::string	mChannelName

Member Typedef Documentation

Callback

typedef std::function<void(ChatChannelUsersTask* source, TTV_ErrorCode ec, std::shared_ptr<Result> result)> ttv::chat::ChatChannelUsersTask::Callback

TaskCallback

typedef TTV_TaskCallback ttv::Task::TaskCallback

inherited

Constructor & Destructor Documentation

ChatChannelUsersTask()

ttv::chat::ChatChannelUsersTask::ChatChannelUsersTask	(	const std::string &	channelName,
		Callback	callback
	)

Member Function Documentation

Abort()

virtual void ttv::Task::Abort ( )

virtualinherited

FillHttpRequestInfo()

virtual void ttv::chat::ChatChannelUsersTask::FillHttpRequestInfo ( HttpRequestInfo &  requestInfo )

overrideprotectedvirtual

Implements ttv::HttpTask.

GetTaskName()

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

virtual void ttv::chat::ChatChannelUsersTask::OnComplete ( )

overridevirtual

Reimplemented from ttv::HttpTask.

ParseUserList()

void ttv::chat::ChatChannelUsersTask::ParseUserList ( ttv::json::Value  jGroup, std::vector< std::string > &  users  )

private

ProcessHeaders()

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

overrideprotectedvirtual

Reimplemented from ttv::HttpTask.

ProcessResponse()

virtual void ttv::chat::ChatChannelUsersTask::ProcessResponse ( uint  statusCode, 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::chat::ChatChannelUsersTask::mCallback

private

mChannelName

std::string ttv::chat::ChatChannelUsersTask::mChannelName

private

mResult

std::shared_ptr<Result> ttv::chat::ChatChannelUsersTask::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/chat/chat_common/include/twitchsdk/chat/internal/task/chatchanneluserstask.h