Twitch SDK (Internal)
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
ttv::UserComponent Class Referenceabstract

#include <component.h>

Inheritance diagram for ttv::UserComponent:
ttv::Component ttv::IComponent ttv::broadcast::IngestTester ttv::broadcast::Streamer ttv::chat::ChatChannelSet ttv::chat::ChatUserBadges ttv::chat::ChatUserBlockList ttv::chat::ChatUserThread ttv::chat::ChatUserThreads ttv::PubSubClient ttv::PubSubComponentBase ttv::social::FriendList ttv::social::Presence

Classes

class  UserListener
 

Public Types

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

Public Member Functions

 UserComponent (const std::shared_ptr< User > &user)
 
virtual TTV_ErrorCode Initialize () override
 
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 void Update () override
 
virtual TTV_ErrorCode Shutdown () override
 

Protected Member Functions

virtual void OnUserLogInComplete (TTV_ErrorCode ec)
 
virtual void OnUserLogOutComplete (TTV_ErrorCode ec)
 
virtual void OnUserInfoFetchComplete (TTV_ErrorCode ec)
 
virtual void OnUserAuthenticationIssue (std::shared_ptr< const OAuthToken > oauthToken, TTV_ErrorCode ec)
 
virtual void CompleteShutdown () override
 
void Log (TTV_MessageLevel level, const char *format,...)
 
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 ()
 

Protected Attributes

std::weak_ptr< User > mUser
 
bool mOAuthIssue
 Whether or not the internal updates of the component are on hold because of an issue with the OAuth token. More...
 
ClientServerValue< State > mState
 
std::shared_ptr< TaskRunner > mTaskRunner
 
std::vector< std::shared_ptr< Task > > mRunningTasks
 
std::mutex mTaskMutex
 
uint64_t mShutdownTimeMilliseconds
 

Private Attributes

std::shared_ptr< UserListener > mUserListener
 

Member Enumeration Documentation

◆ State

enum ttv::IComponent::State
stronginherited
Enumerator
Uninitialized 
Initialized 
ShuttingDown 
Inert 

The component doesn't require shutting down.

Constructor & Destructor Documentation

◆ UserComponent()

ttv::UserComponent::UserComponent ( const std::shared_ptr< User > &  user)

Member Function Documentation

◆ CheckShutdown()

virtual bool ttv::Component::CheckShutdown ( )
protectedvirtualinherited

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::UserComponent::CompleteShutdown ( )
overrideprotectedvirtual

Reimplemented from ttv::Component.

Reimplemented in ttv::PubSubClient, ttv::broadcast::Streamer, ttv::social::FriendList, ttv::chat::ChatUserThread, ttv::chat::ChatUserThreads, 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::chat::ChatChannelSet, ttv::chat::ChatRaid, ttv::ChannelStatus, and ttv::PubSubComponentBase.

◆ CompleteTask()

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

◆ GetLoggerName()

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

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
overridevirtualinherited

Implements ttv::IComponent.

◆ GetTaskRunner()

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

◆ Initialize()

virtual TTV_ErrorCode ttv::UserComponent::Initialize ( )
overridevirtual

Reimplemented from ttv::Component.

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

◆ IsTaskRunning()

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

◆ Log()

void ttv::UserComponent::Log ( TTV_MessageLevel  level,
const char *  format,
  ... 
)
protected

◆ OnUserAuthenticationIssue()

virtual void ttv::UserComponent::OnUserAuthenticationIssue ( std::shared_ptr< const OAuthToken >  oauthToken,
TTV_ErrorCode  ec 
)
protectedvirtual

◆ OnUserInfoFetchComplete()

virtual void ttv::UserComponent::OnUserInfoFetchComplete ( TTV_ErrorCode  ec)
protectedvirtual

Reimplemented in ttv::social::FriendList, ttv::social::Presence, and ttv::chat::ChatUserThreads.

◆ OnUserLogInComplete()

virtual void ttv::UserComponent::OnUserLogInComplete ( TTV_ErrorCode  ec)
protectedvirtual

◆ OnUserLogOutComplete()

virtual void ttv::UserComponent::OnUserLogOutComplete ( TTV_ErrorCode  ec)
protectedvirtual

◆ SetClientState()

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

◆ SetServerState()

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

◆ SetState()

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

◆ SetTaskRunner()

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

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

◆ Shutdown()

virtual TTV_ErrorCode ttv::Component::Shutdown ( )
overridevirtualinherited

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

◆ Update()

virtual void ttv::Component::Update ( )
overridevirtualinherited

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

◆ mOAuthIssue

bool ttv::UserComponent::mOAuthIssue
protected

Whether or not the internal updates of the component are on hold because of an issue with the OAuth token.

◆ mRunningTasks

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

◆ mShutdownTimeMilliseconds

uint64_t ttv::Component::mShutdownTimeMilliseconds
protectedinherited

◆ mState

ClientServerValue<State> ttv::Component::mState
protectedinherited

◆ mTaskMutex

std::mutex ttv::Component::mTaskMutex
mutableprotectedinherited

◆ mTaskRunner

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

◆ mUser

std::weak_ptr<User> ttv::UserComponent::mUser
protected

◆ mUserListener

std::shared_ptr<UserListener> ttv::UserComponent::mUserListener
private
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.13