FxIoTargetRemoteNotificationCallback Class Reference

#include <fxiotargetremoteum.hpp>

Inheritance diagram for FxIoTargetRemoteNotificationCallback:

Collaboration diagram for FxIoTargetRemoteNotificationCallback:

Public Member Functions
	FxIoTargetRemoteNotificationCallback (PFX_DRIVER_GLOBALS FxDriverGlobals, FxIoTargetRemote *Target)
	~FxIoTargetRemoteNotificationCallback ()
WUDF_TARGET_CONTEXT	GetRegistrationId (VOID)
BOOL __stdcall	OnQueryRemove (_In_ WUDF_TARGET_CONTEXT RegistrationID)
VOID __stdcall	OnRemoveCanceled (_In_ WUDF_TARGET_CONTEXT RegistrationID)
VOID __stdcall	OnRemoveComplete (_In_ WUDF_TARGET_CONTEXT RegistrationID)
VOID __stdcall	OnCustomEvent (_In_ WUDF_TARGET_CONTEXT RegistrationID, _In_ REFGUID Event, _In_reads_bytes_(DataSize) BYTE *Data, _In_ DWORD DataSize, _In_ DWORD NameBufferOffset)
HRESULT __stdcall	QueryInterface (__in const IID &iid, __out void **ppv)
ULONG __stdcall	AddRef ()
ULONG __stdcall	Release ()
Public Member Functions inherited from FxGlobalsStump
	FxGlobalsStump (__in PFX_DRIVER_GLOBALS FxDriverGlobals)
PFX_DRIVER_GLOBALS	GetDriverGlobals (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)

Private Attributes
LONG	m_cRefs
FxIoTargetRemote *	m_RemoteTarget

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

Detailed Description

Definition at line 26 of file fxiotargetremoteum.hpp.

Constructor & Destructor Documentation

FxIoTargetRemoteNotificationCallback()

FxIoTargetRemoteNotificationCallback::FxIoTargetRemoteNotificationCallback ( PFX_DRIVER_GLOBALS  FxDriverGlobals, FxIoTargetRemote *  Target  )

inline

Definition at line 38 of file fxiotargetremoteum.hpp.

          :
        FxGlobalsStump(FxDriverGlobals),
        m_RemoteTarget(Target),
        m_cRefs(1)
    {
    }

~FxIoTargetRemoteNotificationCallback()

FxIoTargetRemoteNotificationCallback::~FxIoTargetRemoteNotificationCallback ( )

inline

Definition at line 48 of file fxiotargetremoteum.hpp.

{};

Member Function Documentation

AddRef()

ULONG __stdcall FxIoTargetRemoteNotificationCallback::AddRef ( )

inline

Definition at line 115 of file fxiotargetremoteum.hpp.

    {
        LONG cRefs = InterlockedIncrement( &m_cRefs );
        return cRefs;
    }

Referenced by QueryInterface().

GetRegistrationId()

WUDF_TARGET_CONTEXT FxIoTargetRemoteNotificationCallback::GetRegistrationId ( VOID  )

inline

Definition at line 51 of file fxiotargetremoteum.hpp.

    {
        return m_RemoteTarget->m_TargetNotifyHandle;
    }

Referenced by OnQueryRemove(), OnRemoveCanceled(), and OnRemoveComplete().

OnCustomEvent()

VOID __stdcall FxIoTargetRemoteNotificationCallback::OnCustomEvent	(	_In_ WUDF_TARGET_CONTEXT	RegistrationID,
		_In_ REFGUID	Event,
		_In_reads_bytes_(DataSize) BYTE *	Data,
		_In_ DWORD	DataSize,
		_In_ DWORD	NameBufferOffset
	)

Definition at line 637 of file fxiotargetremoteum.cpp.

{
    UNREFERENCED_PARAMETER(RegistrationID);
    UNREFERENCED_PARAMETER(Event);
    UNREFERENCED_PARAMETER(Data);
    UNREFERENCED_PARAMETER(DataSize);
    UNREFERENCED_PARAMETER(NameBufferOffset);
 
    //
    // UMDF 2.0 doesn't yet support custom event. Ignore the event.
    //
    DO_NOTHING();
 
    return;
}

