From b4e124016021683bf237654df17e77684fff3fc4 Mon Sep 17 00:00:00 2001 From: Darien Raymond Date: Tue, 13 Mar 2018 09:02:21 +0100 Subject: [PATCH] comments --- common/buf/buffer.go | 2 +- config.proto | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/common/buf/buffer.go b/common/buf/buffer.go index 356a9c85f..51d3ed8b7 100644 --- a/common/buf/buffer.go +++ b/common/buf/buffer.go @@ -179,7 +179,7 @@ func New() *Buffer { } } -// NewSize creates and returns a buffer given capacity. +// NewSize creates and returns a buffer with 0 length and at least the given capacity. func NewSize(size uint32) *Buffer { return &Buffer{ v: newBytes(size), diff --git a/config.proto b/config.proto index de8461f45..26d660e3c 100644 --- a/config.proto +++ b/config.proto @@ -19,7 +19,7 @@ message Config { reserved 3; - // App configuration. Must be one in the app directory. + // App is for configurations of all features in V2Ray. A feature must implement the Feature interface, and its config type must be registered through common.RegisterConfig. repeated v2ray.core.common.serial.TypedMessage app = 4; // Transport settings. @@ -30,19 +30,21 @@ message Config { repeated v2ray.core.common.serial.TypedMessage extension = 6; } +// InboundHandlerConfig is the configuration for inbound handler. message InboundHandlerConfig { - // Tag of the inbound handler. + // Tag of the inbound handler. The tag must be unique among all inbound handlers string tag = 1; - // Settings for how this inbound proxy is handled. Must be ReceiverConfig above. + // Settings for how this inbound proxy is handled. v2ray.core.common.serial.TypedMessage receiver_settings = 2; // Settings for inbound proxy. Must be one of the inbound proxies. v2ray.core.common.serial.TypedMessage proxy_settings = 3; } +// OutboundHandlerConfig is the configuration for outbound handler. message OutboundHandlerConfig { // Tag of this outbound handler. string tag = 1; - // Settings for how to dial connection for this outbound handler. Must be SenderConfig above. + // Settings for how to dial connection for this outbound handler. v2ray.core.common.serial.TypedMessage sender_settings = 2; // Settings for this outbound proxy. Must be one of the outbound proxies. v2ray.core.common.serial.TypedMessage proxy_settings = 3;