ttv::Component Class Reference

#include <component.h>

Inheritance diagram for ttv::Component:

Public Types
enum	State { State::Uninitialized, State::Initialized, State::ShuttingDown, State::Inert }

Public Member Functions
virtual	~Component ()
virtual std::string	GetLoggerName () const =0
virtual void	SetTaskRunner (std::shared_ptr< TaskRunner > taskRunner)
std::shared_ptr< TaskRunner >	GetTaskRunner ()
virtual State	GetState () const override
virtual TTV_ErrorCode	Initialize () override
virtual void	Update () override
virtual TTV_ErrorCode	Shutdown () override

Protected Member Functions
	Component ()
TTV_ErrorCode	StartTask (std::shared_ptr< Task > task)
void	CompleteTask (Task *task)
bool	IsTaskRunning (Task *task) const
virtual void	SetState (State state)
virtual void	SetClientState (State state)
virtual void	SetServerState (State state)
virtual bool	CheckShutdown ()
virtual void	CompleteShutdown ()

Protected Attributes
ClientServerValue< State >	mState
std::shared_ptr< TaskRunner >	mTaskRunner
std::vector< std::shared_ptr< Task > >	mRunningTasks
std::mutex	mTaskMutex
uint64_t	mShutdownTimeMilliseconds

Member Enumeration Documentation

State

enum ttv::IComponent::State

stronginherited

Enumerator
Uninitialized
Initialized
ShuttingDown
Inert	The component doesn't require shutting down.

Constructor & Destructor Documentation

Component()

ttv::Component::Component ( )

protected

~Component()

virtual ttv::Component::~Component ( )

virtual

Member Function Documentation

CheckShutdown()

virtual bool ttv::Component::CheckShutdown ( )

protectedvirtual

Reimplemented in ttv::PubSubClient, ttv::ComponentContainer, ttv::broadcast::Streamer, ttv::social::FriendList, ttv::chat::ChatUserThreads, ttv::UserRepository, ttv::social::Presence, ttv::broadcast::IngestTester, ttv::User, ttv::chat::ChatChannelSet, ttv::chat::BitsConfigRepository, ttv::chat::ChatUserBlockList, ttv::ChannelRepository, ttv::ChannelStatus, ttv::PubSubComponentBase, and ttv::ProfileImageStatus.

CompleteShutdown()

virtual void ttv::Component::CompleteShutdown ( )

protectedvirtual

Reimplemented in ttv::PubSubClient, ttv::ComponentContainer, ttv::broadcast::Streamer, ttv::social::FriendList, ttv::chat::ChatUserThread, ttv::chat::ChatUserThreads, ttv::UserComponent, ttv::UserRepository, ttv::social::Presence, ttv::PubSubComponent< LISTENER >, ttv::PubSubComponent< IChatChannelPropertyListener >, ttv::PubSubComponent< IChannelChatRoomManagerListener >, ttv::PubSubComponent< IChannelListener >, ttv::PubSubComponent< IFollowersListener >, ttv::PubSubComponent< IChatRoomListener >, ttv::PubSubComponent< UserEmoticonSetsListener >, ttv::PubSubComponent< IChatRaidListener >, ttv::PubSubComponent< IBitsListener >, ttv::PubSubComponent< IChatRoomNotificationsListener >, ttv::PubSubComponent< ISubscribersListener >, ttv::broadcast::IngestTester, ttv::User, ttv::chat::ChatChannelSet, ttv::chat::BitsConfigRepository, ttv::chat::ChatRaid, ttv::ChannelRepository, ttv::chat::ChatReplay, ttv::ChannelStatus, and ttv::PubSubComponentBase.

CompleteTask()

void ttv::Component::CompleteTask ( Task *  task )

protected

GetLoggerName()

virtual std::string ttv::Component::GetLoggerName ( ) const

pure virtual

