FxMessageDispatch Class Reference

#include <fxmessagedispatchum.hpp>

Inheritance diagram for FxMessageDispatch:

Collaboration diagram for FxMessageDispatch:

Public Member Functions
	~FxMessageDispatch ()
HRESULT __stdcall	QueryInterface (_In_ REFIID riid, _Out_ LPVOID *ppvObject)
ULONG __stdcall	AddRef ()
ULONG __stdcall	Release ()
virtual void __stdcall	DispatchPnP (_In_ IWudfIrp *pIrp)
virtual void __stdcall	CreateFile (_In_ IWudfIoIrp *pCreateIrp)
virtual void __stdcall	DeviceControl (_In_ IWudfIoIrp *pIrp, _In_opt_ IUnknown *pFxContext)
virtual void __stdcall	ReadFile (_In_ IWudfIoIrp *pIrp, _In_opt_ IUnknown *pFxContext)
virtual void __stdcall	WriteFile (_In_ IWudfIoIrp *pIrp, _In_opt_ IUnknown *pFxContext)
virtual void __stdcall	CleanupFile (_In_ IWudfIoIrp *pIrp, _In_ IUnknown *pFxContext)
virtual void __stdcall	CloseFile (_In_ IWudfIoIrp *pIrp, _In_ IUnknown *pFxContext)
virtual VOID __stdcall	GetPreferredTransferMode (_Out_ UMINT::WDF_DEVICE_IO_BUFFER_RETRIEVAL *RetrievalMode, _Out_ UMINT::WDF_DEVICE_IO_TYPE *RWPreference, _Out_ UMINT::WDF_DEVICE_IO_TYPE *IoctlPreference)
virtual void __stdcall	FlushBuffers (_In_ IWudfIoIrp *pIrp, _In_opt_ IUnknown *pFxContext)
virtual void __stdcall	QueryInformationFile (_In_ IWudfIoIrp *pIrp, _In_opt_ IUnknown *pFxContext)
virtual void __stdcall	SetInformationFile (_In_ IWudfIoIrp *pIrp, _In_opt_ IUnknown *pFxContext)
virtual NTSTATUS __stdcall	ProcessWmiPowerQueryOrSetData (_In_ RdWmiPowerAction Action, _Out_ BOOLEAN *QueryResult)
virtual WUDF_INTERFACE_CONTEXT __stdcall	RemoteInterfaceArrival (_In_ LPCGUID pDeviceInterfaceGuid, _In_ PCWSTR pSymbolicLink)
virtual void __stdcall	RemoteInterfaceRemoval (_In_ WUDF_INTERFACE_CONTEXT RemoteInterfaceID)
virtual BOOL __stdcall	TransportQueryID (_In_ DWORD Id, _In_ PVOID DataBuffer, _In_ SIZE_T cbDataBufferSize)
virtual ULONG __stdcall	GetDirectTransferThreshold (VOID)
virtual void __stdcall	PoFxDevicePowerRequired (VOID)
virtual void __stdcall	PoFxDevicePowerNotRequired (VOID)
PDRIVER_OBJECT_UM	GetDriverObject (VOID)
MdDeviceObject	GetDeviceObject (VOID)
Public 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)

Static Public Member Functions
static NTSTATUS	_CreateAndInitialize (_In_ PFX_DRIVER_GLOBALS DriverGlobals, _In_ FxDevice *Device, _Out_ FxMessageDispatch **ppWudfDispatcher)
static FxMessageDispatch *	_GetObjFromItf (_In_ IFxMessageDispatch *pIFxMessageDispatch)
static IFxMessageDispatch *	_GetDispatcherItf (_In_ FxMessageDispatch *pWudfDispatcher)

Private Member Functions
	FxMessageDispatch (_In_ FxDevice *Device)

Private Attributes
LONG	m_cRefs
FxDevice *	m_Device

Additional Inherited Members
Protected Member Functions inherited from FxStump
	FxStump (VOID)

Detailed Description

Definition at line 33 of file fxmessagedispatchum.hpp.

Constructor & Destructor Documentation

FxMessageDispatch()

FxMessageDispatch::FxMessageDispatch ( _In_ FxDevice *  Device )

inlineprivate

Definition at line 41 of file fxmessagedispatchum.hpp.

          :
        m_cRefs(1),
        m_Device(Device)
    {
    }

Referenced by _CreateAndInitialize().

~FxMessageDispatch()

FxMessageDispatch::~FxMessageDispatch ( )

inline

Definition at line 50 of file fxmessagedispatchum.hpp.

    {
    //    SAFE_RELEASE(m_Device);
    }

