FxInterruptWaitblock Class Reference

#include <fxinterruptthreadpoolum.hpp>

Inheritance diagram for FxInterruptWaitblock:

Collaboration diagram for FxInterruptWaitblock:

Public Member Functions
	FxInterruptWaitblock (PFX_DRIVER_GLOBALS FxDriverGlobals)
	~FxInterruptWaitblock ()
VOID	CloseThreadpoolWait (VOID)
VOID	SetThreadpoolWait (VOID)
VOID	ClearThreadpoolWait (VOID)
VOID	WaitForOutstandingCallbackToComplete (VOID)
HANDLE	GetEventHandle (VOID)
VOID	ResetEvent (VOID)

Static Public Member Functions
static HRESULT	_CreateAndInit (_In_ FxInterruptThreadpool *Threadpool, _In_ FxInterrupt *Interrupt, _In_ PTP_WAIT_CALLBACK WaitCallback, _Out_ FxInterruptWaitblock **Waitblock)

Private Member Functions
HRESULT	Initialize (__in FxInterruptThreadpool *Threadpool, __in FxInterrupt *Interrupt, __in PTP_WAIT_CALLBACK WaitCallback)
Private Member Functions inherited from FxGlobalsStump
	FxGlobalsStump (__in PFX_DRIVER_GLOBALS FxDriverGlobals)
PFX_DRIVER_GLOBALS	GetDriverGlobals (VOID)
Private Member Functions inherited from FxStump
PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)
PVOID	operator new (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals, __in POOL_TYPE PoolType)
VOID	operator delete (__in PVOID pointer)
PVOID	operator new[] (__in size_t Size, __in PFX_DRIVER_GLOBALS FxDriverGlobals)
VOID	operator delete[] (__in PVOID pointer)
	FxStump (VOID)

Private Attributes
PTP_WAIT	m_Wait
HANDLE	m_Event

Detailed Description

Definition at line 94 of file fxinterruptthreadpoolum.hpp.

Constructor & Destructor Documentation

FxInterruptWaitblock()

FxInterruptWaitblock::FxInterruptWaitblock ( PFX_DRIVER_GLOBALS  FxDriverGlobals )

inline

Definition at line 128 of file fxinterruptthreadpoolum.hpp.

          :
        FxGlobalsStump(FxDriverGlobals),
        m_Wait(NULL),
        m_Event(NULL)
    {
    }

~FxInterruptWaitblock()

FxInterruptWaitblock::~FxInterruptWaitblock

(

)

Definition at line 265 of file fxinterruptthreadpoolum.cpp.

{
    //
    // close the thread pool wait structure
    //
    if (m_Wait) {
        //
        // Make sure no event is registered.
        //
        ClearThreadpoolWait();
 
        //
        // Wait for all the callbacks to finish.
        //
        WaitForOutstandingCallbackToComplete();
 
        //
        // close the wait
        //
        CloseThreadpoolWait();
 
        m_Wait = NULL;
    }
 
    //
    // close event handle
    //
    if (m_Event) {
        CloseHandle(m_Event);
        m_Event = NULL;
    }
}

Member Function Documentation

_CreateAndInit()

HRESULT FxInterruptWaitblock::_CreateAndInit ( _In_ FxInterruptThreadpool *  Threadpool, _In_ FxInterrupt *  Interrupt, _In_ PTP_WAIT_CALLBACK  WaitCallback, _Out_ FxInterruptWaitblock **  Waitblock  )

static

Definition at line 301 of file fxinterruptthreadpoolum.cpp.

{
    HRESULT hr = S_OK;
    FxInterruptWaitblock* waitblock = NULL;
    PFX_DRIVER_GLOBALS driverGlobals;
 
    FX_VERIFY(INTERNAL, CHECK_NOT_NULL(Waitblock));
    *Waitblock = NULL;
    driverGlobals = Interrupt->GetDriverGlobals();
 
    //
    // create an instance of interrupt wait block
    //
    waitblock = new (driverGlobals) FxInterruptWaitblock(driverGlobals);
    if (waitblock == NULL) {
        hr = E_OUTOFMEMORY;
        DoTraceLevelMessage(driverGlobals,
                    TRACE_LEVEL_ERROR, TRACINGPNP,
                    "Waitblock creation failed %!hresult!", hr);
        goto exit;
    }
 
    hr = waitblock->Initialize(Threadpool,
                               Interrupt,
                               WaitCallback);
    if (SUCCEEDED(hr)) {
        *Waitblock = waitblock;
    }
    else {
        DoTraceLevelMessage(driverGlobals,
                    TRACE_LEVEL_ERROR, TRACINGPNP,
                    "Waitblock init failed %!hresult!", hr);
    }
 
exit:
 
    if(FAILED(hr) && waitblock != NULL) {
        delete waitblock;
    }
 
    return hr;
}

