IMessageRouterLinkStateNotification::LinkStateNotify

Platform SDK: SMTP Server Events

IMessageRouterLinkStateNotification::LinkStateNotify

[This is preliminary documentation and subject to change.]

The IMessageRouterLinkStateNotification::LinkStateNotify is called on router sinks by the SMTP service to notify the sink of a connection (link) state for a next hop location.

HRESULT LinkStateNotify(
   [in] LPSTR             szLinkDomainName,
   [in] GUID              guidRouterGUID,
   [in] DWORD             dwScheduleID,
   [in] LPSTR             szConnectorName,
   [in] DWORD             dwLinkState,
   [in] DWORD             cConsecutiveFailures,
   [in, out] FILETIME    *pftNextScheduled,
   [out] DWORD           *pdwSetLinkState,
   [out] DWORD           *pdwUnsetLinkState
);

szLinkDomainName: The domain to which the link was attempted.
guidRouterGUID: The GUID for the particular router.
dwScheduleID
szConnectorName
dwLinkState: The connection link state. The passed value will be some OR'ed combination of the eLinkStateFlags enumerated values.
cConsecutiveFailures: The number of consecutive attempted that failed.
pftNextScheduled: The time at which a new connection is to be attempted. Set this value if LINK_STATE_SCHED_ENABLED is being unset by the router sink.
pdwSetLinkState: The link state to set. Must be some OR'd combination of the eLinkStateFlags enumerated values.
pdwUnsetLinkState: The link state flags to unset. Must be some OR'ed combination of the eLinkStateFlags enumerated values.

Remarks

If the LINK_STATE_SCHED_ENABLED is being unset, a next scheduled connection time should be returned.