Member Function Documentation

_CreateAndInitialize()

NTSTATUS FxMessageDispatch::_CreateAndInitialize ( _In_ PFX_DRIVER_GLOBALS  DriverGlobals, _In_ FxDevice *  Device, _Out_ FxMessageDispatch **  ppWudfDispatcher  )

static

Definition at line 44 of file fxmessagedispatchum.cpp.

{
    HRESULT             hr = S_OK;
    FxMessageDispatch *   pWudfDispatcher = NULL;
    NTSTATUS status;

    *ppWudfDispatcher = NULL;

    pWudfDispatcher = new (DriverGlobals) FxMessageDispatch(Device);
    if (NULL == pWudfDispatcher) {
        hr = E_OUTOFMEMORY;
        DoTraceLevelMessage(DriverGlobals, TRACE_LEVEL_ERROR, TRACINGDEVICE,
            "Memory allocation failure. Cannot create Dispatcher object.\n");
        goto Done;
    }

    *ppWudfDispatcher = pWudfDispatcher;

Done:

    if (FAILED(hr)) {
        status = Device->NtStatusFromHr(hr);
    }
    else {
        status = STATUS_SUCCESS;
    }

    return status;
}

_GetDispatcherItf()

IFxMessageDispatch * FxMessageDispatch::_GetDispatcherItf ( _In_ FxMessageDispatch *  pWudfDispatcher )

static

Definition at line 376 of file fxmessagedispatchum.cpp.

{
    IFxMessageDispatch * pIFxMessageDispatch = NULL;
    HRESULT hrQI = pWudfDispatcher->QueryInterface(IID_IFxMessageDispatch,
                                                  (PVOID*)&pIFxMessageDispatch);
    FX_VERIFY(INTERNAL, CHECK_QI(hrQI, pIFxMessageDispatch));
    pIFxMessageDispatch->Release(); //release the reference taken by QI
    return pIFxMessageDispatch;
}

_GetObjFromItf()

FxMessageDispatch * FxMessageDispatch::_GetObjFromItf ( _In_ IFxMessageDispatch *  pIFxMessageDispatch )

static

Definition at line 357 of file fxmessagedispatchum.cpp.

{
    FxMessageDispatch * pWudfDispatcher = NULL;
    HRESULT hrQI = pIFxMessageDispatch->QueryInterface(
                        IID_FxMessageDispatch,
                        reinterpret_cast<void**>(&pWudfDispatcher)
                        );
    FX_VERIFY(INTERNAL, CHECK_QI(hrQI, pWudfDispatcher));
    pWudfDispatcher->Release(); //release the reference taken by QI
    return pWudfDispatcher;
}

AddRef()

ULONG FxMessageDispatch::AddRef

(

void

)

Definition at line 82 of file fxmessagedispatchum.cpp.

{
    LONG cRefs = InterlockedIncrement( &m_cRefs );

    //
    // This allows host to manage the lifetime of FxDevice.
    //
    m_Device->ADDREF(this);

    return cRefs;
}

Referenced by QueryInterface().

CleanupFile()

void FxMessageDispatch::CleanupFile ( _In_ IWudfIoIrp *  pIrp, _In_ IUnknown *  pFxContext  )

virtual

Definition at line 217 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_CLEANUP](GetDeviceObject(), pIrp, pFxContext);
}

CloseFile()

void FxMessageDispatch::CloseFile ( _In_ IWudfIoIrp *  pIrp, _In_ IUnknown *  pFxContext  )

virtual

Definition at line 226 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_CLOSE](GetDeviceObject(), pIrp, pFxContext);
}

CreateFile()

void FxMessageDispatch::CreateFile ( _In_ IWudfIoIrp *  pCreateIrp )

virtual

Definition at line 178 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_CREATE](GetDeviceObject(),
                                                    pCreateIrp,
                                                    NULL);
}

DeviceControl()

void FxMessageDispatch::DeviceControl ( _In_ IWudfIoIrp *  pIrp, _In_opt_ IUnknown *  pFxContext  )

virtual

Definition at line 188 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_DEVICE_CONTROL](GetDeviceObject(),
                                                            pIrp,
                                                            pFxContext);
}

DispatchPnP()

void FxMessageDispatch::DispatchPnP ( _In_ IWudfIrp *  pIrp )

virtual

Definition at line 154 of file fxmessagedispatchum.cpp.

