• Guides & Articles
  • API Documentation

    Show / Hide Table of Contents
    • VpnSDK.Public
      • OpenVpnConfiguration
      • OpenVpnConnectionConfigurationBuilder
      • PositionInfoEventArgs
      • RasConfiguration
      • RasConnectionConfigurationBuilder
      • SDKBuilder
    • VpnSDK.Public.Enums
      • AuthenticationStatus
      • ConnectionStatus
      • NetworkConnectionType
      • NetworkProtocolType
      • OpenVpnCipherType
      • PositionInfoStatus
      • RefreshLocationListStatus
    • VpnSDK.Public.Exceptions
      • VpnSDKAPIException
      • VpnSDKAuthenticationException
      • VpnSDKBaseException
      • VpnSDKConnectionAlreadyEstablishedException
      • VpnSDKConnectionException
      • VpnSDKConnectionTerminatedException
      • VpnSDKCoreException
      • VpnSDKEmptyAvailableVpnProtocolsException
      • VpnSDKFetchLocationsException
      • VpnSDKInvalidConfigurationException
      • VpnSDKNotAuthorizedException
      • VpnSDKNullLocationException
      • VpnSDKOAuthException
      • VpnSDKUnsupportedProtocolException
      • VpnSDKVPNAuthenticationException
    • VpnSDK.Public.Extensions
      • ExceptionExtensions
      • LoadLevel
      • RegionLoadChecker
    • VpnSDK.Public.Helpers
      • VpnProtocolDiagnostics
    • VpnSDK.Public.Interfaces
      • IBestAvailable
      • IConnectionConfiguration
      • ILocation
      • IOpenVpnConnectionConfiguration
      • IRasConnectionConfiguration
      • IRegion
      • ISDK
      • IServer
      • IUser
    • VpnSDK.Public.Messages
      • RefreshLocationListMessage

    Class OpenVpnConnectionConfigurationBuilder

    Class OpenVpnConnectionConfigurationBuilder. Builder for an OpenVPN IConnectionConfiguration object.

    Inheritance
    Object
    OpenVpnConnectionConfigurationBuilder
    Namespace: VpnSDK.Public
    Assembly: VpnSDK.dll
    Syntax
    public class OpenVpnConnectionConfigurationBuilder

    Methods

    Build()

    Builds an IConnectionConfiguration based off this instance.

    Declaration
    public IConnectionConfiguration Build()
    Returns
    Type Description
    IConnectionConfiguration

    IConnectionConfiguration.

    Exceptions
    Type Condition
    InvalidOperationException

    Cipher must be set to AES-128 when scramble is enabled.

    SetCipher(OpenVpnCipherType)

    Sets the OpenVPN cipher.

    Declaration
    public OpenVpnConnectionConfigurationBuilder SetCipher(OpenVpnCipherType cipherType)
    Parameters
    Type Name Description
    OpenVpnCipherType cipherType

    Type of the cipher.

    Returns
    Type Description
    OpenVpnConnectionConfigurationBuilder

    OpenVpnConnectionConfigurationBuilder.

    SetNetworkProtocol(NetworkProtocolType)

    Sets the network protocol.

    Declaration
    public OpenVpnConnectionConfigurationBuilder SetNetworkProtocol(NetworkProtocolType protocol)
    Parameters
    Type Name Description
    NetworkProtocolType protocol

    The protocol.

    Returns
    Type Description
    OpenVpnConnectionConfigurationBuilder

    OpenVpnConnectionConfigurationBuilder.

    SetScramble(Boolean)

    Sets whether to use XOR-based traffic scrambling or not.

    Declaration
    public OpenVpnConnectionConfigurationBuilder SetScramble(bool scramble)
    Parameters
    Type Name Description
    Boolean scramble

    if set to true traffic scrambling is enabled.

    Returns
    Type Description
    OpenVpnConnectionConfigurationBuilder

    OpenVpnConnectionConfigurationBuilder.

    Back to top Pre-release documentation. These do not represent the final product and are subject to change.