#include <pubsubcomponent.h>

Inheritance diagram for ttv::PubSubComponent< LISTENER >:

Public Types
using	DisposerFunc = std::function< void()>

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

Public Member Functions
	PubSubComponent (const std::shared_ptr< User > &user)

virtual	~PubSubComponent ()=default

virtual void	CompleteShutdown () override

void	SetListener (const std::shared_ptr< LISTENER > &listener)

void	SetDisposer (DisposerFunc &&func)

TTV_ErrorCode	Dispose ()

virtual TTV_ErrorCode	Initialize () override

virtual TTV_ErrorCode	Shutdown () override

virtual std::string	GetLoggerName () const override=0

virtual void	OnTopicSubscribeStateChanged (const std::string &topic, PubSubClient::SubscribeState::Enum state, TTV_ErrorCode ec)=0

virtual void	OnTopicMessageReceived (const std::string &topic, const json::Value &msg)=0

virtual void	OnTopicListenerRemoved (const std::string &topic, TTV_ErrorCode ec)

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

std::shared_ptr< TaskRunner >	GetTaskRunner ()

virtual State	GetState () const override

virtual void	Update () override

Protected Member Functions
virtual bool	CheckShutdown () override

virtual void	AddTopic (const std::string &topic)

virtual TTV_ErrorCode	SubscribeTopics ()

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)

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)

Protected Attributes
std::shared_ptr< LISTENER >	mListener

std::shared_ptr< PubSubClient >	mPubSub

std::shared_ptr< PubSubTopicListener >	mPubSubTopicListener

std::shared_ptr< PubSubTopicListenerHelper >	mPubSubTopicListenerHelper

DisposerFunc	mDisposerFunc

std::vector< std::string >	mPubSubTopics

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

Detailed Description

template<typename LISTENER>
class ttv::PubSubComponent< LISTENER >

Manages listeners for pub-sub updates on a channel

Member Typedef Documentation

◆ DisposerFunc

using ttv::PubSubComponentBase::DisposerFunc = std::function<void()>

inherited

Member Enumeration Documentation

◆ State

enum ttv::IComponent::State

stronginherited

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

Constructor & Destructor Documentation

◆ PubSubComponent()

template<typename LISTENER>

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

inline

◆ ~PubSubComponent()

template<typename LISTENER>

virtual ttv::PubSubComponent< LISTENER >::~PubSubComponent ( )

virtualdefault

Member Function Documentation

◆ AddTopic()

virtual void ttv::PubSubComponentBase::AddTopic ( const std::string & topic )

protectedvirtualinherited

◆ CheckShutdown()

virtual bool ttv::PubSubComponentBase::CheckShutdown ( )

overrideprotectedvirtualinherited

Reimplemented from ttv::Component.

Reimplemented in ttv::ChannelStatus, and ttv::ProfileImageStatus.

◆ CompleteShutdown()

template<typename LISTENER>

virtual void ttv::PubSubComponent< LISTENER >::CompleteShutdown ( )

inlineoverridevirtual

Reimplemented from ttv::PubSubComponentBase.

Reimplemented in ttv::chat::ChatRaid, and ttv::ChannelStatus.

◆ CompleteTask()

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

protectedinherited

◆ Dispose()

TTV_ErrorCode ttv::PubSubComponentBase::Dispose ( )

inherited

◆ GetLoggerName()

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

overridepure virtualinherited

Implements ttv::Component.

Implemented in ttv::chat::ChatRaid, ttv::chat::UserEmoticonSets, ttv::ChannelStatus, ttv::ProfileImageStatus, ttv::chat::BitsStatus, ttv::chat::ChatRoom, ttv::chat::FollowersStatus, ttv::chat::SubscribersStatus, ttv::chat::ChatChannelProperties, ttv::chat::ChatRoomNotifications, and ttv::chat::ChannelChatRoomManager.

◆ 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::PubSubComponentBase::Initialize ( )

overridevirtualinherited

Reimplemented from ttv::UserComponent.

Reimplemented in ttv::chat::BitsStatus, ttv::chat::UserEmoticonSets, and ttv::ChannelStatus.

◆ IsTaskRunning()

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

protectedinherited

◆ Log()

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

protectedinherited

◆ OnTopicListenerRemoved()

virtual void ttv::PubSubComponentBase::OnTopicListenerRemoved	(	const std::string &	topic,
		TTV_ErrorCode	ec
	)

virtualinherited

◆ OnTopicMessageReceived()

virtual void ttv::PubSubComponentBase::OnTopicMessageReceived	(	const std::string &	topic,
		const json::Value &	msg
	)

pure virtualinherited

