Categorygithub.com/v2fly/v2ray-core/v5
modulepackage
5.29.1
Repository: https://github.com/v2fly/v2ray-core.git
Documentation: pkg.go.dev
Overview
Versions
6
Dependencies
39
Dependents
64
Files
1k SLOC

# README

V2Ray

Project V

Project V is a set of network tools that helps you to build your own computer network. It secures your network connections and thus protects your privacy.

GitHub Test Badge codecov.io codebeat Codacy Badge Downloads

Related Links

Packaging Status

If you are willing to package V2Ray for other distros/platforms, please let us know or seek for help via GitHub issues.

Packaging status

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
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.
No description provided by the author
Dial provides an easy way for upstream caller to create net.Conn through V2Ray.
DialUDP provides a way to exchange UDP packets through V2Ray instance to remote servers.
FromContext returns an Instance from the given context, or nil if the context doesn't contain one.
GetAllExtensions get all extensions supported.
GetLoaderExtensions get config loader extensions.
LoadConfig loads multiple config with given format from given source.
MustFromContext returns an Instance from the given context, or panics if not present.
New returns a new V2Ray instance based on given configuration.
No description provided by the author
RegisterConfigLoader add a new ConfigLoader.
No description provided by the author
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.
ToBackgroundDetachedContext create a detached context from another context Internal API */.
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

FormatAuto represents all available formats by auto selecting.
FormatJSON represents json format.
FormatProtobuf represents protobuf format.
FormatProtobufShort is the short of FormatProtobuf.
FormatTOML represents toml format.
FormatYAML represents yaml format.

# Variables

No description provided by the author

# Structs

Annotation is a concept in V2Ray.
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.

# Interfaces

Server is an instance of V2Ray.

# Type aliases

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