carb::events::IEvents

Defined in carb/events/IEvents.h

struct IEvents

Interface definition for carb.events.

Public Functions

inline IEventStreamPtr createEventStream(const char *name = nullptr) noexcept

Create new event stream.

Parameters

name – An optional name to give the event stream for logging and profiling.

Returns

A pointer to the new event stream.

virtual IEventStream *createEventStreamPtr() = 0

Create new event stream.

  • Deprecated since version ``carb::events::IEvents::internalCreateEventStream``: instead.

Returns

A pointer to the new event stream.

virtual SenderId acquireUniqueSenderId() = 0

Get a unique sender identifier.

Note

The sender identifier may be a previously released sender identifier.

Returns

A unique sender identifier. When finished with the sender identifier, it should be returned with releaseUniqueSenderId().

virtual void releaseUniqueSenderId(SenderId senderId) = 0

Releases a unique sender identifier previously acquired with acquireUniqueSenderId().

Parameters

senderId – The previously acquired senderId.

Public Static Functions

static inline constexpr carb::InterfaceDesc getInterfaceDesc()

  • Returns information about this interface. Auto-generated by CARB_PLUGIN_INTERFACE(). *

Returns

The carb::InterfaceDesc struct with information about this interface.