IVpnPlugIn IVpnPlugIn IVpnPlugIn IVpnPlugIn IVpnPlugIn Interface

Definition

Provides an interface to implement specific third party VPN client operations.

public : interface IVpnPlugIn
struct winrt::Windows::Networking::Vpn::IVpnPlugIn
public interface IVpnPlugIn
Public Interface IVpnPlugIn
// You can't instantiate an interface directly in JavaScript. You can use objects that implement the interface, however.
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
networkingVpnProvider

Methods

Connect(VpnChannel) Connect(VpnChannel) Connect(VpnChannel) Connect(VpnChannel) Connect(VpnChannel)

This method instructs the VPN plug-in to connect to the VPN server and establish the VPN channel.

Decapsulate(VpnChannel, VpnPacketBuffer, VpnPacketBufferList, VpnPacketBufferList) Decapsulate(VpnChannel, VpnPacketBuffer, VpnPacketBufferList, VpnPacketBufferList) Decapsulate(VpnChannel, VpnPacketBuffer, VpnPacketBufferList, VpnPacketBufferList) Decapsulate(VpnChannel, VpnPacketBuffer, VpnPacketBufferList, VpnPacketBufferList) Decapsulate(VpnChannel, VpnPacketBuffer, VpnPacketBufferList, VpnPacketBufferList)

This method instructs the VPN plug-in to prepare receive a buffer from the VPN server outerTunnelTransport, extract any number of IP packets encapsulated in the buffer, and return the IP packets together with any other reply buffers that are needed to be sent back through the outerTunnelTransport to the VPN server.

Disconnect(VpnChannel) Disconnect(VpnChannel) Disconnect(VpnChannel) Disconnect(VpnChannel) Disconnect(VpnChannel)

This method instructs the VPN plug-in to disconnect from the VPN server and destroy the VPN channel.

Encapsulate(VpnChannel, VpnPacketBufferList, VpnPacketBufferList) Encapsulate(VpnChannel, VpnPacketBufferList, VpnPacketBufferList) Encapsulate(VpnChannel, VpnPacketBufferList, VpnPacketBufferList) Encapsulate(VpnChannel, VpnPacketBufferList, VpnPacketBufferList) Encapsulate(VpnChannel, VpnPacketBufferList, VpnPacketBufferList)

This method instructs the VPN plug-in to prepare the indicated L3 IP packet for transmission to the VPN server. The process might include any encapsulation specific to the VPN protocol.

GetKeepAlivePayload(VpnChannel, VpnPacketBuffer) GetKeepAlivePayload(VpnChannel, VpnPacketBuffer) GetKeepAlivePayload(VpnChannel, VpnPacketBuffer) GetKeepAlivePayload(VpnChannel, VpnPacketBuffer) GetKeepAlivePayload(VpnChannel, VpnPacketBuffer)

This method instructs the VPN plug-in to compute and return a Keep alive payload ready to be sent to the VPN server.