• Articles
  • API Documentation
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 WireGuardConnectionConfigurationBuilder

    Class WireGuardConnectionConfigurationBuilder. Builder for an IConnectionConfiguration object.

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

    Methods

    Build()

    Builds an based off this instance.

    Declaration
    public IConnectionConfiguration Build()
    Returns
    Type Description
    IConnectionConfiguration

    IConnectionConfiguration.

    SetBlockUntunneledTraffic(Boolean)

    Defines if untunneled traffic is blocked or not.

    Declaration
    public WireGuardConnectionConfigurationBuilder SetBlockUntunneledTraffic(bool blockUntunneledTraffic)
    Parameters
    Type Name Description
    System.Boolean blockUntunneledTraffic

    When true, blocks all traffic that is neither to nor from the tunnel interface or is to the wrong DNS server.

    Returns
    Type Description
    WireGuardConnectionConfigurationBuilder

    WireGuardConnectionConfigurationBuilder.

    SetDoubleHopSettings(Boolean, ILocation, ILocation)

    Sets the double hop settings for the WireGuard connection configuration.

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

    A boolean value 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
    WireGuardConnectionConfigurationBuilder

    The WireGuardConnectionConfigurationBuilder for method chaining.

    SetMtu(Nullable<Int32>)

    Sets the Maximum Transmission Unit (MTU) for the WireGuard connection configuration.

    Declaration
    public WireGuardConnectionConfigurationBuilder SetMtu(int? mtu)
    Parameters
    Type Name Description
    System.Nullable<System.Int32> mtu

    The MTU value to set. The valid range is 1300 to 65535 bytes.

    Returns
    Type Description
    WireGuardConnectionConfigurationBuilder

    The current instance of WireGuardConnectionConfigurationBuilder for fluent configuration.

    SetServiceStartTimeout(Int16)

    Sets the service start timeout. Default is 30 seconds. The valid range is between 10 and 60 seconds.

    Declaration
    public WireGuardConnectionConfigurationBuilder SetServiceStartTimeout(short serviceStartTimeout)
    Parameters
    Type Name Description
    System.Int16 serviceStartTimeout

    The service start timeout.

    Returns
    Type Description
    WireGuardConnectionConfigurationBuilder

    WireGuardConnectionConfigurationBuilder.

    Validate()

    Validates the configuration settings, including MTU (Maximum Transmission Unit) value.

    Declaration
    protected override void Validate()
    Overrides
    ConnectionConfigurationBuilderBase.Validate()
    In This Article
    Back to top VpnSDK v2 Documentation - © 2023 WLVPN