An event broadcasting class. More...

#include "lldb/Utility/Broadcaster.h"

Inheritance diagram for lldb_private::Broadcaster:

[legend]

Classes
class	BroadcasterImpl
	BroadcasterImpl contains the actual Broadcaster implementation. More...

Public Member Functions
	Broadcaster (lldb::BroadcasterManagerSP manager_sp, std::string name)
	Construct with a broadcaster with a name.

virtual	~Broadcaster ()
	Destructor.

void	CheckInWithManager ()

void	BroadcastEvent (lldb::EventSP &event_sp)
	Broadcast an event which has no associated data.

void	BroadcastEventIfUnique (lldb::EventSP &event_sp)

void	BroadcastEvent (uint32_t event_type, const lldb::EventDataSP &event_data_sp)

void	BroadcastEvent (uint32_t event_type)

void	BroadcastEventIfUnique (uint32_t event_type)

void	Clear ()

virtual void	AddInitialEventsToListener (const lldb::ListenerSP &listener_sp, uint32_t requested_events)

uint32_t	AddListener (const lldb::ListenerSP &listener_sp, uint32_t event_mask)
	Listen for any events specified by event_mask.

const std::string &	GetBroadcasterName ()
	Get this broadcaster's name.

bool	GetEventNames (Stream &s, const uint32_t event_mask, bool prefix_with_broadcaster_name) const
	Get the event name(s) for one or more event bits.

void	SetEventName (uint32_t event_mask, const char *name)
	Set the name for an event bit.

const char *	GetEventName (uint32_t event_mask) const

bool	EventTypeHasListeners (uint32_t event_type)

bool	RemoveListener (const lldb::ListenerSP &listener_sp, uint32_t event_mask=UINT32_MAX)
	Removes a Listener from this broadcasters list and frees the event bits specified by event_mask that were previously acquired by listener (assuming listener was listening to this object) for other listener objects to use.

bool	HijackBroadcaster (const lldb::ListenerSP &listener_sp, uint32_t event_mask=UINT32_MAX)
	Provides a simple mechanism to temporarily redirect events from broadcaster.

bool	IsHijackedForEvent (uint32_t event_mask)

void	RestoreBroadcaster ()
	Restore the state of the Broadcaster from a previous hijack attempt.

virtual llvm::StringRef	GetBroadcasterClass () const
	This needs to be filled in if you are going to register the broadcaster with the broadcaster manager and do broadcaster class matching.

lldb::BroadcasterManagerSP	GetManager ()

void	SetPrimaryListener (lldb::ListenerSP listener_sp)

lldb::ListenerSP	GetPrimaryListener ()

Protected Types
typedef std::shared_ptr< BroadcasterImpl >	BroadcasterImplSP

typedef std::weak_ptr< BroadcasterImpl >	BroadcasterImplWP

Protected Member Functions
BroadcasterImplSP	GetBroadcasterImpl ()

const char *	GetHijackingListenerName ()

Private Member Functions
	Broadcaster (const Broadcaster &)=delete

const Broadcaster &	operator= (const Broadcaster &)=delete

Private Attributes
BroadcasterImplSP	m_broadcaster_sp

lldb::BroadcasterManagerSP	m_manager_sp

const std::string	m_broadcaster_name
	The name of this broadcaster object.

Friends
class	Listener

class	Event

Detailed Description

An event broadcasting class.

The Broadcaster class is designed to be subclassed by objects that wish to vend events in a multi-threaded environment. Broadcaster objects can each vend 32 events. Each event is represented by a bit in a 32 bit value and these bits can be set:

See also: Broadcaster::SetEventBits(uint32_t) or cleared:; Broadcaster::ResetEventBits(uint32_t) When an event gets set the Broadcaster object will notify the Listener object that is listening for the event (if there is one).

Subclasses should provide broadcast bit definitions for any events they vend, typically using an enumeration:

