• Articles
  • API Documentation
  • VpnSDK
  • OpenVpnConnectionConfigurationBuilder
Search Results for

    Show / Hide Table of Contents
    • VpnSDK
      • AccountMetadataException
      • APIException
      • ApiTimeoutException
      • AuthenticationException
      • BaseSDKException
      • ConnectionAlreadyEstablishedException
      • ConnectionConfigurationBuilderBase
      • ConnectionException
      • ConnectionTerminatedException
      • CoreException
      • DataTransferEventArgs
      • DnsConfigurationException
      • DoubleHopException
      • DoubleHopNotAvailableException
      • EmptyAvailableVpnProtocolsException
      • EndpointsUnreachableException
      • FetchLocationsException
      • HTTPException
      • InvalidAccountException
      • InvalidConfigurationException
      • InvalidDoubleHopConfigurationException
      • InvalidServerException
      • NotAuthorizedException
      • NotElevatedException
      • NullLocationException
      • OAuthException
      • OpenVpnConnectionConfigurationBuilder
      • RasConnectionConfigurationBuilder
      • ReconnectOnPowerEventException
      • SDKBuilder<T>
      • SDKChangeEventHandler<T>
      • SDKEventHandler
      • SDKEventHandler<T>
      • SDKOperationEventHandler
      • SDKOperationEventHandler<T>
      • ServerListException
      • TapAdapterException
      • UnknownErrorException
      • UnsupportedProtocolException
      • VPNAuthenticationException
      • VpnException
      • VpnHostServiceException
      • VpnHostServiceFileNotFoundException
      • WFPException
      • WireGuardAPIException
      • WireGuardConnectionConfigurationBuilder
    • VpnSDK.Common.Dns
      • DnsResolutionResult
      • IDnsRequestResolver
    • VpnSDK.Common.Enums
      • SplitTunnelMode
    • VpnSDK.Common.Settings
      • SplitTunnelApp
      • SplitTunnelDomain
    • VpnSDK.DTO
      • ApiHttpError
      • ApiProxyError
      • ConnectionError
      • ISDKError
      • NetworkGeolocation
      • OpenVpnConfiguration
      • RasConfiguration
      • WireguardConfiguration
    • VpnSDK.Enums
      • AccountStatus
      • AuthenticationStatus
      • ConnectionStatus
      • DnsFilteringMode
      • DriverInstallResult
      • DriverUninstallResult
      • ErrorType
      • LoadLevel
      • NetworkConnectionType
      • NetworkProtocolType
      • OpenVpnCipherType
      • OpenVpnLogLevel
      • OperationStatus
      • RefreshLocationListStatus
    • VpnSDK.Extensions
      • ExceptionExtensions
      • LocationExtensions
      • RegionLoadChecker
    • VpnSDK.Helpers
      • BatchPingUtility
      • VersionHelper
      • VpnProtocolDiagnostics
    • VpnSDK.Interfaces
      • IBestAvailable
      • IConnectionConfiguration
      • IConnectionInfo
      • IDoubleHopConfiguration
      • ILocation
      • IOpenVpnConnectionConfiguration
      • IRasConnectionConfiguration
      • IRegion
      • ISDK
      • IUser
      • IWireGuardConnectionConfiguration

    Class OpenVpnConnectionConfigurationBuilder

    Class OpenVpnConnectionConfigurationBuilder. Builder for an OpenVPN IConnectionConfiguration object.

    Inheritance
    System.Object
    ConnectionConfigurationBuilderBase
    OpenVpnConnectionConfigurationBuilder
    Inherited Members
    ConnectionConfigurationBuilderBase.IsDoubleHopEnabled
    ConnectionConfigurationBuilderBase.EntryLocation
    ConnectionConfigurationBuilderBase.ExitLocation
    ConnectionConfigurationBuilderBase.Validate()
    Namespace: VpnSDK
    Assembly: cs.temp.dll.dll
    Syntax
    public class OpenVpnConnectionConfigurationBuilder : ConnectionConfigurationBuilderBase

    Methods

    Build()

    Builds an IConnectionConfiguration based off this instance.

    Declaration
    public IConnectionConfiguration Build()
    Returns
    Type Description
    IConnectionConfiguration

    IConnectionConfiguration.

    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.

    SetDoubleHopSettings(Boolean, ILocation, ILocation)

    Sets the double hop settings for the OpenVPN connection.

    Declaration
    public OpenVpnConnectionConfigurationBuilder SetDoubleHopSettings(bool isEnabled, ILocation entryLocation, ILocation exitLocation)
    Parameters
    Type Name Description
    System.Boolean isEnabled

    A boolean indicating whether double hop is enabled.

    ILocation entryLocation

    The entry location for double hop.

    ILocation exitLocation

    The exit location for double hop.

    Returns
    Type Description
    OpenVpnConnectionConfigurationBuilder

    The OpenVpnConnectionConfigurationBuilder for method chaining.

    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.

    SetPort(UInt16)

    Sets remote port.

    Declaration
    public OpenVpnConnectionConfigurationBuilder SetPort(ushort port)
    Parameters
    Type Name Description
    System.UInt16 port

    The port.

    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
    System.Boolean scramble

    if set to true traffic scrambling is enabled.

    Returns
    Type Description
    OpenVpnConnectionConfigurationBuilder

    OpenVpnConnectionConfigurationBuilder.

    In This Article
    • Methods
      • Build()
      • SetCipher(OpenVpnCipherType)
      • SetDoubleHopSettings(Boolean, ILocation, ILocation)
      • SetNetworkProtocol(NetworkProtocolType)
      • SetPort(UInt16)
      • SetScramble(Boolean)
    Back to top VpnSDK v2 Documentation - © 2023 WLVPN