Language

VpnService.Builder Class

Definition

Helper class to create a VPN interface.

[Android.Runtime.Register("android/net/VpnService$Builder", DoNotGenerateAcw=true)]
public class VpnService.Builder : Java.Lang.Object
[<Android.Runtime.Register("android/net/VpnService$Builder", DoNotGenerateAcw=true)>]
type VpnService.Builder = class
    inherit Object
Inheritance
VpnService.Builder
Attributes

Remarks

Helper class to create a VPN interface. This class should be always used within the scope of the outer VpnService.

Java documentation for android.net.VpnService.Builder.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Name Description
VpnService.Builder(IntPtr, JniHandleOwnership)

A constructor used when creating managed representations of JNI objects; called by the runtime.

VpnService.Builder(VpnService)

Initializes a new instance of VpnService.Builder.

Properties

Name Description
Class

Returns the runtime class of this Object.

(Inherited from Object)
Handle

The handle to the underlying Android instance.

(Inherited from Object)
JniIdentityHashCode

Gets the identity hash code assigned to this Java peer by the interop runtime.

(Inherited from Object)
JniManagedPeerState

Gets the state flags last assigned by the runtime.

(Inherited from JavaObject)
JniPeerMembers

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

PeerReference

Gets the JNI object reference for this Java peer.

(Inherited from Object)
ThresholdClass

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

ThresholdType

This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Name Description
AddAddress(InetAddress, Int32)

Add a network address to the VPN interface.

AddAddress(String, Int32)

Convenience method to add a network address to the VPN interface using a numeric address string.

AddAllowedApplication(String)

Adds an application allowed to use the VPN.

AddDisallowedApplication(String)

Adds an application denied access to the VPN.

AddDnsServer(InetAddress)

Add a DNS server to the VPN connection.

AddDnsServer(String)

Convenience method to add a DNS server to the VPN connection using a numeric address string.

AddRoute(InetAddress, Int32)

Add a network route to the VPN interface.

AddRoute(IpPrefix)

Adds the specified route.

AddRoute(String, Int32)

Convenience method to add a network route to the VPN interface using a numeric address string.

AddSearchDomain(String)

Add a search domain to the DNS resolver.

AllowBypass()

Allows all apps to bypass this VPN connection.

AllowFamily(Int32)

Allows traffic from the specified address family.

Clone()

Creates and returns a copy of this object.

(Inherited from Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

Delegates construction of this peer to the runtime's value manager.

(Inherited from JavaObject)
Dispose()

Releases the resources held by this Java peer.

(Inherited from Object)
Dispose(Boolean)

Releases the resources held by this Java peer.

(Inherited from Object)
DisposeUnlessReferenced()

Asks the value manager to dispose this peer unless its mapping retains this same managed instance.

(Inherited from JavaObject)
Equals(Object)

Tests whether another managed peer refers to the same Java object.

(Inherited from JavaObject)
Equals(Object)

Indicates whether some other object is "equal to" this one.

(Inherited from Object)
Establish()

Create a VPN interface using the parameters supplied to this builder.

ExcludeRoute(IpPrefix)

Exclude a network route from the VPN interface.

GetHashCode()

Returns a hash code value for the object.

(Inherited from Object)
JavaFinalize()
Obsolete.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

(Inherited from Object)
Notify()

Wakes up a single thread that is waiting on this object's monitor.

(Inherited from Object)
NotifyAll()

Wakes up all threads that are waiting on this object's monitor.

(Inherited from Object)
SetBlocking(Boolean)

Sets whether the VPN interface file descriptor uses blocking I/O.

SetConfigureIntent(PendingIntent)

Set the PendingIntent to an activity for users to configure the VPN connection.

SetHandle(IntPtr, JniHandleOwnership)

Sets the Handle property.

(Inherited from Object)
SetHttpProxy(ProxyInfo)

Sets the http proxy.

SetMetered(Boolean)

Sets whether the VPN is treated as metered.

SetMtu(Int32)

Set the maximum transmission unit (MTU) of the VPN interface.

SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

Stores a reference value in the control block without creating a JNI reference copy.

(Inherited from JavaObject)
SetSession(String)

Set the name of this session.

SetUnderlyingNetworks(Network[])

Sets the networks underlying the VPN.

ToArray<T>()

Creates a managed array from this Java array wrapper.

(Inherited from Object)
ToString()

Returns a string representation of the object.

(Inherited from Object)
UnregisterFromRuntime()

Unregisters this Java peer from the interop runtime.

(Inherited from Object)
Wait()

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed.

(Inherited from Object)

Explicit Interface Implementations

Name Description
IJavaPeerable.Disposed()

Marks this peer as disposed and calls Dispose with disposing set to true.

(Inherited from JavaObject)
IJavaPeerable.Finalized()

Marks this peer as disposed and calls Dispose with disposing set to false.

(Inherited from JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

Gets the native control-block pointer used by this peer.

(Inherited from JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

Stores the identity hash code supplied by the runtime.

(Inherited from JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

Replaces the stored managed peer state flags.

(Inherited from JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

Updates the peer reference and releases a disposed peer's control block when the reference is invalid.

(Inherited from JavaObject)

Extension Methods

Name Description
GetJniTypeName(IJavaPeerable)

Gets the JNI name of the type of the instance self.

JavaAs<TResult>(IJavaPeerable)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

JavaCast<TResult>(IJavaObject)

Performs an Android runtime-checked type conversion.

JavaCast<TResult>(IJavaObject)

Reuses a compatible managed peer or obtains a wrapper of the requested type.

TryJavaCast<TResult>(IJavaPeerable, TResult)

Try to coerce self to type TResult, checking that the coercion is valid on the Java side.

Applies to