EBus.h File Reference

#include <AzCore/EBus/BusImpl.h>
#include <AzCore/EBus/Environment.h>
#include <AzCore/EBus/Results.h>
#include <AzCore/EBus/Internal/Debug.h>
#include <AzCore/std/typetraits/typetraits.h>
#include <AzCore/std/smart_ptr/unique_ptr.h>
#include <AzCore/std/containers/unordered_set.h>
#include <AzCore/std/typetraits/is_same.h>
#include <AzCore/std/utils.h>
#include <AzCore/std/parallel/scoped_lock.h>
#include <AzCore/std/parallel/shared_mutex.h>

Classes
struct	AZ::EBusTraits
class	AZ::EBus< Interface, BusTraits >

Namespaces
namespace	AZStd
	AZ namespace needs to be closed in order to specialize the AZStd::hash struct for AddressTypeElement and AddressType.
namespace	AZ
	Reopen namespace to define DataPatch class.

Macros
#define	DEPRECATE_EBUS(_Interface, _BusName, _message)   DEPRECATE_EBUS_WITH_TRAITS(_Interface, _Interface, _BusName, _message)
#define	DEPRECATE_EBUS_WITH_TRAITS(_Interface, _BusTraits, _BusName, _message)
#define	EBUS_EVENT_PTR(_BusPtr, _EBUS, ...)   _EBUS::Event(_BusPtr, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to handlers at a cached address.
#define	EBUS_EVENT_PTR_RESULT(_Result, _BusPtr, _EBUS, ...)   _EBUS::EventResult(_Result, _BusPtr, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to handlers at a cached address and receives results.
#define	EBUS_EVENT_ID(_BusId, _EBUS, ...)   _EBUS::Event(_BusId, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to handlers at a specific address.
#define	EBUS_EVENT_ID_RESULT(_Result, _BusId, _EBUS, ...)   _EBUS::EventResult(_Result, _BusId, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to handlers at a specific address and receives results.
#define	EBUS_EVENT(_EBUS, ...)   _EBUS::Broadcast(&_EBUS::Events::__VA_ARGS__)
	Dispatches an event to all handlers.
#define	EBUS_EVENT_RESULT(_Result, _EBUS, ...)   _EBUS::BroadcastResult(_Result, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to all handlers and receives results.
#define	EBUS_EVENT_PTR_REVERSE(_BusPtr, _EBUS, ...)   _EBUS::EventReverse(_BusPtr, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to handlers at a cached address in reverse order.
#define	EBUS_EVENT_PTR_RESULT_REVERSE(_Result, _BusPtr, _EBUS, ...)   _EBUS::EventResultReverse(_Result, _BusPtr, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to handlers at a cached address in reverse order and receives results.
#define	EBUS_EVENT_ID_REVERSE(_BusId, _EBUS, ...)   _EBUS::EventReverse(_BusId, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to handlers at a specific address in reverse order.
#define	EBUS_EVENT_ID_RESULT_REVERSE(_Result, _BusId, _EBUS, ...)   _EBUS::EventReverse(_Result, _BusId, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to handlers at a specific address in reverse order and receives results.
#define	EBUS_EVENT_REVERSE(_EBUS, ...)   _EBUS::BroadcastReverse(&_EBUS::Events::__VA_ARGS__)
	Dispatches an event to all handlers in reverse order.
#define	EBUS_EVENT_RESULT_REVERSE(_Result, _EBUS, ...)   _EBUS::BroadcastResultReverse(_Result, &_EBUS::Events::__VA_ARGS__)
	Dispatches an event to all handlers in reverse order and receives results.
#define	EBUS_QUEUE_EVENT(_EBUS, ...)   _EBUS::QueueBroadcast(&_EBUS::Events::__VA_ARGS__)
	Enqueues an asynchronous event to dispatch to all handlers.
#define	EBUS_QUEUE_EVENT_PTR(_BusPtr, _EBUS, ...)   _EBUS::QueueEvent(_BusPtr, &_EBUS::Events::__VA_ARGS__)
	Enqueues an asynchronous event to dispatch to handlers at a cached address.
#define	EBUS_QUEUE_EVENT_ID(_BusId, _EBUS, ...)   _EBUS::QueueEvent(_BusId, &_EBUS::Events::__VA_ARGS__)
	Enqueues an asynchronous event to dispatch to handlers at a specific address.
#define	EBUS_QUEUE_EVENT_REVERSE(_EBUS, ...)   _EBUS::QueueBroadcastReverse(&_EBUS::Events::__VA_ARGS__)
	Enqueues an asynchronous event to dispatch to all handlers in reverse order.
