Categorygithub.com/gopherty/v2ray-core
modulepackage
3.50.2+incompatible
Repository: https://github.com/gopherty/v2ray-core.git
Documentation: pkg.go.dev
Overview
Versions
4
Dependencies
25
Dependents
0
Files
722 SLOC

# README

Project V

Build Status AppVeyor Run Status codecov.io Go Report 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:

# Packages

Package app contains feature implementations of V2Ray.
Package common contains common utilities that are shared among other packages.
No description provided by the author
No description provided by the author
Package proxy contains all proxies used by V2Ray.
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 V2Ray instance and config.
Dial provides an easy way for upstream caller to create net.Conn through V2Ray.
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.
LoadPlugins loads all possible plugins in the 'plugin' directory.
MustFromContext returns an Instance from the given context, or panics if not present.
New returns a new V2Ray 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 V2Ray instance with given serialized config.
Version returns V2Ray'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.

# Constants

GetMetadataFuncName is the name of the function in the plugin to return PluginMetadata.

# Structs

Config is the master config of V2Ray.
ConfigFormat is a configurable format of V2Ray config file.
InboundHandlerConfig is the configuration for inbound handler.
Instance combines all functionalities in V2Ray.
OutboundHandlerConfig is the configuration for outbound handler.
PluginMetadata contains some brief information regarding a plugin.

# Interfaces

Server is an instance of V2Ray.

# Type aliases

ConfigLoader is a utility to load V2Ray config from external source.
GetMetadataFunc is the type of the function in the plugin to return PluginMetadata.