ISubscription#

Fully qualified name: carb::events::ISubscription

Defined in carb/events/IEvents.h

class ISubscription : public carb::IObject#

Subscription holder is created by all event listening subscription functions.

Subscription is valid while the holder is alive.

Public Functions

virtual void unsubscribe() = 0#

Unsubscribes the associated IEventListener.

virtual const char *getName() const noexcept = 0#

Returns the name of the subscription.

Note

If a name was not given when the IEventStream subscription function was called, a name is generated based on the address of the IEventListener::onEvent() function.

Returns:

The name of the subscription.

virtual Order getOrder() const noexcept = 0#

Returns the order of the subscription.

Returns:

The order of the subscription.

virtual void setOrder(Order order) noexcept = 0#

Sets the order of the subscription.

Parameters:

order – The order of the subscription.

virtual bool isEnabled() const noexcept = 0#

Returns the enabled state of the subscription.

Returns:

The enabled state of the subscription.

virtual void setEnabled(bool enabled) noexcept = 0#

Sets the enabled state of the subscription.

Parameters:

enabled – The enabled state of the subscription.

virtual size_t addRef() = 0#

Atomically add one to the reference count.

Returns:

The current reference count after one was added, though this value may change before read if other threads are also modifying the reference count. The return value is guaranteed to be non-zero.

virtual size_t release() = 0#

Atomically subtracts one from the reference count.

If the result is zero, carb::deleteHandler() is called for this.

Returns:

The current reference count after one was subtracted. If zero is returned, carb::deleteHandler() was called for this.

Public Static Functions

static inline constexpr carb::InterfaceDesc getInterfaceDesc(

) noexcept#

Returns information about this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns:

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

static inline constexpr carb::InterfaceDesc getLatestInterfaceDesc(

) noexcept#

Returns information about the latest version of this interface.

Auto-generated by CARB_PLUGIN_INTERFACE() or CARB_PLUGIN_INTERFACE_EX.

Returns:

The carb::InterfaceDesc struct with information about the latest version of this interface.