#define	EBUS_QUEUE_EVENT_PTR_REVERSE(_BusPtr, _EBUS, ...)   _EBUS::QueueEventReverse(_BusPtr, &_EBUS::Events::__VA_ARGS__)
	Enqueues an asynchronous event to dispatch to handlers at a cached address in reverse order.
#define	EBUS_QUEUE_EVENT_ID_REVERSE(_BusId, _EBUS, ...)   _EBUS::QueueEventReverse(_BusId, &_EBUS::Events::__VA_ARGS__)
	Enqueues an asynchronous event to dispatch to handlers at a specific address in reverse order.
#define	EBUS_QUEUE_FUNCTION(_EBUS, ...)   _EBUS::QueueFunction(__VA_ARGS__)
	Enqueues an arbitrary callable function to be executed asynchronously.
#define	EBUS_DBG_EVENT_PTR(_BusPtr, _EBUS, ...)
	Dispatches an event to handlers at a cached address.
#define	EBUS_DBG_EVENT_PTR_RESULT(_Result, _BusPtr, _EBUS, ...)
	Dispatches an event to handlers at a cached address and receives results.
#define	EBUS_DBG_EVENT_ID(_BusId, _EBUS, ...)
	Dispatches an event to handlers at a specific address.
#define	EBUS_DBG_EVENT_ID_RESULT(_Result, _BusId, _EBUS, ...)
	Dispatches an event to handlers at a specific address and receives results.
#define	EBUS_DBG_EVENT(_EBUS, ...)
	Dispatches an event to all handlers.
#define	EBUS_DBG_EVENT_RESULT(_Result, _EBUS, ...)
	Dispatches an event to all handlers and receives results.
#define	EBUS_DBG_EVENT_PTR_REVERSE(_BusPtr, _EBUS, ...)
	Dispatches an event to handlers at a cached address in reverse order.
#define	EBUS_DBG_EVENT_PTR_RESULT_REVERSE(_Result, _BusPtr, _EBUS, ...)
	Dispatches an event to handlers at a cached address in reverse order and receives results.
#define	EBUS_DBG_EVENT_ID_REVERSE(_BusId, _EBUS, ...)
	Dispatches an event to handlers at a specific address in reverse order.
#define	EBUS_DBG_EVENT_ID_RESULT_REVERSE(_Result, _BusId, _EBUS, ...)
	Dispatches an event to handlers at a specific address in reverse order and receives results.
#define	EBUS_DBG_EVENT_REVERSE(_EBUS, ...)
	Dispatches an event to all handlers in reverse order.
#define	EBUS_DBG_EVENT_RESULT_REVERSE(_Result, _EBUS, ...)
	Dispatches an event to all handlers in reverse order and receives results.
#define	EBUS_DBG_QUEUE_EVENT(_EBUS, ...)
	Enqueues an asynchronous event to dispatch to all handlers.
#define	EBUS_DBG_QUEUE_EVENT_PTR(_BusPtr, _EBUS, ...)
	Enqueues an asynchronous event to dispatch to handlers at a cached address.
#define	EBUS_DBG_QUEUE_EVENT_ID(_BusId, _EBUS, ...)
	Enqueues an asynchronous event to dispatch to handlers at a specific address.
#define	EBUS_DBG_QUEUE_EVENT_REVERSE(_EBUS, ...)
	Enqueues an asynchronous event to dispatch to all handlers in reverse order.
#define	EBUS_DBG_QUEUE_EVENT_PTR_REVERSE(_BusPtr, _EBUS, ...)
	Enqueues an asynchronous event to dispatch to handlers at a cached address in reverse order.
#define	EBUS_DBG_QUEUE_EVENT_ID_REVERSE(_BusId, _EBUS, ...)
	Enqueues an asynchronous event to dispatch to handlers at a specific address in reverse order.
#define	EBUS_DBG_QUEUE_FUNCTION(_EBUS, ...)
	Enqueues an arbitrary callable function to be executed asynchronously.
#define	DECLARE_EBUS_EXTERN_WITH_TRAITS(a, b)
	Externs an EBus class template with both the interface and bus traits arguments.
#define	DECLARE_EBUS_EXTERN(a)
#define	DECLARE_EBUS_INSTANTIATION_WITH_TRAITS(a, b)
	Instantiates an EBus class template with both the interface and bus traits arguments.
#define	DECLARE_EBUS_INSTANTIATION(a)
#define	AZ_DECLARE_EBUS_SINGLE_ADDRESS(_API, a)
#define	AZ_INSTANTIATE_EBUS_SINGLE_ADDRESS(_API, a)
	Explicitly instantiates an EBus which was declared with the function directly above.