class Foo : public Broadcaster
{
public:
// Broadcaster event bits definitions.
enum
{
    eBroadcastBitOne   = (1 << 0),
    eBroadcastBitTwo   = (1 << 1),
    eBroadcastBitThree = (1 << 2),
    ...
};

Definition at line 146 of file Broadcaster.h.

Member Typedef Documentation

◆ BroadcasterImplSP

typedef std::shared_ptr<BroadcasterImpl> lldb_private::Broadcaster::BroadcasterImplSP

protected

Definition at line 464 of file Broadcaster.h.

◆ BroadcasterImplWP

typedef std::weak_ptr<BroadcasterImpl> lldb_private::Broadcaster::BroadcasterImplWP

protected

Definition at line 465 of file Broadcaster.h.

Constructor & Destructor Documentation

◆ Broadcaster() [1/2]

Broadcaster::Broadcaster	(	lldb::BroadcasterManagerSP	manager_sp,
		std::string	name
	)

Construct with a broadcaster with a name.

Parameters

[in]	manager_sp	A shared pointer to the BroadcasterManager that will manage this broadcaster.
[in]	name	A std::string of the name that this broadcaster will have.

Definition at line 26 of file Broadcaster.cpp.

References GetBroadcasterName(), lldb_private::GetLog(), LLDB_LOG, and lldb_private::Object.

◆ ~Broadcaster()

Broadcaster::~Broadcaster ( )

virtual

Destructor.

The destructor is virtual since this class gets subclassed.

Definition at line 38 of file Broadcaster.cpp.

References Clear(), GetBroadcasterName(), lldb_private::GetLog(), LLDB_LOG, and lldb_private::Object.

◆ Broadcaster() [2/2]

lldb_private::Broadcaster::Broadcaster ( const Broadcaster & )

privatedelete

Member Function Documentation

◆ AddInitialEventsToListener()

void Broadcaster::AddInitialEventsToListener	(	const lldb::ListenerSP &	listener_sp,
		uint32_t	requested_events
	)

virtual

Definition at line 131 of file Broadcaster.cpp.

Referenced by lldb::SBBroadcaster::AddInitialEventsToListener().

◆ AddListener()

uint32_t lldb_private::Broadcaster::AddListener	(	const lldb::ListenerSP &	listener_sp,
		uint32_t	event_mask
	)

inline

Listen for any events specified by event_mask.

Only one listener can listen to each event bit in a given Broadcaster. Once a listener has acquired an event bit, no other broadcaster will have access to it until it is relinquished by the first listener that gets it. The actual event bits that get acquired by listener may be different from what is requested in event_mask, and to track this the actual event bits that are acquired get returned.

Parameters

[in]	listener_sp	The Listener object that wants to monitor the events that get broadcast by this object.
[in]	event_mask	A bit mask that indicates which events the listener is asking to monitor.

Returns: The actual event bits that were acquired by listener.

Definition at line 213 of file Broadcaster.h.

[in]	listener_sp	A Listener object. You do not need to call StartListeningForEvents for this broadcaster (that would fail anyway since the event bits would most likely be taken by the listener(s) you are usurping.
[in]	event_mask	The event bits listener wishes to hijack.

[in]	listener_sp	A Listener object that previously called AddListener.
[in]	event_mask	The event bits listener wishes to relinquish.

Classes

Public Member Functions

Protected Types

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ BroadcasterImplSP

◆ BroadcasterImplWP

Constructor & Destructor Documentation

◆ Broadcaster() [1/2]

◆ ~Broadcaster()

◆ Broadcaster() [2/2]

Member Function Documentation

◆ AddInitialEventsToListener()

◆ AddListener()

◆ BroadcastEvent() [1/3]

◆ BroadcastEvent() [2/3]

◆ BroadcastEvent() [3/3]

◆ BroadcastEventIfUnique() [1/2]

◆ BroadcastEventIfUnique() [2/2]

◆ CheckInWithManager()

◆ Clear()

◆ EventTypeHasListeners()

◆ GetBroadcasterClass()

◆ GetBroadcasterImpl()

◆ GetBroadcasterName()

◆ GetEventName()

◆ GetEventNames()

◆ GetHijackingListenerName()

◆ GetManager()

◆ GetPrimaryListener()

◆ HijackBroadcaster()

◆ IsHijackedForEvent()

◆ operator=()

◆ RemoveListener()

◆ RestoreBroadcaster()

◆ SetEventName()

◆ SetPrimaryListener()

Friends And Related Function Documentation

◆ Event

◆ Listener

Member Data Documentation

◆ m_broadcaster_name

◆ m_broadcaster_sp

◆ m_manager_sp