Implemented in ttv::PubSubClient, ttv::broadcast::Streamer, ttv::ComponentContainer, ttv::social::FriendList, ttv::chat::ChatUserThread, ttv::UserRepository, ttv::social::Presence, ttv::broadcast::IngestTester, ttv::User, ttv::chat::ChatUserThreads, ttv::chat::ChatChannelSet, ttv::chat::BitsConfigRepository, ttv::chat::ChatUserBlockList, ttv::chat::ChatReplay, ttv::chat::ChatAPITaskHost, ttv::ChannelRepository, ttv::chat::ChatRaid, ttv::chat::UserEmoticonSets, ttv::ChannelStatus, ttv::ProfileImageStatus, ttv::PubSubComponentBase, ttv::chat::BitsStatus, ttv::broadcast::TwitchAPI, ttv::chat::ChatRoom, ttv::chat::FollowersStatus, ttv::chat::SubscribersStatus, ttv::chat::ChatChannelProperties, ttv::chat::ChatRoomNotifications, ttv::chat::ChannelChatRoomManager, and ttv::chat::ChatUserBadges.

GetState()

virtual State ttv::Component::GetState ( ) const

overridevirtual

Implements ttv::IComponent.

GetTaskRunner()

std::shared_ptr<TaskRunner> ttv::Component::GetTaskRunner ( )

inline

Initialize()

virtual TTV_ErrorCode ttv::Component::Initialize ( )

overridevirtual

Implements ttv::IComponent.

Reimplemented in ttv::broadcast::Streamer, ttv::PubSubClient, ttv::ComponentContainer, ttv::UserComponent, ttv::UserRepository, ttv::social::FriendList, ttv::broadcast::IngestTester, ttv::User, ttv::chat::ChatUserThreads, ttv::social::Presence, ttv::chat::ChatReplay, ttv::chat::BitsStatus, ttv::chat::UserEmoticonSets, ttv::ChannelStatus, and ttv::PubSubComponentBase.

IsTaskRunning()

bool ttv::Component::IsTaskRunning ( Task *  task ) const

protected

SetClientState()

virtual void ttv::Component::SetClientState ( State  state )

protectedvirtual

SetServerState()

virtual void ttv::Component::SetServerState ( State  state )

protectedvirtual

SetState()

virtual void ttv::Component::SetState ( State  state )

protectedvirtual

SetTaskRunner()

virtual void ttv::Component::SetTaskRunner ( std::shared_ptr< TaskRunner >  taskRunner )

virtual

Reimplemented in ttv::broadcast::Streamer, and ttv::social::FriendList.

Shutdown()

virtual TTV_ErrorCode ttv::Component::Shutdown ( )

overridevirtual

Implements ttv::IComponent.

Reimplemented in ttv::PubSubClient, ttv::broadcast::Streamer, ttv::ComponentContainer, ttv::social::FriendList, ttv::UserRepository, ttv::social::Presence, ttv::broadcast::IngestTester, ttv::User, ttv::chat::ChatUserThreads, ttv::chat::BitsConfigRepository, ttv::chat::ChatUserBlockList, ttv::chat::ChatReplay, ttv::chat::ChatChannelSet, ttv::ChannelRepository, ttv::chat::BitsStatus, ttv::chat::UserEmoticonSets, and ttv::PubSubComponentBase.

StartTask()

TTV_ErrorCode ttv::Component::StartTask ( std::shared_ptr< Task >  task )

protected

Update()

virtual void ttv::Component::Update ( )

overridevirtual

Implements ttv::IComponent.

Reimplemented in ttv::PubSubClient, ttv::broadcast::Streamer, ttv::ComponentContainer, ttv::social::FriendList, ttv::chat::ChatUserThread, ttv::UserRepository, ttv::social::Presence, ttv::broadcast::IngestTester, ttv::User, ttv::chat::ChatUserThreads, ttv::chat::BitsConfigRepository, ttv::chat::ChatUserBlockList, ttv::chat::ChatReplay, ttv::chat::ChatChannelSet, ttv::ChannelRepository, ttv::chat::ChatRaid, ttv::chat::BitsStatus, ttv::chat::UserEmoticonSets, ttv::ChannelStatus, ttv::chat::ChatRoom, and ttv::ProfileImageStatus.

Member Data Documentation

mRunningTasks

std::vector<std::shared_ptr<Task> > ttv::Component::mRunningTasks

protected

mShutdownTimeMilliseconds

uint64_t ttv::Component::mShutdownTimeMilliseconds

protected

mState

ClientServerValue<State> ttv::Component::mState

protected

mTaskMutex

std::mutex ttv::Component::mTaskMutex

mutableprotected

mTaskRunner

std::shared_ptr<TaskRunner> ttv::Component::mTaskRunner

protected

---

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

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