INapSystemHealthAgentCallback::NotifyOrphanedSoHRequest method

Article
12/11/2020

Note

The Network Access Protection platform is not available starting with Windows 10

The INapSystemHealthAgentCallback::NotifyOrphanedSoHRequest method is called if an SoHRequest was queried from the SHA, but the response never came back.

Syntax

HRESULT NotifyOrphanedSoHRequest(
  [in] const CorrelationId *correlationId
);

Parameters

correlationId [in]: A pointer to the unique CorrelationId structure that identifies the orphaned SoHRequest.

Return value

This method can return one of these values.

Return code	Description
S_OK	Indicates success.

Remarks

This callback method is declared by the NAP system and is to be implemented by the SHA writer.

This method can be called by the system in the following cases:

A SoHRequest could not be sent on the wire.
A SoHRequest was sent on the wire, but no SoHResponse came back, i.e. the enforcer timed out or there was no corresponding SHV on the server-side.
The connection went down or an enforcer went offline.

This is only a best effort notification, so SHAs must not rely on this information to clean up state. There are several situations in which an SHA will not be notified:

If an enforcer misbehaves, i.e. it does not notify the SHA when the connection state is down.
If an enforcer crashes.
In error conditions, i.e. the NapAgent is out of memory.

SHAs may get some spurious notifications when they first bind to the NapAgent, for instance, if an SoH exchange is in progress when the SHA bound, and then it times out.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Header	NapSystemHealthAgent.h
IDL	NapSystemHealthAgent.idl