Merge branch 'master' of https://github.com/v2ray/v2ray-core

common/buf/buffer_pool.go

@@ -118,7 +118,7 @@ func getDefaultPoolSize() uint32 {
 }
 
 func init() {
-	var size uint32 = getDefaultPoolSize()
+	size := getDefaultPoolSize()
 	sizeStr := os.Getenv(poolSizeEnvKey)
 	if len(sizeStr) > 0 {
 		customSize, err := strconv.ParseUint(sizeStr, 10, 32)

common/buf/buffered_reader.go

@@ -11,7 +11,7 @@ type BufferedReader struct {
 	buffered bool
 }
 
-// NewReader creates a new BufferedReader based on an io.Reader.
+// NewBufferedReader creates a new BufferedReader based on an io.Reader.
 func NewBufferedReader(rawReader io.Reader) *BufferedReader {
 	return &BufferedReader{
 		reader:   rawReader,

common/buf/buffered_writer.go

@@ -14,7 +14,7 @@ type BufferedWriter struct {
 	buffered bool
 }
 
-// NewWriter creates a new BufferedWriter.
+// NewBufferedWriter creates a new BufferedWriter.
 func NewBufferedWriter(rawWriter io.Writer) *BufferedWriter {
 	return &BufferedWriter{
 		writer:   rawWriter,

common/buf/buffered_writer_test.go

@@ -24,7 +24,7 @@ func TestBufferedWriter(t *testing.T) {
 
 	assert.Bool(content.IsEmpty()).IsTrue()
 
-	writer.SetBuffered(false)
+	assert.Error(writer.SetBuffered(false)).IsNil()
 	assert.Int(content.Len()).Equals(16)
 }
 

common/buf/io.go

@@ -76,7 +76,7 @@ func NewReader(reader io.Reader) Reader {
 
 // ToBytesReader converts a Reaaer to io.Reader.
 func ToBytesReader(stream Reader) io.Reader {
-	return &BufferToBytesReader{
+	return &bufferToBytesReader{
 		stream: stream,
 	}
 }
@@ -90,7 +90,7 @@ func NewWriter(writer io.Writer) Writer {
 
 // ToBytesWriter converts a Writer to io.Writer
 func ToBytesWriter(writer Writer) io.Writer {
-	return &BytesToBufferWriter{
+	return &bytesToBufferWriter{
 		writer: writer,
 	}
 }

common/buf/reader.go

@@ -43,15 +43,14 @@ func (v *BytesToBufferReader) Read() (*Buffer, error) {
 	return buffer, nil
 }
 
-type BufferToBytesReader struct {
+type bufferToBytesReader struct {
 	stream  Reader
 	current *Buffer
 	err     error
 }
 
-// Fill fills in the internal buffer.
-// Private: Visible for testing.
-func (v *BufferToBytesReader) Fill() {
+// fill fills in the internal buffer.
+func (v *bufferToBytesReader) fill() {
 	b, err := v.stream.Read()
 	v.current = b
 	if err != nil {
@@ -60,13 +59,13 @@ func (v *BufferToBytesReader) Fill() {
 	}
 }
 
-func (v *BufferToBytesReader) Read(b []byte) (int, error) {
+func (v *bufferToBytesReader) Read(b []byte) (int, error) {
 	if v.err != nil {
 		return 0, v.err
 	}
 
 	if v.current == nil {
-		v.Fill()
+		v.fill()
 		if v.err != nil {
 			return 0, v.err
 		}

common/buf/writer.go

@@ -23,11 +23,11 @@ func (v *BufferToBytesWriter) Write(buffer *Buffer) error {
 	return nil
 }
 
-type BytesToBufferWriter struct {
+type bytesToBufferWriter struct {
 	writer Writer
 }
 
-func (v *BytesToBufferWriter) Write(payload []byte) (int, error) {
+func (v *bytesToBufferWriter) Write(payload []byte) (int, error) {
 	bytesWritten := 0
 	size := len(payload)
 	for size > 0 {

common/net/address.go

@@ -21,11 +21,17 @@ var (
 	LocalHostIPv6 = IPAddress([]byte{0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1})
 )
 
+// AddressFamily is the type of address.
 type AddressFamily int
 
 const (
-	AddressFamilyIPv4   = AddressFamily(0)
-	AddressFamilyIPv6   = AddressFamily(1)
+	// AddressFamilyIPv4 represents address as IPv4
+	AddressFamilyIPv4 = AddressFamily(0)
+
+	// AddressFamilyIPv6 represents address as IPv6
+	AddressFamilyIPv6 = AddressFamily(1)
+
+	// AddressFamilyDomain represents address as Domain
 	AddressFamilyDomain = AddressFamily(2)
 )
 

common/net/destination.go

@@ -11,6 +11,7 @@ type Destination struct {
 	Address Address
 }
 
+// DestinationFromAddr generates a Destination from a net address.
 func DestinationFromAddr(addr net.Addr) Destination {
 	switch addr := addr.(type) {
 	case *net.TCPAddr:
@@ -52,6 +53,7 @@ func (v Destination) IsValid() bool {
 	return v.Network != Network_Unknown
 }
 
+// AsDestination converts current Enpoint into Destination.
 func (v *Endpoint) AsDestination() Destination {
 	return Destination{
 		Network: v.Network,

common/net/network.go

@@ -46,7 +46,7 @@ func (v Network) URLPrefix() string {
 	}
 }
 
-// HashNetwork returns true if the given network is in v NetworkList.
+// HasNetwork returns true if the given network is in v NetworkList.
 func (v NetworkList) HasNetwork(network Network) bool {
 	for _, value := range v.Network {
 		if string(value) == string(network) {
@@ -60,6 +60,7 @@ func (v NetworkList) Get(idx int) Network {
 	return v.Network[idx]
 }
 
+// Size returns the number of networks in this network list.
 func (v NetworkList) Size() int {
 	return len(v.Network)
 }

common/net/port.go

@@ -63,6 +63,7 @@ func (v PortRange) Contains(port Port) bool {
 	return v.FromPort() <= port && port <= v.ToPort()
 }
 
+// SinglePortRange returns a PortRange contains a single port.
 func SinglePortRange(v Port) *PortRange {
 	return &PortRange{
 		From: uint32(v),

common/protocol/headers.go

@@ -7,6 +7,7 @@ import (
 	"v2ray.com/core/common/uuid"
 )
 
+// RequestCommand is a custom command in a proxy request.
 type RequestCommand byte
 
 const (