vecmem::abstract_event Struct Reference

Interface that language specific "events" need to implement. More...

#include <vecmem/utils/abstract_event.hpp>

Inheritance diagram for vecmem::abstract_event:

Public Member Functions
virtual	~abstract_event ()=default
	Virtual destructor to make vtable happy.
virtual void	wait ()=0
	Function that would block the current thread until the event is complete.
virtual void	ignore ()=0
	Function telling the object not to wait for the underlying event.

Detailed Description

Interface that language specific "events" need to implement.

"Events" provide a way to have synchronization points in a program's execution flow. Asynchronous memory operations in different languages provide ways of explicitly waiting for the completion of certain operations. This abstract interface is used in this project to provide a uniform interface to language specific "event" objects that would provide such synchronization points.

Member Function Documentation

ignore()

virtual void vecmem::abstract_event::ignore ( )

pure virtual

Function telling the object not to wait for the underlying event.

Implemented in vecmem::async_size< SIZE_TYPE >, and vecmem::async_sizes< SIZE_TYPE >.

wait()

virtual void vecmem::abstract_event::wait ( )

pure virtual

Function that would block the current thread until the event is complete.

Implemented in vecmem::async_size< SIZE_TYPE >, and vecmem::async_sizes< SIZE_TYPE >.

---

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

• core/include/vecmem/utils/abstract_event.hpp