sxy::event Interface Reference

Interface of an event. An event has an ID, a name and a priority (for processing by the async state machine). More...

#include <event.hpp>

Inheritance diagram for sxy::event:

Public Member Functions
	event ()
virtual	~event () SX_NOEXCEPT
virtual event_id	get_id () const =0
	Getter of event's ID. More...
virtual std::string	get_name () const =0
	Getter of event's name. More...
virtual event_priority	get_priority () const =0
	Getter of event's priority. More...
virtual bool	operator> (const event &_rhs) const =0
	Method for comparing the priorities between the current event and a given event. More...

Detailed Description

Interface of an event. An event has an ID, a name and a priority (for processing by the async state machine).

Constructor & Destructor Documentation

event()

sxy::event::event ( )

inline

~event()

virtual sxy::event::~event ( )

inlinevirtual

Member Function Documentation

get_id()

virtual event_id sxy::event::get_id ( ) const

pure virtual

Getter of event's ID.

Returns

ID of event.

Implemented in sxy::specialized_event< _concrete_event, _event_id, _event_priority >, sxy::specialized_event< completion_event, Y_COMPLETION_EVENT_ID, sxy::DEFAULT_EVENT_PRIORITY >, and sxy::event_impl.

get_name()

virtual std::string sxy::event::get_name ( ) const

pure virtual

Getter of event's name.

Returns

Name of event.

Implemented in sxy::specialized_event< _concrete_event, _event_id, _event_priority >, sxy::specialized_event< completion_event, Y_COMPLETION_EVENT_ID, sxy::DEFAULT_EVENT_PRIORITY >, and sxy::event_impl.

get_priority()

virtual event_priority sxy::event::get_priority ( ) const

pure virtual

Getter of event's priority.

Returns

Priority of event.

Implemented in sxy::event_impl.

operator>()

virtual bool sxy::event::operator> ( const event &  _rhs ) const

pure virtual

Method for comparing the priorities between the current event and a given event.

Parameters

_rhs	Reference to an event whose priority is compared with the current event's priority.

Returns

True if the current event has a greater priority, else false.

Implemented in sxy::event_impl.

---

The documentation for this interface was generated from the following file:

• event.hpp