Categorygithub.com/xiaochunyong/v2ray-core
modulepackage
3.25.1+incompatible
Repository: https://github.com/xiaochunyong/v2ray-core.git
Documentation: pkg.go.dev

# README

Project V

Build 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

No description provided by the author
Package common contains common utilities that are shared among other packages.
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.
DefaultPolicy returns the Policy when user is not specified.
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.
GetOrRegisterStatCounter tries to get the StatCounter first.
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.
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.

# Variables

ErrNoClue is for the situation that existing information is not enough to make a decision.

# Structs

BufferPolicy contains settings for internal buffer.
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.
Link is a utility for connecting between an inbound and an outbound proxy handler.
OutboundHandlerConfig is the configuration for outbound handler.
PluginMetadata contains some brief information regarding a plugin.
Policy is session based settings for controlling V2Ray requests.
StatsPolicy contains settings for stats counters.
SystemPolicy contains policy settings at system level.
SystemStatsPolicy contains stat policy settings on system level.
TimeoutPolicy contains limits for connection timeout.

# Interfaces

Dispatcher is a feature that dispatches inbound requests to outbound handlers based on rules.
DNSClient is a V2Ray feature for querying DNS information.
Feature is the interface for V2Ray features.
InboundHandler is the interface for handlers that process inbound connections.
InboundHandlerManager is a feature that manages InboundHandlers.
OutboundHandler is the interface for handlers that process outbound connections.
OutboundHandlerManager is a feature that manages OutboundHandlers.
PolicyManager is a feature that provides Policy for the given user by its id or level.
Router is a feature to choose an outbound tag for the given request.
Server is an instance of V2Ray.
No description provided by the author
No description provided by the author

# 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.