Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::BusInternal::EBusImpl< Bus, Traits, NullBusId > Struct Template Reference

Base class that provides eventing, queueing, and enumeration functionality for EBuses that dispatch events to all of their handlers. More...

Inherits AZ::BusInternal::EBusBroadcaster< Bus, Traits >, AZ::BusInternal::EBusBroadcastEnumerator< Bus, Traits >, and type< Traits::EnableEventQueue, EBusBroadcastQueue< Bus, Traits >, EBusNullQueue >.

Additional Inherited Members

- Public Types inherited from AZ::BusInternal::EBusBroadcaster< Bus, Traits >
using BusPtr = typename Traits::BusPtr
 Pointer to an address on the bus. More...
 
- Static Public Member Functions inherited from AZ::BusInternal::EBusBroadcaster< Bus, Traits >
template<class Function , class ... InputArgs>
static void Broadcast (Function func, InputArgs &&... args)
 Dispatches an event to all handlers. More...
 
template<class Results , class Function , class ... InputArgs>
static void BroadcastResult (Results &results, Function func, InputArgs &&... args)
 Dispatches an event to all handlers and receives results. More...
 
template<class Function , class ... InputArgs>
static void BroadcastReverse (Function func, InputArgs &&... args)
 Dispatches an event to all handlers in reverse order. More...
 
template<class Results , class Function , class ... InputArgs>
static void BroadcastResultReverse (Results &results, Function func, InputArgs &&... args)
 Dispatches an event to all handlers in reverse order and receives results. More...
 
- Static Public Member Functions inherited from AZ::BusInternal::EBusBroadcastEnumerator< Bus, Traits >
template<class Callback >
static void EnumerateHandlers (Callback callback)
 Calls a user-defined function on all handlers that are connected to the EBus. More...
 
static Traits::InterfaceType * FindFirstHandler ()
 Finds the first handler that is connected to the EBus. More...
 

Detailed Description

template<class Bus, class Traits>
struct AZ::BusInternal::EBusImpl< Bus, Traits, NullBusId >

Base class that provides eventing, queueing, and enumeration functionality for EBuses that dispatch events to all of their handlers.

For a base class that can access handlers at specific addresses, use EBusImpl.

Template Parameters
BusThe EBus type.
TraitsA class that inherits from EBusTraits and configures the EBus. This parameter may be left unspecified if the Interface class inherits from EBusTraits.

The documentation for this struct was generated from the following file:
  • C:/lumberyard-root/dev/Code/Framework/AzCore/AzCore/EBus/BusImpl.h