Implemented in ttv::chat::UserEmoticonSets, ttv::chat::ChatRoom, ttv::chat::ChatRaid, ttv::chat::BitsStatus, ttv::chat::ChannelChatRoomManager, ttv::ChannelStatus, ttv::chat::SubscribersStatus, ttv::ProfileImageStatus, ttv::chat::FollowersStatus, ttv::chat::ChatChannelProperties, and ttv::chat::ChatRoomNotifications.

◆ OnTopicSubscribeStateChanged()

virtual void ttv::PubSubComponentBase::OnTopicSubscribeStateChanged	(	const std::string &	topic,
		PubSubClient::SubscribeState::Enum	state,
		TTV_ErrorCode	ec
	)

pure virtualinherited

Implemented in ttv::chat::ChatRoom, ttv::chat::UserEmoticonSets, ttv::chat::ChatRaid, ttv::chat::BitsStatus, ttv::chat::ChannelChatRoomManager, ttv::ChannelStatus, ttv::chat::SubscribersStatus, ttv::ProfileImageStatus, ttv::chat::FollowersStatus, ttv::chat::ChatChannelProperties, and ttv::chat::ChatRoomNotifications.

◆ OnUserAuthenticationIssue()

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

protectedvirtualinherited

◆ OnUserInfoFetchComplete()

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

protectedvirtualinherited

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

◆ OnUserLogInComplete()

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

protectedvirtualinherited

◆ OnUserLogOutComplete()

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

protectedvirtualinherited

◆ SetClientState()

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

protectedvirtualinherited

◆ SetDisposer()

void ttv::PubSubComponentBase::SetDisposer ( DisposerFunc && func )

inlineinherited

◆ SetListener()

template<typename LISTENER>

void ttv::PubSubComponent< LISTENER >::SetListener ( const std::shared_ptr< LISTENER > & listener )

inline

◆ 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::PubSubComponentBase::Shutdown ( )

overridevirtualinherited

Reimplemented from ttv::Component.

Reimplemented in ttv::chat::BitsStatus, and ttv::chat::UserEmoticonSets.

◆ StartTask()

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

protectedinherited

◆ SubscribeTopics()

virtual TTV_ErrorCode ttv::PubSubComponentBase::SubscribeTopics ( )

protectedvirtualinherited

◆ Update()

virtual void ttv::Component::Update ( )

overridevirtualinherited

Member Data Documentation

◆ mDisposerFunc

DisposerFunc ttv::PubSubComponentBase::mDisposerFunc

protectedinherited

◆ mListener

template<typename LISTENER>

std::shared_ptr<LISTENER> ttv::PubSubComponent< LISTENER >::mListener

protected

◆ mOAuthIssue

bool ttv::UserComponent::mOAuthIssue

protectedinherited

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

◆ mPubSub

std::shared_ptr<PubSubClient> ttv::PubSubComponentBase::mPubSub

protectedinherited

◆ mPubSubTopicListener

std::shared_ptr<PubSubTopicListener> ttv::PubSubComponentBase::mPubSubTopicListener

protectedinherited

◆ mPubSubTopicListenerHelper

std::shared_ptr<PubSubTopicListenerHelper> ttv::PubSubComponentBase::mPubSubTopicListenerHelper

protectedinherited

◆ mPubSubTopics

std::vector<std::string> ttv::PubSubComponentBase::mPubSubTopics

protectedinherited

◆ 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

protectedinherited

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

modules/core/core_common/include/twitchsdk/core/pubsub/pubsubcomponent.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename LISTENER> class ttv::PubSubComponent< LISTENER >

Member Typedef Documentation

◆ DisposerFunc

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ PubSubComponent()

◆ ~PubSubComponent()

Member Function Documentation

◆ AddTopic()

◆ CheckShutdown()

◆ CompleteShutdown()

◆ CompleteTask()

◆ Dispose()

◆ GetLoggerName()

◆ GetState()

◆ GetTaskRunner()

◆ Initialize()

◆ IsTaskRunning()

◆ Log()

◆ OnTopicListenerRemoved()

◆ OnTopicMessageReceived()

◆ OnTopicSubscribeStateChanged()

◆ OnUserAuthenticationIssue()

◆ OnUserInfoFetchComplete()

◆ OnUserLogInComplete()

◆ OnUserLogOutComplete()

◆ SetClientState()

◆ SetDisposer()

◆ SetListener()

◆ SetServerState()

◆ SetState()

◆ SetTaskRunner()

◆ Shutdown()

◆ StartTask()

◆ SubscribeTopics()

◆ Update()

Member Data Documentation

◆ mDisposerFunc

◆ mListener

◆ mOAuthIssue

◆ mPubSub

◆ mPubSubTopicListener

◆ mPubSubTopicListenerHelper

◆ mPubSubTopics

◆ mRunningTasks

◆ mShutdownTimeMilliseconds

◆ mState

◆ mTaskMutex

◆ mTaskRunner

◆ mUser

template<typename LISTENER>
class ttv::PubSubComponent< LISTENER >