ttv::ChannelRepository Class Reference

#include <channelrepository.h>

Inheritance diagram for ttv::ChannelRepository:

Classes
struct	LookupEntry

Public Types
typedef std::function< void(TTV_ErrorCode ec, const ChannelInfo &channelInfo)>	LookupCallback
enum	State { State::Uninitialized, State::Initialized, State::ShuttingDown, State::Inert }

Public Member Functions
	ChannelRepository ()
TTV_ErrorCode	FetchChannelInfo (ChannelId channelId, LookupCallback callback)
TTV_ErrorCode	GetChannelInfo (ChannelId channelId, ChannelInfo &result)
TTV_ErrorCode	CacheChannelInfo (const ChannelInfo &channelInfo)
virtual void	Update () override
virtual TTV_ErrorCode	Shutdown () override
virtual std::string	GetLoggerName () const override
virtual void	SetTaskRunner (std::shared_ptr< TaskRunner > taskRunner)
std::shared_ptr< TaskRunner >	GetTaskRunner ()
virtual State	GetState () const override
virtual TTV_ErrorCode	Initialize () override

Protected Member Functions
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
ClientServerValue< State >	mState
std::shared_ptr< TaskRunner >	mTaskRunner
std::vector< std::shared_ptr< Task > >	mRunningTasks
std::mutex	mTaskMutex
uint64_t	mShutdownTimeMilliseconds

Private Member Functions
virtual bool	CheckShutdown () override
virtual void	CompleteShutdown () override
TTV_ErrorCode	ScheduleLookup ()
void	CompleteLookup (ChannelId channelId, const ChannelInfo &channelInfo, TTV_ErrorCode ec)

Private Attributes
std::shared_ptr< ttv::IMutex >	mMutex
Cache< ChannelId, ChannelInfo >	mChannelInfoCache
std::vector< LookupEntry >	mPendingChannelInfoLookups
bool	mLookupInProgress

---

Class Documentation

ttv::ChannelRepository::LookupEntry

struct ttv::ChannelRepository::LookupEntry

Class Members
LookupCallback	callback
ChannelId	channelId
shared_ptr< GetChannelTask >	task

Member Typedef Documentation

LookupCallback

typedef std::function<void(TTV_ErrorCode ec, const ChannelInfo& channelInfo)> ttv::ChannelRepository::LookupCallback

Member Enumeration Documentation

State

enum ttv::IComponent::State

stronginherited

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

Constructor & Destructor Documentation

ChannelRepository()

ttv::ChannelRepository::ChannelRepository

(

)

Member Function Documentation

CacheChannelInfo()

TTV_ErrorCode ttv::ChannelRepository::CacheChannelInfo

(

const ChannelInfo &

channelInfo

)

CheckShutdown()

virtual bool ttv::ChannelRepository::CheckShutdown ( )

overrideprivatevirtual

Reimplemented from ttv::Component.

CompleteLookup()

void ttv::ChannelRepository::CompleteLookup ( ChannelId  channelId, const ChannelInfo &  channelInfo, TTV_ErrorCode  ec  )

private

CompleteShutdown()

virtual void ttv::ChannelRepository::CompleteShutdown ( )

overrideprivatevirtual

Reimplemented from ttv::Component.

CompleteTask()

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

protectedinherited

FetchChannelInfo()

TTV_ErrorCode ttv::ChannelRepository::FetchChannelInfo	(	ChannelId	channelId,
		LookupCallback	callback
	)

Returns cached channel info or fetches if needed.

GetChannelInfo()

TTV_ErrorCode ttv::ChannelRepository::GetChannelInfo	(	ChannelId	channelId,
		ChannelInfo &	result
	)

Returns cached channel info or TTV_EC_NOT_AVAILABLE if not yet fetched.

GetLoggerName()

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

overridevirtual

Implements ttv::Component.

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

overridevirtualinherited

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

protectedinherited

ScheduleLookup()

TTV_ErrorCode ttv::ChannelRepository::ScheduleLookup ( )

private

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

overridevirtual

Reimplemented from ttv::Component.

StartTask()

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

protectedinherited

Update()

virtual void ttv::ChannelRepository::Update ( )

overridevirtual

Reimplemented from ttv::Component.

Member Data Documentation

mChannelInfoCache

Cache<ChannelId, ChannelInfo> ttv::ChannelRepository::mChannelInfoCache

private

mLookupInProgress

bool ttv::ChannelRepository::mLookupInProgress

private

mMutex

std::shared_ptr<ttv::IMutex> ttv::ChannelRepository::mMutex

private

mPendingChannelInfoLookups

std::vector<LookupEntry> ttv::ChannelRepository::mPendingChannelInfoLookups

private

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

---

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

• modules/core/core_common/include/twitchsdk/core/channel/channelrepository.h