Alanxtl commented on code in PR #3674:
URL: https://github.com/apache/dubbo-go/pull/3674#discussion_r3800574785
##########
global/protocol_config.go:
##########
@@ -23,28 +23,36 @@ import (
// ProtocolConfig represents the config of protocol.
type ProtocolConfig struct {
+ // Name defines the protocol name for server.
Name string `yaml:"name" json:"name,omitempty" property:"name"`
- Ip string `yaml:"ip" json:"ip,omitempty" property:"ip"`
+
+ // Ip defines the listening IP address for server.
+ Ip string `yaml:"ip" json:"ip,omitempty" property:"ip"`
+
+ // Port defines the listening port for server.
Port string `yaml:"port" json:"port,omitempty" property:"port"`
// TODO: maybe Params is useless, find a ideal way to config dubbo
protocol, ref: TripleConfig.
+ // Params defines additional protocol parameters for server.
Params any `yaml:"params" json:"params,omitempty" property:"params"`
- // TripleConfig holds the Triple protocol configuration.
+ // TripleConfig holds the Triple protocol configuration for server.
TripleConfig *TripleConfig `yaml:"triple" json:"triple,omitempty"
property:"triple"`
// TODO: remove MaxServerSendMsgSize and MaxServerRecvMsgSize when
version 4.0.0
//
- // MaxServerSendMsgSize defines the max size of server send message,
1mb=1000kb=1000000b 1mib=1024kb=1048576b.
- // more detail to see
https://pkg.go.dev/github.com/dustin/go-humanize#pkg-constants
+ // MaxServerSendMsgSize defines the maximum size of messages sent by
server.
+ // Supported units include 1mb=1000kb=1000000b and 1mib=1024kb=1048576b.
+ // For more details, see
https://pkg.go.dev/github.com/dustin/go-humanize#pkg-constants.
//
- // Deprecated: use
"ClientProtocolConfig.TripleConfig.MaxServerSendMsgSize" or in config tag
"protocol_config/triple/max-server-send-msg-size" instead
+ // Deprecated: use TripleConfig.MaxServerSendMsgSize instead.
MaxServerSendMsgSize string `yaml:"max-server-send-msg-size"
json:"max-server-send-msg-size,omitempty"`
+
// TODO: remove MaxServerSendMsgSize and MaxServerRecvMsgSize when
version 4.0.0
//
- // MaxServerRecvMsgSize defines the max size of server receive message.
+ // MaxServerRecvMsgSize defines the maximum size of messages received
by server.
//
- // Deprecated: use
"ClientProtocolConfig.TripleConfig.MaxServerRecvMsgSize" or in config tag
"protocol_config/triple/max-server-recv-msg-size" instead
+ // Deprecated: use TripleConfig.MaxServerRecvMsgSize instead.
Review Comment:
ditto
##########
global/protocol_config.go:
##########
@@ -23,28 +23,36 @@ import (
// ProtocolConfig represents the config of protocol.
type ProtocolConfig struct {
+ // Name defines the protocol name for server.
Name string `yaml:"name" json:"name,omitempty" property:"name"`
- Ip string `yaml:"ip" json:"ip,omitempty" property:"ip"`
+
+ // Ip defines the listening IP address for server.
+ Ip string `yaml:"ip" json:"ip,omitempty" property:"ip"`
+
+ // Port defines the listening port for server.
Port string `yaml:"port" json:"port,omitempty" property:"port"`
// TODO: maybe Params is useless, find a ideal way to config dubbo
protocol, ref: TripleConfig.
+ // Params defines additional protocol parameters for server.
Params any `yaml:"params" json:"params,omitempty" property:"params"`
- // TripleConfig holds the Triple protocol configuration.
+ // TripleConfig holds the Triple protocol configuration for server.
TripleConfig *TripleConfig `yaml:"triple" json:"triple,omitempty"
property:"triple"`
// TODO: remove MaxServerSendMsgSize and MaxServerRecvMsgSize when
version 4.0.0
//
- // MaxServerSendMsgSize defines the max size of server send message,
1mb=1000kb=1000000b 1mib=1024kb=1048576b.
- // more detail to see
https://pkg.go.dev/github.com/dustin/go-humanize#pkg-constants
+ // MaxServerSendMsgSize defines the maximum size of messages sent by
server.
+ // Supported units include 1mb=1000kb=1000000b and 1mib=1024kb=1048576b.
+ // For more details, see
https://pkg.go.dev/github.com/dustin/go-humanize#pkg-constants.
//
- // Deprecated: use
"ClientProtocolConfig.TripleConfig.MaxServerSendMsgSize" or in config tag
"protocol_config/triple/max-server-send-msg-size" instead
+ // Deprecated: use TripleConfig.MaxServerSendMsgSize instead.
Review Comment:
do not edit this line
##########
global/triple_config.go:
##########
@@ -21,27 +21,27 @@ package global
// TripleConfig represents the config of triple protocol.
type TripleConfig struct {
- //
- // for server
- //
- // MaxServerSendMsgSize defines the max size of server send message,
1mb=1000kb=1000000b 1mib=1024kb=1048576b.
- // more detail to see
https://pkg.go.dev/github.com/dustin/go-humanize#pkg-constants
+ // MaxServerSendMsgSize defines the maximum size of messages sent by
server.
+ // Supported units include 1mb=1000kb=1000000b and 1mib=1024kb=1048576b.
+ // For more details, see
https://pkg.go.dev/github.com/dustin/go-humanize#pkg-constants.
MaxServerSendMsgSize string `yaml:"max-server-send-msg-size"
json:"max-server-send-msg-size,omitempty"`
- // MaxServerRecvMsgSize defines the max size of server receive message.
+
+ // MaxServerRecvMsgSize defines the maximum size of messages received
by server.
MaxServerRecvMsgSize string `yaml:"max-server-recv-msg-size"
json:"max-server-recv-msg-size,omitempty"`
- // Http3 holds the HTTP/3 transport configuration.
+
+ // Http3 holds the HTTP/3 transport configuration for server and client.
Http3 *Http3Config `yaml:"http3" json:"http3,omitempty"`
- // Cors configures CORS for Triple protocol handlers.
+
+ // Cors configures CORS for Triple protocol handlers on server.
Cors *CorsConfig `yaml:"cors" json:"cors,omitempty"`
- // OpenAPI configures OpenAPI documentation generation.
+
+ // OpenAPI configures OpenAPI documentation generation for server.
OpenAPI *OpenAPIConfig `yaml:"openapi" json:"openapi,omitempty"`
- //
- // for client
- //
Review Comment:
keep this for client
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