ClearThreadpoolWait()

VOID FxInterruptWaitblock::ClearThreadpoolWait ( VOID  )

inline

Definition at line 160 of file fxinterruptthreadpoolum.hpp.

    {
        //
        // Passing a NULL handle clears the wait
        //
        ::SetThreadpoolWait(m_Wait, NULL, NULL);
    }

Referenced by ~FxInterruptWaitblock().

CloseThreadpoolWait()

VOID FxInterruptWaitblock::CloseThreadpoolWait ( VOID  )

inline

Definition at line 140 of file fxinterruptthreadpoolum.hpp.

    {
        ::CloseThreadpoolWait(m_Wait);
    }

Referenced by CloseThreadpoolWait(), and ~FxInterruptWaitblock().

GetEventHandle()

HANDLE FxInterruptWaitblock::GetEventHandle ( VOID  )

inline

Definition at line 179 of file fxinterruptthreadpoolum.hpp.

    {
        return m_Event;
    }

Initialize()

HRESULT FxInterruptWaitblock::Initialize ( __in FxInterruptThreadpool *  Threadpool, __in FxInterrupt *  Interrupt, __in PTP_WAIT_CALLBACK  WaitCallback  )

private

Definition at line 350 of file fxinterruptthreadpoolum.cpp.

{
    HRESULT hr = S_OK;
    DWORD error;
 
    //
    // create a per-interrupt auto-reset event, non-signalled to begin with.
    //
    m_Event = CreateEvent(
                          NULL,  // LPSECURITY_ATTRIBUTES lpEventAttributes,
                          FALSE, // BOOL bManualReset,
                          FALSE, // BOOL bInitialState,
                          NULL   // LPCTSTR lpName
                          );
 
    if (m_Event == NULL) {
        error = GetLastError();
        hr = HRESULT_FROM_WIN32(error);
        DoTraceLevelMessage(GetDriverGlobals(),
                    TRACE_LEVEL_ERROR, TRACINGPNP,
                    "Event creation failed for FxInterrupt object"
                    " %!winerr!", error);
        goto exit;
    }
 
    //
    // create a per-interrupt thread pool wait structure. This wait structure is
    // needed to associate an event-based wait callback with threadpool.
    //
    m_Wait = Threadpool->CreateThreadpoolWait(WaitCallback,
                                              Interrupt);
    if (m_Wait == NULL) {
        error = GetLastError();
        hr = HRESULT_FROM_WIN32(error);
        DoTraceLevelMessage(GetDriverGlobals(),
                    TRACE_LEVEL_ERROR, TRACINGPNP,
                    "Event creation failed for FxInterrupt object"
                    " %!winerr!", error);
        goto exit;
    }
 
exit:
 
    return hr;
}

Referenced by _CreateAndInit().

ResetEvent()

VOID FxInterruptWaitblock::ResetEvent ( VOID  )

inline

Definition at line 187 of file fxinterruptthreadpoolum.hpp.

    {
        ::ResetEvent(m_Event);
    }

Referenced by ResetEvent().

SetThreadpoolWait()

VOID FxInterruptWaitblock::SetThreadpoolWait ( VOID  )

inline

Definition at line 148 of file fxinterruptthreadpoolum.hpp.

    {
        //
        // associates event with wait block and queues it
        // to thread pool queue.
        //
        ::SetThreadpoolWait(m_Wait, m_Event, NULL);
    }

Referenced by ClearThreadpoolWait(), and SetThreadpoolWait().

WaitForOutstandingCallbackToComplete()

VOID FxInterruptWaitblock::WaitForOutstandingCallbackToComplete ( VOID  )

inline

Definition at line 171 of file fxinterruptthreadpoolum.hpp.

    {
        ::WaitForThreadpoolWaitCallbacks(m_Wait, FALSE);
    }

Referenced by ~FxInterruptWaitblock().

Member Data Documentation

m_Event

HANDLE FxInterruptWaitblock::m_Event

private

Definition at line 107 of file fxinterruptthreadpoolum.hpp.

Referenced by GetEventHandle(), Initialize(), ResetEvent(), SetThreadpoolWait(), and ~FxInterruptWaitblock().

m_Wait

PTP_WAIT FxInterruptWaitblock::m_Wait

private

Definition at line 102 of file fxinterruptthreadpoolum.hpp.

Referenced by ClearThreadpoolWait(), CloseThreadpoolWait(), Initialize(), SetThreadpoolWait(), WaitForOutstandingCallbackToComplete(), and ~FxInterruptWaitblock().

---

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

• sdk/lib/drivers/wdf/shared/inc/private/um/fxinterruptthreadpoolum.hpp
• sdk/lib/drivers/wdf/shared/irphandlers/pnp/um/fxinterruptthreadpoolum.cpp