#define	AZ_DECLARE_EBUS_MULTI_ADDRESS(_API, a)
#define	AZ_INSTANTIATE_EBUS_MULTI_ADDRESS(_API, a)
	Explicitly instantiates an EBus which was declared with the function directly above.
#define	AZ_DECLARE_EBUS_SINGLE_ADDRESS_WITH_TRAITS(_API, a, b)
#define	AZ_INSTANTIATE_EBUS_SINGLE_ADDRESS_WITH_TRAITS(_API, a, b)
	Explicitly instantiates an EBus which was declared with the function directly above.
#define	AZ_DECLARE_EBUS_MULTI_ADDRESS_WITH_TRAITS(_API, a, b)
#define	AZ_INSTANTIATE_EBUS_MULTI_ADDRESS_WITH_TRAITS(_API, a, b)
	Explicitly instantiates an EBus which was declared with the function directly above.

Detailed Description

Header file for event bus (EBus), a general-purpose communication system that Open 3D Engine uses to dispatch notifications and receive requests. EBuses are configurable and support many different use cases. For more information about EBuses, see AZ::EBus in this guide and Event Bus in the Open 3D Engine Developer Guide.

Macro Definition Documentation

AZ_DECLARE_EBUS_MULTI_ADDRESS

#define AZ_DECLARE_EBUS_MULTI_ADDRESS	(		_API,
			a
	)

Value:

namespace AZ \
{ \
   extern template class _API EBus<a, a>;  \
   extern template class _API Internal::IdHandler<a, a, EBus<a, a>::BusesContainer>; \
   extern template class _API Internal::MultiHandler<a, a, EBus<a, a>::BusesContainer>; \
   extern template struct _API Internal::EBusCallstackStorage<Internal::CallstackEntryBase<a, a>, true>; \
}

Declares an EBus class template, which uses an address policy different from EBusAddressPolicy::Single and is instantiated in a shared library, as extern using only the interface argument for both the EBus Interface and BusTraits template parameters

AZ_DECLARE_EBUS_MULTI_ADDRESS_WITH_TRAITS

#define AZ_DECLARE_EBUS_MULTI_ADDRESS_WITH_TRAITS	(		_API,
			a,
			b
	)

Value:

namespace AZ \
{ \
   extern template class _API EBus<a, b>;  \
   extern template class _API Internal::IdHandler<a, b, EBus<a, b>::BusesContainer>; \
   extern template class _API Internal::MultiHandler<a, b, EBus<a, b>::BusesContainer>; \
   extern template struct _API Internal::EBusCallstackStorage<Internal::CallstackEntryBase<a, b>, true>; \
}

Declares an EBus class template, which uses an address policy different from EBusAddressPolicy::Single and is instantiated in a shared library, as extern with both the interface and bus traits arguments

AZ_DECLARE_EBUS_SINGLE_ADDRESS

#define AZ_DECLARE_EBUS_SINGLE_ADDRESS	(		_API,
			a
	)

Value:

namespace AZ \
{ \
   extern template class _API EBus<a, a>; \
   extern template class _API Internal::NonIdHandler<a, a, EBus<a, a>::BusesContainer>; \
   extern template struct _API Internal::EBusCallstackStorage<Internal::CallstackEntryBase<a, a>, true>; \
}

Declares an EBus class template, which uses EBusAddressPolicy::Single and is instantiated in a shared library, as extern using only the interface argument for both the EBus Interface and BusTraits template parameters

AZ_DECLARE_EBUS_SINGLE_ADDRESS_WITH_TRAITS

#define AZ_DECLARE_EBUS_SINGLE_ADDRESS_WITH_TRAITS	(		_API,
			a,
			b
	)

Value:

namespace AZ \
{ \
   extern template class _API EBus<a, b>;     \
   extern template class _API Internal::NonIdHandler<a, b, EBus<a, b>::BusesContainer>; \
   extern template struct _API Internal::EBusCallstackStorage<Internal::CallstackEntryBase<a, b>, true>; \
}

Declares an EBus class template, which uses EBusAddressPolicy::Single and is instantiated in a shared library, as extern with both the interface and bus traits arguments

AZ_INSTANTIATE_EBUS_MULTI_ADDRESS

#define AZ_INSTANTIATE_EBUS_MULTI_ADDRESS	(		_API,
			a
	)

Value:

namespace AZ \
{ \
   template class AZ_DLL_EXPORT EBus<a, a>; \
   template class AZ_DLL_EXPORT Internal::IdHandler<a, a, EBus<a, a>::BusesContainer>; \
   template class AZ_DLL_EXPORT Internal::MultiHandler<a, a, EBus<a, a>::BusesContainer>; \
   template struct AZ_DLL_EXPORT Internal::EBusCallstackStorage<Internal::CallstackEntryBase<a, a>, true>; \
}

