Package com.wireguard.android.backend

Class GoBackend

java.lang.Object

com.wireguard.android.backend.GoBackend

All Implemented Interfaces:

Backend

public final class GoBackend
extends java.lang.Object
implements Backend

Implementation of Backend that uses the wireguard-go userspace implementation to provide WireGuard tunnels.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GoBackend.AlwaysOnCallback	Callback for GoBackend that is invoked when GoBackend.VpnService is started by the system's Always-On VPN mode.
static class	GoBackend.VpnService	VpnService implementation for GoBackend

Constructor Summary

Constructors

Constructor	Description
GoBackend(android.content.Context context)	Public constructor for GoBackend.

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	getRunningTunnelNames()	Method to get the names of running tunnels.
int	getState()
Tunnel.State	getState(Tunnel tunnel)	Get the associated Tunnel.State for a given Tunnel.
Statistics	getStatistics(Tunnel tunnel)	Get the associated Statistics for a given Tunnel.
java.lang.String	getVersion()	Get the version of the underlying wireguard-go library.
static void	setAlwaysOnCallback(GoBackend.AlwaysOnCallback cb)	Set a GoBackend.AlwaysOnCallback to be invoked when GoBackend.VpnService is started by the system's Always-On VPN mode.
void	setNetworkAvailable(boolean available)
Tunnel.State	setState(Tunnel tunnel, Tunnel.State state, Config config)	Change the state of a given Tunnel, optionally applying a given Config.
Tunnel.State	setState(Tunnel tunnel, Tunnel.State state, Config config, java.lang.String socketType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GoBackend

public GoBackend(android.content.Context context)

Public constructor for GoBackend.

Parameters:

context - An Android Context

Method Detail

setAlwaysOnCallback

public static void setAlwaysOnCallback(GoBackend.AlwaysOnCallback cb)

Set a GoBackend.AlwaysOnCallback to be invoked when GoBackend.VpnService is started by the system's Always-On VPN mode.

Parameters:

cb - Callback to be invoked

getRunningTunnelNames

public java.util.Set<java.lang.String> getRunningTunnelNames()

Method to get the names of running tunnels.

Specified by:

getRunningTunnelNames in interface Backend

Returns:

A set of string values denoting names of running tunnels.

getState

public Tunnel.State getState(Tunnel tunnel)

Get the associated Tunnel.State for a given Tunnel.

Specified by:

getState in interface Backend

Parameters:

tunnel - The tunnel to examine the state of.

Returns:

Tunnel.State associated with the given tunnel.

getStatistics

public Statistics getStatistics(Tunnel tunnel)

Get the associated Statistics for a given Tunnel.

Specified by:

getStatistics in interface Backend

Parameters:

tunnel - The tunnel to retrieve statistics for.

Returns:

Statistics associated with the given tunnel.

setNetworkAvailable

public void setNetworkAvailable(boolean available)

getState

public int getState()

getVersion

public java.lang.String getVersion()

Get the version of the underlying wireguard-go library.

Specified by:

getVersion in interface Backend

Returns:

String value of the version of the wireguard-go library.

setState

public Tunnel.State setState(Tunnel tunnel,
                             Tunnel.State state,
                             @Nullable
                             Config config)
                      throws java.lang.Exception

Change the state of a given Tunnel, optionally applying a given Config.

Specified by:

setState in interface Backend

Parameters:

tunnel - The tunnel to control the state of.

state - The new state for this tunnel. Must be UP, DOWN, or TOGGLE.

config - The configuration for this tunnel, may be null if state is DOWN.

Returns:

Tunnel.State of the tunnel after state changes are applied.

Throws:

java.lang.Exception - Exception raised while changing tunnel state.

setState

public Tunnel.State setState(Tunnel tunnel,
                             Tunnel.State state,
                             @Nullable
                             Config config,
                             @NonNull
                             java.lang.String socketType)
                      throws java.lang.Exception

Throws:

java.lang.Exception