{
    IWudfPnpIrp * pIPnpIrp = NULL;

    HRESULT hrQI = pIrp->QueryInterface(IID_IWudfPnpIrp, (PVOID*)&pIPnpIrp);
    FX_VERIFY(INTERNAL, CHECK_QI(hrQI, pIPnpIrp));

    if (IRP_MJ_POWER == pIPnpIrp->GetMajorFunction()) {
        GetDriverObject()->MajorFunction[IRP_MJ_POWER](GetDeviceObject(),
                                                       pIrp,
                                                       NULL);
    }
    else {
        GetDriverObject()->MajorFunction[IRP_MJ_PNP](GetDeviceObject(),
                                                     pIrp,
                                                     NULL);
    }

    SAFE_RELEASE(pIPnpIrp);
}

FlushBuffers()

void FxMessageDispatch::FlushBuffers ( _In_ IWudfIoIrp *  pIrp, _In_opt_ IUnknown *  pFxContext  )

virtual

Definition at line 235 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_FLUSH_BUFFERS](GetDeviceObject(),
                                                           pIrp,
                                                           pFxContext);
}

GetDeviceObject()

MdDeviceObject FxMessageDispatch::GetDeviceObject ( VOID  )

inline

Definition at line 231 of file fxmessagedispatchum.hpp.

    {
        return m_Device->GetDeviceObject();
    }

Referenced by CleanupFile(), CloseFile(), CreateFile(), DeviceControl(), DispatchPnP(), FlushBuffers(), GetPreferredTransferMode(), PoFxDevicePowerNotRequired(), PoFxDevicePowerRequired(), QueryInformationFile(), ReadFile(), RemoteInterfaceArrival(), RemoteInterfaceRemoval(), SetInformationFile(), TransportQueryID(), and WriteFile().

GetDirectTransferThreshold()

ULONG FxMessageDispatch::GetDirectTransferThreshold ( VOID  )

virtual

Definition at line 283 of file fxmessagedispatchum.cpp.

{
    return m_Device->GetDirectTransferThreshold();
}

GetDriverObject()

PDRIVER_OBJECT_UM FxMessageDispatch::GetDriverObject ( VOID  )

inline

Definition at line 223 of file fxmessagedispatchum.hpp.

    {
        return m_Device->GetDriver()->GetDriverObject();
    }

Referenced by CleanupFile(), CloseFile(), CreateFile(), DeviceControl(), DispatchPnP(), FlushBuffers(), QueryInformationFile(), ReadFile(), SetInformationFile(), and WriteFile().

GetPreferredTransferMode()

VOID FxMessageDispatch::GetPreferredTransferMode ( _Out_ UMINT::WDF_DEVICE_IO_BUFFER_RETRIEVAL *  RetrievalMode, _Out_ UMINT::WDF_DEVICE_IO_TYPE *  RWPreference, _Out_ UMINT::WDF_DEVICE_IO_TYPE *  IoctlPreference  )

virtual

Definition at line 270 of file fxmessagedispatchum.cpp.

{
    FxDevice::GetPreferredTransferMode(GetDeviceObject(),
                                       RetrievalMode,
                                       (WDF_DEVICE_IO_TYPE*)RWPreference,
                                       (WDF_DEVICE_IO_TYPE*)IoctlPreference);
}

PoFxDevicePowerNotRequired()

void FxMessageDispatch::PoFxDevicePowerNotRequired ( VOID  )

virtual

Definition at line 341 of file fxmessagedispatchum.cpp.

{
    FxDevice::PoFxDevicePowerNotRequired(GetDeviceObject());
}

PoFxDevicePowerRequired()

void FxMessageDispatch::PoFxDevicePowerRequired ( VOID  )

virtual

Definition at line 333 of file fxmessagedispatchum.cpp.

{
    FxDevice::PoFxDevicePowerRequired(GetDeviceObject());
}

ProcessWmiPowerQueryOrSetData()

NTSTATUS FxMessageDispatch::ProcessWmiPowerQueryOrSetData ( _In_ RdWmiPowerAction  Action, _Out_ BOOLEAN *  QueryResult  )

virtual

Definition at line 291 of file fxmessagedispatchum.cpp.

{
    return m_Device->ProcessWmiPowerQueryOrSetData(Action, QueryResult);
}

QueryInformationFile()

void FxMessageDispatch::QueryInformationFile ( _In_ IWudfIoIrp *  pIrp, _In_opt_ IUnknown *  pFxContext  )

virtual

Definition at line 246 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_QUERY_INFORMATION](
                                                    GetDeviceObject(),
                                                    pIrp,
                                                    pFxContext
                                                    );
}

QueryInterface()

HRESULT FxMessageDispatch::QueryInterface	(	_In_ REFIID	riid,
		_Out_ LPVOID *	ppvObject
	)

