ANNOUNCEMENT::CAnnouncementManager Class Reference

#include <AnnouncementManager.h>

Inheritance diagram for ANNOUNCEMENT::CAnnouncementManager:

Classes
struct	CAnnounceData

Public Member Functions
	CAnnouncementManager ()
	~CAnnouncementManager () override
void	Start ()
void	Deinitialize ()
void	AddAnnouncer (IAnnouncer *listener)
void	RemoveAnnouncer (IAnnouncer *listener)
void	Announce (AnnouncementFlag flag, const std::string &message)
void	Announce (AnnouncementFlag flag, const std::string &message, const CVariant &data)
void	Announce (AnnouncementFlag flag, const std::string &message, const std::shared_ptr< const CFileItem > &item)
void	Announce (AnnouncementFlag flag, const std::string &message, const std::shared_ptr< const CFileItem > &item, const CVariant &data)
void	Announce (AnnouncementFlag flag, const std::string &sender, const std::string &message)
void	Announce (AnnouncementFlag flag, const std::string &sender, const std::string &message, const CVariant &data)
void	Announce (AnnouncementFlag flag, const std::string &sender, const std::string &message, const std::shared_ptr< const CFileItem > &item, const CVariant &data)
Public Member Functions inherited from CThread
	CThread (IRunnable *pRunnable, const char *ThreadName)
virtual	~CThread ()
void	Create (bool bAutoDelete=false)
template<typename Rep , typename Period >
void	Sleep (std::chrono::duration< Rep, Period > duration)
bool	IsAutoDelete () const
virtual void	StopThread (bool bWait=true)
bool	IsRunning () const
bool	IsCurrentThread () const
bool	Join (std::chrono::milliseconds duration)
bool	SetPriority (const ThreadPriority &priority)
	Set the threads priority. This uses the platforms native threading library to do so.
virtual void	OnException ()

Static Public Attributes
static const std::string	ANNOUNCEMENT_SENDER = "xbmc"

Protected Member Functions
void	Process () override
void	DoAnnounce (AnnouncementFlag flag, const std::string &sender, const std::string &message, const std::shared_ptr< CFileItem > &item, const CVariant &data)
void	DoAnnounce (AnnouncementFlag flag, const std::string &sender, const std::string &message, const CVariant &data)
Protected Member Functions inherited from CThread
	CThread (const char *ThreadName)
virtual void	OnStartup ()
virtual void	OnExit ()
WaitResponse	AbortableWait (CEvent &event, std::chrono::milliseconds duration=std::chrono::milliseconds(-1))

Protected Attributes
std::list< CAnnounceData >	m_announcementQueue
CEvent	m_queueEvent
Protected Attributes inherited from CThread
std::atomic< bool >	m_bStop

Additional Inherited Members
Static Public Member Functions inherited from CThread
static const std::thread::id	GetCurrentThreadId ()
static CThread *	GetCurrentThread ()
Protected Types inherited from CThread
enum	WaitResponse { WAIT_INTERRUPTED = -1 , WAIT_SIGNALED = 0 , WAIT_TIMEDOUT = 1 }

Constructor & Destructor Documentation

CAnnouncementManager()

CAnnouncementManager::CAnnouncementManager

(

)

~CAnnouncementManager()

CAnnouncementManager::~CAnnouncementManager ( )

override

Member Function Documentation

AddAnnouncer()

void CAnnouncementManager::AddAnnouncer

(

IAnnouncer *

listener

)

Announce() [1/7]

void CAnnouncementManager::Announce	(	AnnouncementFlag	flag,
		const std::string &	message )

Announce() [2/7]

void CAnnouncementManager::Announce	(	AnnouncementFlag	flag,
		const std::string &	message,
		const CVariant &	data )

Announce() [3/7]

void CAnnouncementManager::Announce	(	AnnouncementFlag	flag,
		const std::string &	message,
		const std::shared_ptr< const CFileItem > &	item )

Announce() [4/7]

void CAnnouncementManager::Announce	(	AnnouncementFlag	flag,
		const std::string &	message,
		const std::shared_ptr< const CFileItem > &	item,
		const CVariant &	data )

Announce() [5/7]

void CAnnouncementManager::Announce	(	AnnouncementFlag	flag,
		const std::string &	sender,
		const std::string &	message )

Announce() [6/7]

void CAnnouncementManager::Announce	(	AnnouncementFlag	flag,
		const std::string &	sender,
		const std::string &	message,
		const CVariant &	data )

Announce() [7/7]

void CAnnouncementManager::Announce	(	AnnouncementFlag	flag,
		const std::string &	sender,
		const std::string &	message,
		const std::shared_ptr< const CFileItem > &	item,
		const CVariant &	data )

Deinitialize()

void CAnnouncementManager::Deinitialize

(

)

DoAnnounce() [1/2]

void CAnnouncementManager::DoAnnounce ( AnnouncementFlag flag, const std::string & sender, const std::string & message, const CVariant & data )

protected

DoAnnounce() [2/2]

void CAnnouncementManager::DoAnnounce ( AnnouncementFlag flag, const std::string & sender, const std::string & message, const std::shared_ptr< CFileItem > & item, const CVariant & data )

protected

Todo

Can be removed once this is properly handled when starting playback of a file

Todo

Can be removed once this is properly handled when starting playback of a file

Todo

Can be removed once this is properly handled when starting playback of a file

Todo

Can be removed once this is properly handled when starting playback of a file

Process()

void CAnnouncementManager::Process ( void )

overrideprotectedvirtual

Reimplemented from CThread.

RemoveAnnouncer()

void CAnnouncementManager::RemoveAnnouncer

(

IAnnouncer *

listener

)

Start()

void CAnnouncementManager::Start

(

)

Member Data Documentation

ANNOUNCEMENT_SENDER

const std::string CAnnouncementManager::ANNOUNCEMENT_SENDER = "xbmc"

static

m_announcementQueue

std::list<CAnnounceData> ANNOUNCEMENT::CAnnouncementManager::m_announcementQueue

protected

m_queueEvent

CEvent ANNOUNCEMENT::CAnnouncementManager::m_queueEvent

protected

---

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

• AnnouncementManager.h
• AnnouncementManager.cpp