Categorygithub.com/tutacc/tutacc-core
modulepackage
4.23.4+incompatible
Repository: https://github.com/tutacc/tutacc-core.git
Documentation: pkg.go.dev
Overview
Versions
5
Dependencies
27
Dependents
26
Files
712 SLOC

# README

Project V

Build Status codecov.io GoDoc codebeat Downloads

Project V is a set of network tools that help you to build your own computer network. It secures your network connections and thus protects your privacy. See our website for more information.

License

The MIT License (MIT)

Credits

This repo relies on the following third-party projects:

Usage

docker run -d \
    --cap-add=NET_ADMIN \
    --restart=always \
    --network=host \
    -v /etc/tutacc:/etc/tutacc \
    --name tutacc \
    tutacc/tutacc-core

# Packages

Package app contains feature implementations of Tutacc.
Package common contains common utilities that are shared among other packages.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package proxy contains all proxies used by Tutacc.
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
CreateObject creates a new object based on the given Tutacc instance and config.
Dial provides an easy way for upstream caller to create net.Conn through Tutacc.
DialUDP provides a way to exchange UDP packets through Tutacc instance to remote servers.
FromContext returns an Instance from the given context, or nil if the context doesn't contain one.
LoadConfig loads config with given format from given source.
MustFromContext returns an Instance from the given context, or panics if not present.
New returns a new Tutacc instance based on given configuration.
RegisterConfigLoader add a new ConfigLoader.
RequireFeatures is a helper function to require features from Instance in context.
ServerType returns the type of the server.
StartInstance starts a new Tutacc instance with given serialized config.
Version returns Tutacc's version as a string, in the form of "x.y.z" where x, y and z are numbers.
VersionStatement returns a list of strings representing the full version info.

# Structs

Annotation is a concept in Tutacc.
Config is the master config of Tutacc.
ConfigFormat is a configurable format of Tutacc config file.
InboundHandlerConfig is the configuration for inbound handler.
Instance combines all functionalities in Tutacc.
OutboundHandlerConfig is the configuration for outbound handler.

# Interfaces

Server is an instance of Tutacc.

# Type aliases

ConfigLoader is a utility to load Tutacc config from external source.