Definition at line 120 of file fxmessagedispatchum.cpp.

{
    if ( NULL == ppv ) {
        return E_INVALIDARG;
    }

    if ( iid == IID_IUnknown) {
        *ppv = static_cast<IUnknown *> (this);
    }
    else if ( iid == IID_IFxMessageDispatch ) {
        *ppv = static_cast<IFxMessageDispatch *> (this);
    }
    else if ( iid == IID_IFxMessageDispatch2 ) {
        *ppv = static_cast<IFxMessageDispatch2 *> (this);
    }
    else if ( iid == IID_FxMessageDispatch ) {
        *ppv = this;
    }
    else {
        *ppv = NULL;
        return E_NOINTERFACE;
    }

    this->AddRef();
    return S_OK;
}

ReadFile()

void FxMessageDispatch::ReadFile ( _In_ IWudfIoIrp *  pIrp, _In_opt_ IUnknown *  pFxContext  )

virtual

Definition at line 199 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_READ](GetDeviceObject(), pIrp, pFxContext);
}

Release()

ULONG FxMessageDispatch::Release

(

void

)

Definition at line 96 of file fxmessagedispatchum.cpp.

{
    LONG cRefs = InterlockedDecrement( &m_cRefs );

    if (0 == cRefs) {
        //
        // The lifetime of this object is controlled by FxDevice
        // object (the container object), and not by this ref count. FxDevice
        // will delete this object in its destructior.
        //
        DO_NOTHING();
    }

    //
    // This allows host to manage the lifetime of FxDevice. If this is the last
    // release on FxDevice, FxDevice will e deleted and this object will be
    // deleted as part of FxDevice destructor.
    //
    m_Device->RELEASE(this);

    return cRefs;
}

Referenced by _GetObjFromItf().

RemoteInterfaceArrival()

WUDF_INTERFACE_CONTEXT FxMessageDispatch::RemoteInterfaceArrival ( _In_ LPCGUID  pDeviceInterfaceGuid, _In_ PCWSTR  pSymbolicLink  )

virtual

Definition at line 300 of file fxmessagedispatchum.cpp.

{
    return FxDevice::RemoteInterfaceArrival(GetDeviceObject(),
                                            pDeviceInterfaceGuid,
                                            pSymbolicLink);
}

RemoteInterfaceRemoval()

void FxMessageDispatch::RemoteInterfaceRemoval ( _In_ WUDF_INTERFACE_CONTEXT  RemoteInterfaceID )

virtual

Definition at line 311 of file fxmessagedispatchum.cpp.

{
    FxDevice::RemoteInterfaceRemoval(GetDeviceObject(),
                                     RemoteInterfaceID);
}

SetInformationFile()

void FxMessageDispatch::SetInformationFile ( _In_ IWudfIoIrp *  pIrp, _In_opt_ IUnknown *  pFxContext  )

virtual

Definition at line 259 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_SET_INFORMATION](GetDeviceObject(),
                                                             pIrp,
                                                             pFxContext);
}

TransportQueryID()

BOOL FxMessageDispatch::TransportQueryID ( _In_ DWORD  Id, _In_ PVOID  DataBuffer, _In_ SIZE_T  cbDataBufferSize  )

virtual

Definition at line 320 of file fxmessagedispatchum.cpp.

{
    return FxDevice::TransportQueryId(GetDeviceObject(),
                                      Id,
                                      DataBuffer,
                                      cbDataBufferSize);
}

WriteFile()

void FxMessageDispatch::WriteFile ( _In_ IWudfIoIrp *  pIrp, _In_opt_ IUnknown *  pFxContext  )

virtual

Definition at line 208 of file fxmessagedispatchum.cpp.

{
    GetDriverObject()->MajorFunction[IRP_MJ_WRITE](GetDeviceObject(), pIrp, pFxContext);
}

Member Data Documentation

m_cRefs

LONG FxMessageDispatch::m_cRefs

private

Definition at line 246 of file fxmessagedispatchum.hpp.

Referenced by AddRef(), and Release().

m_Device

FxDevice* FxMessageDispatch::m_Device

private

Definition at line 251 of file fxmessagedispatchum.hpp.

Referenced by AddRef(), GetDeviceObject(), GetDirectTransferThreshold(), GetDriverObject(), ProcessWmiPowerQueryOrSetData(), and Release().

---

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

• sdk/lib/drivers/wdf/shared/inc/private/um/fxmessagedispatchum.hpp
• sdk/lib/drivers/wdf/shared/core/um/fxmessagedispatchum.cpp