OnQueryRemove()

BOOL __stdcall FxIoTargetRemoteNotificationCallback::OnQueryRemove

(

_In_ WUDF_TARGET_CONTEXT

RegistrationID

)

Definition at line 435 of file fxiotargetremoteum.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxIoTargetRemote* pThis;
    NTSTATUS status;
    BOOLEAN bStatus;
 
    pThis = m_RemoteTarget;
 
    //
    // In one of these callbacks, the driver may decide to delete the target.
    // If that is the case, we need to be able to return and deref the object until
    // we are done.
    //
    pThis->ADDREF(m_RemoteTarget);
 
    pFxDriverGlobals = pThis->GetDriverGlobals();
 
    status = STATUS_SUCCESS;
    bStatus = TRUE;
 
    if (GetRegistrationId() != RegistrationID) {
        //
        // By design, we can get notification callbacks even after we have
        // unregistered for notifications. This can happen if there were
        // callbacks already in flight before we unregistered. In this case, we
        // simply succeed on query-remove. Since we have already unregistered,
        // there is no reason for us to fail query-remove.
        //
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGIOTARGET,
                    "QueryRemove callback was for an old registration, ignoring.");
 
        bStatus = TRUE;
        goto exit;
    }
 
    DoTraceLevelMessage(
        pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
        "WDFIOTARGET %p: query remove notification",
        m_RemoteTarget->GetObjectHandle());
 
    //
    // Device is gracefully being removed.  PnP is asking us to close down
    // the target.  If there is a driver callback, there is *no* default
    // behavior.  This is because we don't know what the callback is going
    // to do.  For instance, the driver could reopen the target to a
    // different device in a multi-path scenario.
    //
    if (pThis->m_EvtQueryRemove.m_Method != NULL) {
        status = pThis->m_EvtQueryRemove.Invoke(
            pThis->GetHandle());
    }
    else {
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
            "WDFIOTARGET %p: query remove, default action (close for QR)",
            pThis->GetObjectHandle());
 
        //
        // No callback, close it down conditionally.
        //
        pThis->Close(FxIoTargetRemoteCloseReasonQueryRemove);
    }
 
    if (!NT_SUCCESS(status)) {
        bStatus = FALSE;
    }
 
exit:
 
    pThis->RELEASE(m_RemoteTarget);
 
    return bStatus;
}

OnRemoveCanceled()

VOID __stdcall FxIoTargetRemoteNotificationCallback::OnRemoveCanceled

(

_In_ WUDF_TARGET_CONTEXT

RegistrationID

)

Definition at line 571 of file fxiotargetremoteum.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxIoTargetRemote* pThis;
    NTSTATUS status;
 
    pThis = m_RemoteTarget;
 
    //
    // In one of these callbacks, the driver may decide to delete the target.
    // If that is the case, we need to be able to return and deref the object until
    // we are done.
    //
    pThis->ADDREF(m_RemoteTarget);
 
    pFxDriverGlobals = pThis->GetDriverGlobals();
    status = STATUS_SUCCESS;
 
    if (GetRegistrationId() != RegistrationID) {
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGIOTARGET,
                    "RemoveCanceled callback was for an old registration, ignoring.");
 
        goto exit;
    }
 
    DoTraceLevelMessage(
        pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
        "WDFIOTARGET %p: remove canceled notification", pThis->GetObjectHandle());
 
    if (pThis->m_EvtRemoveCanceled.m_Method != NULL) {
        pThis->m_EvtRemoveCanceled.Invoke(pThis->GetHandle());
    }
    else {
        WDF_IO_TARGET_OPEN_PARAMS params;
 
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
            "WDFIOTARGET %p: remove canceled, default action (reopen)",
            pThis->GetObjectHandle());
 
        WDF_IO_TARGET_OPEN_PARAMS_INIT_REOPEN(&params);
 
        //
        // Attempt to reopen the target with stored settings
        //
        status = pThis->Open(&params);
 
 
 
 
 
 
 
        UNREFERENCED_PARAMETER(status);
    }
 
