mutagenio

package

v0.11.8 Latest Latest Go to latest Published: Oct 20, 2020 License: MIT Imports: 13 Imported by: 0

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

Repository

github.com/mutagen-io/mutagen

Links

Open Source Insights

Documentation ¶

Overview ¶

Package mutagenio provides infrastructure for interfacing with mutagen.io.

Index ¶

Constants
Variables
func ExtractTokenScheme(token string) (string, error)
func Login(apiToken string) error
func Logout() error
func TunnelClientExchangeFinish(ctx context.Context, ...) error
func TunnelClientExchangeStart(ctx context.Context, tunnelID, clientToken string) (string, string, string, error)
func TunnelCreate(ctx context.Context) (string, string, string, error)
func TunnelHostExchange(ctx context.Context, tunnelID, hostToken, offer, signature string) (string, string, error)

Constants ¶

View Source

const (

	// TokenSchemeAPI is the scheme name for API tokens.
	TokenSchemeAPI = "api"
)

Variables ¶

View Source

var (
	// ErrUnauthorized is a sentinel error returned if an API endpoint returns
	// a 401 (Unauthorized) status code.
	ErrUnauthorized = errors.New("unauthorized")
)

Functions ¶

func ExtractTokenScheme ¶

func ExtractTokenScheme(token string) (string, error)

ExtractTokenScheme parses a mutagen.io token (without validation) and returns the token scheme.

func Login(apiToken string) error

Login stores the provided API token for use in API requests. It replaces any existing API token.

func Logout ¶

func Logout() error

Logout ensures that any stored API token is cleared. If no existing API token is present, Logout is a no-op.

func TunnelClientExchangeFinish ¶

func TunnelClientExchangeFinish(ctx context.Context, tunnelID, clientToken, exchangeID, offer, signature string) error

TunnelClientExchangeFinish performs completion of the client side of a tunnel offer exchange.

func TunnelClientExchangeStart ¶

func TunnelClientExchangeStart(ctx context.Context, tunnelID, clientToken string) (string, string, string, error)

TunnelClientExchangeStart performs initiation of the client side of a tunnel offer exchange.

func TunnelCreate ¶

func TunnelCreate(ctx context.Context) (string, string, string, error)

TunnelCreate creates a new tunnel using the underlying API key. It returns the tunnel identifier, host token, and client token.

func TunnelHostExchange ¶

func TunnelHostExchange(ctx context.Context, tunnelID, hostToken, offer, signature string) (string, string, error)

TunnelHostExchange performs the host side of a tunnel offer exchange.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL