Realm
A distributed, event-based tasking library
Loading...
Searching...
No Matches
PRealm::UserEvent Class Reference

#include <prealm.h>

Inheritance diagram for PRealm::UserEvent:
[legend]
Collaboration diagram for PRealm::UserEvent:
[legend]

Public Member Functions

 UserEvent (void)
 UserEvent (::realm_id_t i)
 UserEvent (const Realm::UserEvent &e)
 UserEvent (const UserEvent &rhs)=default
 UserEvent (UserEvent &&rhs)=default
UserEvent & operator= (const Realm::UserEvent &e)
UserEvent & operator= (const UserEvent &rhs)=default
UserEvent & operator= (UserEvent &&rhs)=default
void trigger (Event wait_on=Event::NO_EVENT, bool ignore_faults=false) const
void cancel (void) const
Public Member Functions inherited from PRealm::Event
 Event (void)
 Event (::realm_id_t i)
 Event (const Realm::Event &e)
 Event (const Event &rhs)=default
 Event (Event &&rhs)=default
Event & operator= (const Realm::Event &e)
Event & operator= (const Event &e)=default
Event & operator= (Event &&rhs)=default
bool is_barrier (void) const
void wait (void) const
void wait_faultaware (bool &poisoned) const
Public Member Functions inherited from Realm::Event
 Event ()=default
constexpr Event (id_t id)
constexpr operator id_t () const
bool operator< (const Event &rhs) const
bool operator== (const Event &rhs) const
bool operator!= (const Event &rhs) const
bool exists (void) const
bool has_triggered (void) const
void wait (void) const
void external_wait (void) const
bool external_timedwait (long long max_ns) const
bool has_triggered_faultaware (bool &poisoned) const
void wait_faultaware (bool &poisoned) const
void external_wait_faultaware (bool &poisoned) const
bool external_timedwait_faultaware (bool &poisoned, long long max_ns) const
void subscribe (void) const
void cancel_operation (const void *reason_data, size_t reason_size) const
void set_operation_priority (int new_priority) const

Static Public Member Functions

static UserEvent create_user_event (void)
Static Public Member Functions inherited from PRealm::Event
static Event merge_events (const Event *wait_for, size_t num_events)
static Event merge_events (Event ev1, Event ev2, Event ev3=NO_EVENT, Event ev4=NO_EVENT, Event ev5=NO_EVENT, Event ev6=NO_EVENT)
static Event merge_events (const std::set< Event > &wait_for)
static Event merge_events (const span< const Event > &wait_for)
static Event merge_events_ignorefaults (const Event *wait_for, size_t num_events)
static Event merge_events_ignorefaults (const span< const Event > &wait_for)
static Event merge_events_ignorefaults (const std::set< Event > &wait_for)
static Event ignorefaults (Event wait_for)
Static Public Member Functions inherited from Realm::Event
static Event merge_events_ignorefaults (const Event *wait_for, size_t num_events)
static Event merge_events_ignorefaults (const span< const Event > &wait_for)
static Event merge_events_ignorefaults (const std::set< Event > &wait_for)
static Event ignorefaults (Event wait_for)
static void advise_event_ordering (Event happens_before, Event happens_after)
static void advise_event_ordering (const Event *happens_before, size_t num_events, Event happens_after, bool all_must_trigger=true)
static void advise_event_ordering (const span< Event > &happens_before, Event happens_after, bool all_must_trigger=true)
static Event merge_events (const Event *wait_for, size_t num_events)
static Event merge_events (Event ev1, Event ev2, Event ev3=NO_EVENT, Event ev4=NO_EVENT, Event ev5=NO_EVENT, Event ev6=NO_EVENT)
static Event merge_events (const std::set< Event > &wait_for)
static Event merge_events (const span< const Event > &wait_for)

Static Public Attributes

static const UserEvent NO_USER_EVENT
Static Public Attributes inherited from PRealm::Event
static const Event NO_EVENT
Static Public Attributes inherited from Realm::Event
static const Event NO_EVENT
 The value should be usued to initialize an event handle. NO_EVENT is always in has triggered state .

Additional Inherited Members

Public Types inherited from Realm::Event
typedef ::realm_id_t id_t
Public Attributes inherited from Realm::Event
id_t id {REALM_NO_EVENT}

Constructor & Destructor Documentation

◆ UserEvent() [1/5]

PRealm::UserEvent::UserEvent ( void )
inline

◆ UserEvent() [2/5]

PRealm::UserEvent::UserEvent ( ::realm_id_t i)
inline

◆ UserEvent() [3/5]

PRealm::UserEvent::UserEvent ( const Realm::UserEvent & e)
inline

◆ UserEvent() [4/5]

PRealm::UserEvent::UserEvent ( const UserEvent & rhs)
default

◆ UserEvent() [5/5]

PRealm::UserEvent::UserEvent ( UserEvent && rhs)
default

Member Function Documentation

◆ cancel()

void PRealm::UserEvent::cancel ( void ) const

◆ create_user_event()

UserEvent PRealm::UserEvent::create_user_event ( void )
static

◆ operator=() [1/3]

UserEvent & PRealm::UserEvent::operator= ( const Realm::UserEvent & e)
inline

◆ operator=() [2/3]

UserEvent & PRealm::UserEvent::operator= ( const UserEvent & rhs)
default

◆ operator=() [3/3]

UserEvent & PRealm::UserEvent::operator= ( UserEvent && rhs)
default

◆ trigger()

void PRealm::UserEvent::trigger ( Event wait_on = Event::NO_EVENT,
bool ignore_faults = false ) const

Member Data Documentation

◆ NO_USER_EVENT

const UserEvent PRealm::UserEvent::NO_USER_EVENT
static

The documentation for this class was generated from the following file:
  • /home/runner/work/realm/realm/realm-src/src/realm/prealm/prealm.h