core

README

Project V2Ray

[![Build Status][1]][2] [![codecov.io][3]][4] [![Go Report][5]][6] [![GoDoc][7]][8] [![codebeat][9]][10] [1]: https://travis-ci.org/v2ray/v2ray-core.svg?branch=master "Build Status badge" [2]: https://travis-ci.org/v2ray/v2ray-core "Travis-CI Build Status" [3]: https://codecov.io/github/v2ray/v2ray-core/coverage.svg?branch=master "Coverage badge" [4]: https://codecov.io/github/v2ray/v2ray-core?branch=master "Codecov Status" [5]: https://goreportcard.com/badge/v2ray.com/core "Go Report badge" [6]: https://goreportcard.com/report/v2ray.com/core "Go Report" [7]: https://godoc.org/v2ray.com/core?status.svg "GoDoc badge" [8]: https://godoc.org/v2ray.com/core "GoDoc" [9]: https://codebeat.co/badges/f2354ca8-3e24-463d-a2e3-159af73b2477 "Codebeat badge" [10]: https://codebeat.co/projects/github-com-v2ray-v2ray-core "Codebeat"

V2Ray 是一个模块化的代理软件包，它的目标是提供常用的代理软件模块，简化网络代理软件的开发。

官方网站

V2Ray provides building blocks for network proxy development. Read our Wiki for more information.

License

The MIT License (MIT)

Documentation

Overview

Package core provides common definitions and functionalities of V2Ray.

Index

• Variables
• func PrintVersion()
• func RegisterConfigLoader(format ConfigFormat, loader ConfigLoader) error
• func Version() string
• type Config
  • func LoadConfig(format ConfigFormat, input io.Reader) (*Config, error)
  • func LoadProtobufConfig(input io.Reader) (*Config, error)
  • func (*Config) Descriptor() ([]byte, []int)
  • func (m *Config) GetApp() []*v2ray_core_common_serial.TypedMessage
  • func (m *Config) GetInbound() []*v2ray_core_app_proxyman.InboundHandlerConfig
  • func (m *Config) GetLog() *v2ray_core_common_log.Config
  • func (m *Config) GetOutbound() []*v2ray_core_app_proxyman.OutboundHandlerConfig
  • func (m *Config) GetTransport() *v2ray_core_transport.Config
  • func (*Config) ProtoMessage()
  • func (m *Config) Reset()
  • func (m *Config) String() string
• type ConfigFormat
  • func (ConfigFormat) EnumDescriptor() ([]byte, []int)
  • func (x ConfigFormat) String() string
• type ConfigLoader
• type Point
  • func NewPoint(pConfig *Config) (*Point, error)
  • func (v *Point) Close()
  • func (v *Point) Start() error

Variables

var ConfigFormat_name = map[int32]string{
	0: "Protobuf",
	1: "JSON",
}

var ConfigFormat_value = map[string]int32{
	"Protobuf": 0,
	"JSON":     1,
}

Functions

func PrintVersion

func PrintVersion()

func RegisterConfigLoader

func RegisterConfigLoader(format ConfigFormat, loader ConfigLoader) error

func Version

func Version() string

Version returns V2Ray's version as a string.

Types

type Config

type Config struct {
	// Inbound handler configurations. Must have at least one item.
	Inbound []*v2ray_core_app_proxyman.InboundHandlerConfig `protobuf:"bytes,1,rep,name=inbound" json:"inbound,omitempty"`
	// Outbound handler configurations. Must have at least one item. The first item is used as default for routing.
	Outbound []*v2ray_core_app_proxyman.OutboundHandlerConfig `protobuf:"bytes,2,rep,name=outbound" json:"outbound,omitempty"`
	Log      *v2ray_core_common_log.Config                    `protobuf:"bytes,3,opt,name=log" json:"log,omitempty"`
	// App configuration. Must be one in the app directory.
	App       []*v2ray_core_common_serial.TypedMessage `protobuf:"bytes,4,rep,name=app" json:"app,omitempty"`
	Transport *v2ray_core_transport.Config             `protobuf:"bytes,5,opt,name=transport" json:"transport,omitempty"`
}

func LoadConfig

func LoadConfig(format ConfigFormat, input io.Reader) (*Config, error)

func LoadProtobufConfig

func LoadProtobufConfig(input io.Reader) (*Config, error)

func (*Config) Descriptor

func (*Config) Descriptor() ([]byte, []int)

func (*Config) GetApp

func (m *Config) GetApp() []*v2ray_core_common_serial.TypedMessage

func (*Config) GetInbound

func (m *Config) GetInbound() []*v2ray_core_app_proxyman.InboundHandlerConfig

func (*Config) GetLog

func (m *Config) GetLog() *v2ray_core_common_log.Config

func (*Config) GetOutbound

func (m *Config) GetOutbound() []*v2ray_core_app_proxyman.OutboundHandlerConfig

func (*Config) GetTransport

func (m *Config) GetTransport() *v2ray_core_transport.Config

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) Reset

func (m *Config) Reset()

func (*Config) String

func (m *Config) String() string

type ConfigFormat

type ConfigFormat int32

Configuration serialization format.

const (
	ConfigFormat_Protobuf ConfigFormat = 0
	ConfigFormat_JSON     ConfigFormat = 1
)

func (ConfigFormat) EnumDescriptor

func (ConfigFormat) EnumDescriptor() ([]byte, []int)

func (ConfigFormat) String

func (x ConfigFormat) String() string

type ConfigLoader

type ConfigLoader func(input io.Reader) (*Config, error)

type Point

type Point struct {
	// contains filtered or unexported fields
}

Point shell of V2Ray.

func NewPoint

func NewPoint(pConfig *Config) (*Point, error)

NewPoint returns a new Point server based on given configuration. The server is not started at this point.

func (*Point) Close

func (v *Point) Close()

func (*Point) Start

func (v *Point) Start() error

Start starts the Point server, and return any error during the process. In the case of any errors, the state of the server is unpredicatable.