vpn

package

v0.0.0-...-c936f35 Latest Latest Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 5 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package vpn provides an i3bar module for openvpn information.

This section is empty.

This section is empty.

This section is empty.

type Module struct {
	// contains filtered or unexported fields
}

Module represents a VPN bar module.

func DefaultInterface() *Module

DefaultInterface constructs an instance of the VPN module for "tun0", the usual interface for VPNs.

func New(iface string) *Module

New constructs an instance of the VPN module for the specified interface.

func (m *Module) Output(outputFunc func(State) bar.Output) *Module

Output configures a module to display the output of a user-defined function.

func (m *Module) Stream(s bar.Sink)

Stream starts the module.

type State int

State represents the vpn state.

const (
	Disconnected State = iota
	Waiting
	Connected
)

Valid states for the vpn

func (s State) Connected() bool

Connected returns true if the VPN is connected.

func (s State) Disconnected() bool

Disconnected returns true if the VPN is off.