api/ListenerAction_8h_source.html

#pragma once


#include <cstdint>


#include "ship/actions/EventAction.h"


namespace Ship {


class Events;


class ListenerAction : public EventAction {

  public:

    ListenerAction(EventID eventId, ListenerID listenerId, EventPriority priority, uint64_t sequence, Events* events,

                   std::shared_ptr<Tickable> tickable, EventCallback callback,

                   EventMetadata metadata = { nullptr, 0, 0 });


    ListenerID GetListenerId() const;

    EventPriority GetPriority() const;

    uint64_t GetSequence() const;

    const EventMetadata& GetMetadata() const;


  protected:

    bool ActionRan() override;


  private:

    Events* mEvents;

    ListenerID mListenerId;

    EventPriority mPriority;

    uint64_t mSequence;

    EventCallback mEventCallback;

    EventMetadata mMetadata;

};


} // namespace Ship

EventAction.h

EventPriority
EventPriority
Priority levels that control listener dispatch order within an event.
Definition EventTypes.h:19

EventID
int32_t EventID
Numeric identifier for an event. -1 is uninitialized, IDs < -1 are internally registered,...
Definition EventTypes.h:8

EventCallback
void(* EventCallback)(IEvent *)
Callback signature for event listeners. The argument is the event payload cast to IEvent*.
Definition EventTypes.h:39

ListenerID
int64_t ListenerID
Numeric identifier for a registered listener; used to unregister later.
Definition EventTypes.h:10

Ship::EventAction
Action specialization for event-driven dispatch.
Definition EventAction.h:46

Ship::Events
Tickable event bus that dispatches listeners through Tick(EventID).
Definition Events.h:74

Ship::ListenerAction
Event-bus listener action executed by Events::Tick(EventID).
Definition ListenerAction.h:22

Ship::ListenerAction::GetMetadata
const EventMetadata & GetMetadata() const
Returns the registration-site metadata recorded for this listener.

Ship::ListenerAction::GetSequence
uint64_t GetSequence() const
Returns the stable registration-order sequence number.

Ship::ListenerAction::ActionRan
bool ActionRan() override
Executes the listener callback against the current Events payload.

Ship::ListenerAction::GetPriority
EventPriority GetPriority() const
Returns the dispatch priority used for ordering listeners.

Ship::ListenerAction::ListenerAction
ListenerAction(EventID eventId, ListenerID listenerId, EventPriority priority, uint64_t sequence, Events *events, std::shared_ptr< Tickable > tickable, EventCallback callback, EventMetadata metadata={ nullptr, 0, 0 })
Constructs a listener action for a single EventID.

Ship::ListenerAction::GetListenerId
ListenerID GetListenerId() const
Returns the event-scoped ListenerID for this action.

Ship
Core namespace for the libultraship engine framework.
Definition gfx_direct3d_common.h:14

EventMetadata
Diagnostic metadata recorded for each unique call site that fires an event.
Definition EventTypes.h:44