CPNATFWT_SESSION_TERMINATION_REASON Enumeration
[This documentation is preliminary and is subject to change.]
The CPNATFWT_SESSION_TERMINATION_REASON enumeration specifies the reason that the Connectivity Platform (CP) is terminating a session with a Provider instance.
Syntax
typedef enum {
CPNATFWT_SESSION_TERMINATION_PROVIDER_REQUEST,
CPNATFWT_SESSION_TERMINATION_PLATFORM_SHUTDOWN,
CPNATFWT_SESSION_TERMINATION_PROVIDER_TIMEOUT,
CPNATFWT_SESSION_TERMINATION_PROVIDER_OTHER_FAILURE,
CPNATFWT_SESSION_TERMINATION_OTHER_COMMUNICATION_ERROR
} CPNATFWT_SESSION_TERMINATION_REASON;
Constants
CPNATFWT_SESSION_TERMINATION_PROVIDER_REQUEST
The session was terminated at the request of the provider.CPNATFWT_SESSION_TERMINATION_PLATFORM_SHUTDOWN
The session was terminated as a result of a platform shutdown.CPNATFWT_SESSION_TERMINATION_PROVIDER_TIMEOUT
The session was terminated as a result of a Provider timeout.CPNATFWT_SESSION_TERMINATION_PROVIDER_OTHER_FAILURE
The session was terminated as a result of some other failure by the Provider.CPNATFWT_SESSION_TERMINATION_OTHER_COMMUNICATION_ERROR
The session was terminated as a result of a communication error.
Remarks
The CPNATFWT_SESSION_TERMINATION_REASON enumeration is used by the Connectivity Platform feature supported on Windows 7 and later.
The Connectivity Platform (CP) provides a mechanism for specialized applications and services to provide custom network traversal of network address translation (NAT) and firewalls on Windows 7 and later. A Provider registers with the Connectivity Platform to provide network traversal for other applications that use standard Windows networking APIs such as Windows Sockets.
A value from the CPNATFWT_SESSION_TERMINATION_REASON enumeration is passed in the terminationReason parameter to the CPNATFWT_PROVIDER_TERMINATE_SESSION_INDICATION callback function implemented by a Provider. The CPNATFWT_PROVIDER_TERMINATE_SESSION_INDICATION function is called by the Connectivity Platform to terminate a session with a Provider instance, either due to a Provider request or for other reasons (platform unavailability or a communication error, for example).
Requirements
| Minimum supported client | Windows 7 |
| Minimum supported server | None supported |
| Header | Iphlpapi.h (include Iphlpapi.h) |
See Also
CPNATFWT_PROVIDER_TERMINATE_SESSION_INDICATION
Send comments about this topic to Microsoft
Build date: 2/3/2009