exit:
 
    pThis->RELEASE(m_RemoteTarget);
}

OnRemoveComplete()

VOID __stdcall FxIoTargetRemoteNotificationCallback::OnRemoveComplete

(

_In_ WUDF_TARGET_CONTEXT

RegistrationID

)

Definition at line 515 of file fxiotargetremoteum.cpp.

{
    PFX_DRIVER_GLOBALS pFxDriverGlobals;
    FxIoTargetRemote* pThis;
 
    pThis = m_RemoteTarget;
 
    //
    // In one of these callbacks, the driver may decide to delete the target.
    // If that is the case, we need to be able to return and deref the object until
    // we are done.
    //
    pThis->ADDREF(m_RemoteTarget);
 
    pFxDriverGlobals = pThis->GetDriverGlobals();
 
    if (GetRegistrationId() != RegistrationID) {
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_WARNING, TRACINGIOTARGET,
                    "RemoveComplete callback was for an old registration, ignoring.");
 
        goto exit;
    }
 
    DoTraceLevelMessage(
        pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
        "WDFIOTARGET %p: remove complete notification", pThis->GetObjectHandle());
 
    //
    // The device was surprise removed, close it for good if the driver has
    // no override.
    //
    if (pThis->m_EvtRemoveComplete.m_Method != NULL) {
        pThis->m_EvtRemoveComplete.Invoke(pThis->GetHandle());
    }
    else {
        DoTraceLevelMessage(
            pFxDriverGlobals, TRACE_LEVEL_VERBOSE, TRACINGIOTARGET,
            "WDFIOTARGET %p: remove complete, default action (close)",
            pThis->GetObjectHandle());
 
        //
        // The device is now gone for good.  Close down the target for good.
        //
        pThis->Close(FxIoTargetRemoteCloseReasonPlainClose);
    }
 
exit:
 
    pThis->RELEASE(m_RemoteTarget);
}

QueryInterface()

HRESULT __stdcall FxIoTargetRemoteNotificationCallback::QueryInterface ( __in const IID &  iid, __out void **  ppv  )

inline

Definition at line 88 of file fxiotargetremoteum.hpp.

    {
        if (NULL == ppv) {
            return E_INVALIDARG;
        }
 
        *ppv = NULL;
 
        if ( iid == IID_IUnknown) {
            *ppv = static_cast<IUnknown *> (this);
        }
        else if ( iid == IID_IWudfTargetCallbackDeviceChange) {
            *ppv = static_cast<IWudfTargetCallbackDeviceChange *> (this);
        }
        else {
            return E_INVALIDARG;
        }
 
        this->AddRef();
        return S_OK;
    }

Release()

ULONG __stdcall FxIoTargetRemoteNotificationCallback::Release ( )

inline

Definition at line 124 of file fxiotargetremoteum.hpp.

    {
        LONG cRefs = InterlockedDecrement( &m_cRefs );
        if (0 == cRefs) {
            //
            // The lifetime of this object is controlled by FxIoTargetRemote
            // object (the container object), and not by this ref count. This
            // method is implemented just to satisfy the interface implemetation
            // requirement.
            //
            DO_NOTHING();
        }
 
        return cRefs;
    }

Member Data Documentation

m_cRefs

LONG FxIoTargetRemoteNotificationCallback::m_cRefs

private

Definition at line 32 of file fxiotargetremoteum.hpp.

Referenced by AddRef(), and Release().

m_RemoteTarget

FxIoTargetRemote* FxIoTargetRemoteNotificationCallback::m_RemoteTarget

private

Definition at line 34 of file fxiotargetremoteum.hpp.

Referenced by GetRegistrationId(), OnQueryRemove(), OnRemoveCanceled(), and OnRemoveComplete().

---

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

• sdk/lib/drivers/wdf/shared/inc/private/um/fxiotargetremoteum.hpp
• sdk/lib/drivers/wdf/shared/targets/general/um/fxiotargetremoteum.cpp