dxd - dynax driver framework 3.0.2
cross platform open source driver development framework
Loading...
Searching...
No Matches
dxd::event< dx::kernel > Class Reference

kernel event: auto reset, as a WDM synchronization event More...

#include <dxd_sync_platform.h>

Inheritance diagram for dxd::event< dx::kernel >:
Collaboration diagram for dxd::event< dx::kernel >:

Public Member Functions

 event()
 event(bool signalled)
 event(bool signalled= false)
os_result initialize(::IODispatchQueue* queue)
 binds to the queue its waiter runs on
template<typename client_t>
os_result initialize(client_t &)
 a WDK thread waits where it runs: nothing to bind, the form DriverKit's queue binding takes
template<typename client_t>
os_result initialize(client_t& client)
 binds to the queue the client's calls run on
 operator ::KEVENT*()
os_result reset()
os_result reset()
os_result signal() override
os_result signal() override
os_result wait(int64_t time= 0)
 on the bound queue: gives it up until signalled or the time (ns, 0: none) passed
os_result wait(int64_t time= 0)
os_result wait_any(os_event wdm_event, int64_t time= 0)
 wait until either events are signalled or timeout.
 ~event() override

Static Public Member Functions

static os_result signal(os_event wdm_event)
static os_result wait(os_event wdm_event, int64_t time= 0)

Public Attributes

os_result status{ok}

Detailed Description

kernel event: auto reset, as a WDM synchronization event

A dext waits only by giving the queue it runs on up (IODispatchQueue::Sleep), and is woken only from that queue: the event binds to its waiter's queue - a client's, the call in flight on it, or a process's own - and signal() dispatches the wakeup there, from whatever queue it is called on.

Constructor & Destructor Documentation

◆ event() [1/3]

dxd::event<dx::kernel>::event(bool signalled= false)
inline

◆ ~event()

dxd::event<dx::kernel>::~event()
inlineoverridevirtual

Reimplemented from dxd::abstract::event.

◆ event() [2/3]

dxd::event<dx::kernel>::event()
inline

◆ event() [3/3]

dxd::event<dx::kernel>::event(bool signalled)
inline

Member Function Documentation

◆ initialize() [1/3]

os_result dxd::event<dx::kernel>::initialize(::IODispatchQueue* queue)
inline

binds to the queue its waiter runs on

Here is the caller graph for this function:

◆ initialize() [2/3]

template<typename client_t>
os_result dxd::event<dx::kernel>::initialize(client_t&)
inline

a WDK thread waits where it runs: nothing to bind, the form DriverKit's queue binding takes

◆ initialize() [3/3]

template<typename client_t>
os_result dxd::event<dx::kernel>::initialize(client_t& client)
inline

binds to the queue the client's calls run on

Here is the call graph for this function:

◆ operator ::KEVENT *()

dxd::event<dx::kernel>::operator ::KEVENT*()
inline

◆ reset() [1/2]

os_result dxd::event<dx::kernel>::reset()
inline

◆ reset() [2/2]

os_result dxd::event<dx::kernel>::reset()
inline

◆ signal() [1/3]

os_result dxd::event<dx::kernel>::signal()
inlineoverridevirtual

Implements dxd::abstract::event.

Here is the caller graph for this function:

◆ signal() [2/3]

os_result dxd::event<dx::kernel>::signal()
inlineoverridevirtual

Implements dxd::abstract::event.

Here is the call graph for this function:

◆ signal() [3/3]

os_result dxd::event<dx::kernel>::signal(os_event<dx::kernel> wdm_event)
inlinestatic

◆ wait() [1/3]

os_result dxd::event<dx::kernel>::wait(int64_t time= 0)
inline

on the bound queue: gives it up until signalled or the time (ns, 0: none) passed

Here is the call graph for this function:

◆ wait() [2/3]

os_result dxd::event<dx::kernel>::wait(int64_t time= 0)
inline
Here is the call graph for this function:
Here is the caller graph for this function:

◆ wait() [3/3]

os_result dxd::event<dx::kernel>::wait(os_event<dx::kernel> wdm_event, int64_t time= 0)
inlinestatic
Here is the call graph for this function:

◆ wait_any()

os_result dxd::event<dx::kernel>::wait_any(os_event<dx::kernel> wdm_event, int64_t time= 0)
inline

wait until either events are signalled or timeout.

Todo
check if event index really needs to be returned in os_result.
Here is the call graph for this function:

Member Data Documentation

◆ status


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