Explicitly instantiates an EBus which was declared with the function directly above.

AZ_INSTANTIATE_EBUS_MULTI_ADDRESS_WITH_TRAITS

#define AZ_INSTANTIATE_EBUS_MULTI_ADDRESS_WITH_TRAITS	(		_API,
			a,
			b
	)

Value:

namespace AZ \
{ \
   template class AZ_DLL_EXPORT EBus<a, b>; \
   template class AZ_DLL_EXPORT Internal::IdHandler<a, b, EBus<a, b>::BusesContainer>; \
   template class AZ_DLL_EXPORT Internal::MultiHandler<a, b, EBus<a, b>::BusesContainer>; \
   template struct AZ_DLL_EXPORT Internal::EBusCallstackStorage<Internal::CallstackEntryBase<a, b>, true>; \
}

Explicitly instantiates an EBus which was declared with the function directly above.

AZ_INSTANTIATE_EBUS_SINGLE_ADDRESS

#define AZ_INSTANTIATE_EBUS_SINGLE_ADDRESS	(		_API,
			a
	)

Value:

namespace AZ \
{ \
   template class AZ_DLL_EXPORT EBus<a, a>; \
   template class AZ_DLL_EXPORT Internal::NonIdHandler<a, a, EBus<a, a>::BusesContainer>; \
   template struct AZ_DLL_EXPORT Internal::EBusCallstackStorage<Internal::CallstackEntryBase<a, a>, true>; \
}

Explicitly instantiates an EBus which was declared with the function directly above.

AZ_INSTANTIATE_EBUS_SINGLE_ADDRESS_WITH_TRAITS

#define AZ_INSTANTIATE_EBUS_SINGLE_ADDRESS_WITH_TRAITS	(		_API,
			a,
			b
	)

Value:

namespace AZ \
{ \
   template class AZ_DLL_EXPORT EBus<a, b>; \
   template class AZ_DLL_EXPORT Internal::NonIdHandler<a, b, EBus<a, b>::BusesContainer>; \
   template struct AZ_DLL_EXPORT Internal::EBusCallstackStorage<Internal::CallstackEntryBase<a, b>, true>; \
}

Explicitly instantiates an EBus which was declared with the function directly above.

DECLARE_EBUS_EXTERN

#define DECLARE_EBUS_EXTERN

(

a

)

Value:

namespace AZ \
{ \
   extern template class EBus<a, a>; \
}

Externs an EBus class template using only the interface argument for both the EBus Interface and BusTraits template parameters

DECLARE_EBUS_EXTERN_WITH_TRAITS

#define DECLARE_EBUS_EXTERN_WITH_TRAITS	(		a,
			b
	)

Value:

namespace AZ \
{ \
   extern template class EBus<a, b>; \
}

Externs an EBus class template with both the interface and bus traits arguments.

DECLARE_EBUS_INSTANTIATION

#define DECLARE_EBUS_INSTANTIATION

(

a

)

Value:

namespace AZ \
{ \
   template class EBus<a, a>; \
}

Instantiates an EBus class template using only the interface argument for both the EBus Interface and BusTraits template parameters

DECLARE_EBUS_INSTANTIATION_WITH_TRAITS

#define DECLARE_EBUS_INSTANTIATION_WITH_TRAITS	(		a,
			b
	)

Value:

namespace AZ \
{ \
   template class EBus<a, b>; \
}

Instantiates an EBus class template with both the interface and bus traits arguments.

DEPRECATE_EBUS

#define DEPRECATE_EBUS	(		_Interface,
			_BusName,
			_message
	)		DEPRECATE_EBUS_WITH_TRAITS(_Interface, _Interface, _BusName, _message)

Helper macro to deprecate the helper typedef EBus<_Interface> _BusName Where _Interface is a deprecated EBus API class

DEPRECATE_EBUS_WITH_TRAITS

#define DEPRECATE_EBUS_WITH_TRAITS	(		_Interface,
			_BusTraits,
			_BusName,
			_message
	)

Value:

    AZ_PUSH_DISABLE_WARNING(4996, "-Wdeprecated-declarations")                          \
    typedef AZ::EBus<_Interface, _BusTraits> DeprecatedBus_##_Interface##_BusTraits;    \
    AZ_POP_DISABLE_WARNING                                                              \
    AZ_DEPRECATED(typedef DeprecatedBus_##_Interface##_BusTraits _BusName, _message);

Helper macro to deprecate the helper typedef EBus<_Interface, _BusTraits> _BusName Where _Interface is a deprecated EBus API class and/or _BusTraits is a deprecated EBusTraits class