ledger::core::api::Event Class Reference

#include <Event.hpp>

Inheritance diagram for ledger::core::api::Event:

Public Member Functions
virtual EventCode	getCode ()=0
virtual std::shared_ptr< DynamicObject >	getPayload ()=0
virtual bool	isSticky ()=0
virtual int32_t	getStickyTag ()=0

Static Public Member Functions
static std::shared_ptr< Event >	newInstance (EventCode code, const std::shared_ptr< DynamicObject > &payload)

Detailed Description

Class representing an event.

Member Function Documentation

getCode()

virtual EventCode ledger::core::api::Event::getCode ( )

pure virtual

Get event code (for more details, please refer to EventCode enum).

Returns

EventCode enum entry

Implemented in ledger::core::Event.

getPayload()

virtual std::shared_ptr<DynamicObject> ledger::core::api::Event::getPayload ( )

pure virtual

Get payload of event.

Returns

DynamicObject object

Implemented in ledger::core::Event.

getStickyTag()

virtual int32_t ledger::core::api::Event::getStickyTag ( )

pure virtual

If event is sticky, return sticky tag.

Returns

32 bits integer

Implemented in ledger::core::Event.

isSticky()

virtual bool ledger::core::api::Event::isSticky ( )

pure virtual

Tell whether the event is a sticky one.

Returns

bool

Implemented in ledger::core::Event.

newInstance()

std::shared_ptr< Event > ledger::core::api::Event::newInstance ( EventCode  code, const std::shared_ptr< DynamicObject > &  payload  )

static

Create a new instance of Event class.

Parameters

code,EventCode	enum entry
payload,DynamicObject	object

Returns

Event instance

---

The documentation for this class was generated from the following files:

• src/api/Event.hpp
• src/events/Event.cpp