Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::BusInternal::EBusBroadcaster< Bus, Traits > Struct Template Reference

Dispatches an event to all handlers that are connected to an EBus. More...

Inherited by AZ::BusInternal::EBusImpl< Bus, Traits, BusIdType >, and AZ::BusInternal::EBusImpl< Bus, Traits, NullBusId >.

Public Types

using BusPtr
 Pointer to an address on the bus. More...
 

Static Public Member Functions

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...
 

Detailed Description

template<class Bus, class Traits>
struct AZ::BusInternal::EBusBroadcaster< Bus, Traits >

Dispatches an event to all handlers that are connected to an EBus.

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.

Member Typedef Documentation

◆ BusPtr

template<class Bus, class Traits>
using AZ::BusInternal::EBusBroadcaster< Bus, Traits >::BusPtr = typename Traits::BusPtr

Pointer to an address on the bus.

Member Function Documentation

◆ Broadcast()

template<class Bus , class Traits >
template<class Function , class ... InputArgs>
void AZ::BusInternal::EBusBroadcaster< Bus, Traits >::Broadcast ( Function  func,
InputArgs &&...  args 
)
inlinestatic

Dispatches an event to all handlers.

Parameters
funcFunction pointer of the event to dispatch.
argsFunction arguments that are passed to each handler.

◆ BroadcastResult()

template<class Bus , class Traits >
template<class Results , class Function , class ... InputArgs>
void AZ::BusInternal::EBusBroadcaster< Bus, Traits >::BroadcastResult ( Results &  results,
Function  func,
InputArgs &&...  args 
)
inlinestatic

Dispatches an event to all handlers and receives results.

Parameters
[out]resultsReturn value from the event.
funcFunction pointer of the event to dispatch.
argsFunction arguments that are passed to each handler.

◆ BroadcastResultReverse()

template<class Bus , class Traits >
template<class Results , class Function , class ... InputArgs>
void AZ::BusInternal::EBusBroadcaster< Bus, Traits >::BroadcastResultReverse ( Results &  results,
Function  func,
InputArgs &&...  args 
)
inlinestatic

Dispatches an event to all handlers in reverse order and receives results.

Parameters
[out]resultsReturn value from the event.
funcFunction pointer of the event to dispatch.
argsFunction arguments that are passed to each handler.

◆ BroadcastReverse()

template<class Bus , class Traits >
template<class Function , class ... InputArgs>
void AZ::BusInternal::EBusBroadcaster< Bus, Traits >::BroadcastReverse ( Function  func,
InputArgs &&...  args 
)
inlinestatic

Dispatches an event to all handlers in reverse order.

Parameters
funcFunction pointer of the event to dispatch.
argsFunction arguments that are passed to each handler.

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