package trpc.v2

Get desktop application:
View/edit binary Protocol Buffers messages

Request protocol header

• uint32 version = 1

  Protocol version Specific value corresponds to TrpcProtoVersion

• uint32 call_type = 2

  Call type of request eg: normal call, one-way call Specific value corresponds to TrpcCallType

• uint32 request_id = 3

  Request unique id

• uint32 timeout = 4

  Request timeout, unit ms

• bytes caller = 5

  Name of the calling service Standard format in trpc protocol: trpc.application_name.server_name.proto_service_name, 4 segments

• bytes callee = 6

  Routing name of the called service Standard format in trpc protocol: trpc.application_name.server_name.proto_service_name[.interface_name] First 4 segments are mandatory, interface is optional

• bytes func = 7

  Interface name of the called service Standard format: /package.Service_name/interface_name

• uint32 message_type = 8

  Message type for framework information transparent transmission Such as tracing, dyeing key, gray, authentication, multi-environment, set name, etc. Specific value corresponds to TrpcMessageType

• map<string, bytes> trans_info = 9

  Key-value pairs for framework transparent transmission information, currently divided into two parts: 1. Information to be transparently transmitted by the framework layer, key names must start with 'trpc-' 2. Information to be transparently transmitted by the business layer, which can be set by the business itself

• uint32 content_type = 10

  Serialization type of request data eg: proto/jce/json, default proto Specific value corresponds to TrpcContentEncodeType

• uint32 content_encoding = 11

  Compression method used for request data eg: gzip/snappy/..., default not used Specific value corresponds to TrpcCompressType

Response protocol header

• uint32 version = 1

  Protocol version Specific value corresponds to TrpcProtoVersion

• uint32 call_type = 2

  Call type of request eg: normal call, one-way call Specific value corresponds to TrpcCallType

• uint32 request_id = 3

  Request unique id

• int32 ret = 4

  Error return code at framework layer Specific value corresponds to TrpcRetCode

• int32 func_ret = 5

  Interface error return code It is recommended to identify success and failure when using, 0 represents success, others represent failure

• bytes error_msg = 6

  Call result information description Used when failed

• uint32 message_type = 7

  Message type for framework information transparent transmission Such as tracing, dyeing key, gray, authentication, multi-environment, set name, etc. Specific value corresponds to TrpcMessageType

• map<string, bytes> trans_info = 8

  Key-value pairs for framework transparent transmission information returned, Currently divided into two parts: 1. Information transparently transmitted back by the framework layer, key names must start with 'trpc-' 2. Information transparently transmitted back by the business layer, which can be set by the business itself

• uint32 content_type = 9

  Encoding type of response data eg: proto/jce/json, default proto Specific value corresponds to TrpcContentEncodeType

• uint32 content_encoding = 10

  Compression method used for response data eg: gzip/snappy/..., default not used Specific value corresponds to TrpcCompressType

Used in: SwaggerRule

• string name = 1

• bool required = 2

• string default = 3

to gen swagger json

• string title = 50103

• string method = 50104

• string description = 50105

• repeated SwaggerParam params = 50106

Call type in trpc protocol

• TRPC_UNARY_CALL = 0

  Request-response call, including synchronous and asynchronous

• TRPC_ONEWAY_CALL = 1

  One-way call

Compression type of data content in trpc protocol Default uses no compression

• TRPC_DEFAULT_COMPRESS = 0

  Default no compression

• TRPC_GZIP_COMPRESS = 1

  Use gzip

• TRPC_SNAPPY_COMPRESS = 2

  Use snappy Deprecated: It is recommended to use TRPC_SNAPPY_STREAM_COMPRESS/TRPC_SNAPPY_BLOCK_COMPRESS, because currently trpc-go and trpc-cpp use stream and block modes respectively, which are incompatible, cross-language calls will cause errors

• TRPC_ZLIB_COMPRESS = 3

  Use zlib

• TRPC_SNAPPY_STREAM_COMPRESS = 4

  Use snappy in stream mode

• TRPC_SNAPPY_BLOCK_COMPRESS = 5

  Use snappy in block mode

Encoding type of data content in trpc protocol Default uses pb Currently agreed that values in the range 0-127 are framework-standard serialization methods, used by framework

• TRPC_PROTO_ENCODE = 0

  pb

• TRPC_JCE_ENCODE = 1

  jce

• TRPC_JSON_ENCODE = 2

  json

• TRPC_FLATBUFFER_ENCODE = 3

  flatbuffer

• TRPC_NOOP_ENCODE = 4

  No serialization

• TRPC_XML_ENCODE = 5

  xml

• TRPC_THRIFT_ENCODE = 6

  thrift

The binary data frame type of the trpc protocol Currently supports two types of binary data frames: 1. Binary data frame type for request-response mode 2. Binary data frame type for streaming mode

• TRPC_UNARY_FRAME = 0

  Binary data frame type for trpc request-response mode

• TRPC_STREAM_FRAME = 1

  Binary data frame type for trpc streaming mode

The magic value in the framework protocol header

• TRPC_DEFAULT_NONE = 0

  trpc does not use this value, it is used by the pb tool to generate code

• TRPC_MAGIC_VALUE = 2352

  trpc protocol uses this magic value by default

Message transparent transmission supported types in trpc protocol

• TRPC_DEFAULT = 0

  trpc does not use this value, it is used by the pb tool to generate code

• TRPC_DYEING_MESSAGE = 1

  Dyeing

• TRPC_TRACE_MESSAGE = 2

  Tracing

• TRPC_MULTI_ENV_MESSAGE = 4

  Multi-environment

• TRPC_GRID_MESSAGE = 8

  Gray

• TRPC_SETNAME_MESSAGE = 16

  Set name

trpc protocol version

• TRPC_PROTO_V1 = 0

  Default version

Definition of framework layer interface call return codes

• TRPC_INVOKE_SUCCESS = 0

  Call success

• TRPC_SERVER_DECODE_ERR = 1

  Protocol error codes Server-side decode error

• TRPC_SERVER_ENCODE_ERR = 2

  Server-side encode error

• TRPC_SERVER_NOSERVICE_ERR = 11

  Service or func routing error codes Server does not have corresponding service implementation

• TRPC_SERVER_NOFUNC_ERR = 12

  Server does not have corresponding interface implementation

• TRPC_SERVER_TIMEOUT_ERR = 21

  Timeout/overload/limiter error codes Request timed out on server

• TRPC_SERVER_OVERLOAD_ERR = 22

  Request discarded due to server overload protection Mainly used in framework's internal overload protection plugin

• TRPC_SERVER_LIMITED_ERR = 23

  Request limited on server Mainly used in external service governance system plugins or business custom limiter plugins, eg: Polaris limiter

• TRPC_SERVER_FULL_LINK_TIMEOUT_ERR = 24

  Request timed out on server due to full link timeout

• TRPC_SERVER_SYSTEM_ERR = 31

  Server system error

• TRPC_SERVER_AUTH_ERR = 41

  Server authentication failure error

• TRPC_SERVER_VALIDATE_ERR = 51

  Server request parameter automatic validation failure error

• TRPC_CLIENT_INVOKE_TIMEOUT_ERR = 101

  Timeout error codes Request timed out on client

• TRPC_CLIENT_FULL_LINK_TIMEOUT_ERR = 102

  Request timed out on client due to full link timeout

• TRPC_CLIENT_CONNECT_ERR = 111

  Network related error codes Client connection error

• TRPC_CLIENT_ENCODE_ERR = 121

  Protocol related error codes Client encode error

• TRPC_CLIENT_DECODE_ERR = 122

  Client decode error

• TRPC_CLIENT_LIMITED_ERR = 123

  Overload protection/limiter related error codes Request limited on client Mainly used in external service governance system plugins or business custom limiter plugins, eg: Polaris limiter

• TRPC_CLIENT_OVERLOAD_ERR = 124

  Request discarded due to client overload protection Mainly used in framework's internal overload protection plugin

• TRPC_CLIENT_ROUTER_ERR = 131

  Routing related error codes Client IP routing error

• TRPC_CLIENT_NETWORK_ERR = 141

  Client network error

• TRPC_CLIENT_VALIDATE_ERR = 151

  Client response parameter automatic validation failure error

• TRPC_CLIENT_CANCELED_ERR = 161

  Upstream actively disconnected, early cancellation request error

• TRPC_STREAM_SERVER_NETWORK_ERR = 201

  Server-side streaming network error, detailed error codes need to be sorted out during implementation

• TRPC_STREAM_SERVER_MSG_EXCEED_LIMIT_ERR = 211

  Server-side streaming transmission error, detailed error codes need to be sorted out during implementation eg: Stream message too large, etc.

• TRPC_STREAM_SERVER_ENCODE_ERR = 221

  Server-side streaming encode error

• TRPC_STREAM_SERVER_DECODE_ERR = 222

  Client-side streaming encode/decode error

• TRPC_STREAM_SERVER_WRITE_END = 231

  Server-side streaming write error, detailed error codes need to be sorted out during implementation

• TRPC_STREAM_SERVER_WRITE_OVERFLOW_ERR = 232

• TRPC_STREAM_SERVER_WRITE_CLOSE_ERR = 233

• TRPC_STREAM_SERVER_WRITE_TIMEOUT_ERR = 234

• TRPC_STREAM_SERVER_READ_END = 251

  Server-side streaming read error, detailed error codes need to be sorted out during implementation

• TRPC_STREAM_SERVER_READ_CLOSE_ERR = 252

• TRPC_STREAM_SERVER_READ_EMPTY_ERR = 253

• TRPC_STREAM_SERVER_READ_TIMEOUT_ERR = 254

• TRPC_STREAM_CLIENT_NETWORK_ERR = 301

  Client-side streaming network error, detailed error codes need to be sorted out during implementation

• TRPC_STREAM_CLIENT_MSG_EXCEED_LIMIT_ERR = 311

  Client-side streaming transmission error, detailed error codes need to be sorted out during implementation eg: Stream message too large, etc.

• TRPC_STREAM_CLIENT_ENCODE_ERR = 321

  Client-side streaming encode error

• TRPC_STREAM_CLIENT_DECODE_ERR = 322

  Client-side streaming encode/decode error

• TRPC_STREAM_CLIENT_WRITE_END = 331

  Client-side streaming write error, detailed error codes need to be sorted out during implementation

• TRPC_STREAM_CLIENT_WRITE_OVERFLOW_ERR = 332

• TRPC_STREAM_CLIENT_WRITE_CLOSE_ERR = 333

• TRPC_STREAM_CLIENT_WRITE_TIMEOUT_ERR = 334

• TRPC_STREAM_CLIENT_READ_END = 351

  Client-side streaming read error, detailed error codes need to be sorted out during implementation

• TRPC_STREAM_CLIENT_READ_CLOSE_ERR = 352

• TRPC_STREAM_CLIENT_READ_EMPTY_ERR = 353

• TRPC_STREAM_CLIENT_READ_TIMEOUT_ERR = 354

• TRPC_INVOKE_UNKNOWN_ERR = 999

  Unspecified error

• TRPC_STREAM_UNKNOWN_ERR = 1000

  Unspecified error

Definition of RESET frame header message for trpc streaming

• int32 close_type = 1

  Close type, whether to close one end or all

• int32 ret = 2

  Close return code Represents framework layer error

• bytes msg = 3

  Close information description

• uint32 message_type = 4

  Message type for framework information transparent transmission Such as tracing, dyeing key, gray, authentication, multi-environment, set name, etc. Specific value corresponds to TrpcMessageType

• map<string, bytes> trans_info = 5

  Key-value pairs for framework transparent transmission information, currently divided into two parts: 1. Information to be transparently transmitted by the framework layer, key names must start with 'trpc-' 2. Information to be transparently transmitted by the business layer, which can be set by the business itself

• int32 func_ret = 6

  Interface error return code It is recommended to identify success and failure when using, 0 represents success, others represent failure

trpc streaming close type

• TRPC_STREAM_CLOSE = 0

  Normal unidirectional stream close

• TRPC_STREAM_RESET = 1

  Abnormal bidirectional stream close

Definition of flow control frame header metadata for trpc streaming

• uint32 window_size_increment = 1

  Incremented window size

The binary data frame type of trpc protocol streaming Currently there are 4 types of streaming frames: INIT/DATA/FEEDBACK/CLOSE, where CLOSE frame does not carry business data INIT frame: FIXHEADER + TrpcStreamInitMeta DATA frame: FIXHEADER + body(business serialized data) FEEDBACK frame: FIXHEADER + TrpcStreamFeedBackMeta (trigger strategy: high/low water level + timer) CLOSE frame: FIXHEADER + TrpcStreamCloseMeta Connection and stream idle timeout recycling mechanism is not considered

• TRPC_UNARY = 0

  Default value for request-response

• TRPC_STREAM_FRAME_INIT = 1

  Streaming INIT frame type

• TRPC_STREAM_FRAME_DATA = 2

  Streaming DATA frame type

• TRPC_STREAM_FRAME_FEEDBACK = 3

  Streaming FEEDBACK frame type

• TRPC_STREAM_FRAME_CLOSE = 4

  Streaming CLOSE frame type

Definition of flow control frame header message for trpc streaming

• optional TrpcStreamInitRequestMeta request_meta = 1

  INIT request metadata

• optional TrpcStreamInitResponseMeta response_meta = 2

  INIT response metadata

• uint32 init_window_size = 3

  Initial send window size notified by receiver to sender

• uint32 content_type = 4

  Serialization type of request data eg: proto/jce/json, default proto Specific value corresponds to TrpcContentEncodeType

• uint32 content_encoding = 5

  Compression method used for request data eg: gzip/snappy/..., default not used Specific value corresponds to TrpcCompressType

Request metadata definition for trpc streaming INIT header

Used in: TrpcStreamInitMeta

• bytes caller = 1

  Name of the calling service Standard format in trpc protocol: trpc.application_name.server_name.proto_service_name, 4 segments

• bytes callee = 2

  Routing name of the called service Standard format in trpc protocol: trpc.application_name.server_name.proto_service_name[.interface_name] First 4 segments are mandatory, interface is optional

• bytes func = 3

  Interface name of the called service Standard format: /package.Service_name/interface_name

• uint32 message_type = 4

  Message type for framework information transparent transmission Such as tracing, dyeing key, gray, authentication, multi-environment, set name, etc. Specific value corresponds to TrpcMessageType

• map<string, bytes> trans_info = 5

  Key-value pairs for framework transparent transmission information, currently divided into two parts: 1. Information to be transparently transmitted by the framework layer, key names must start with 'trpc-' 2. Information to be transparently transmitted by the business layer, which can be set by the business itself Note: Key-value pairs in trans_info will be transparently transmitted through the entire link, please use with caution!

Response metadata definition for trpc streaming INIT header

Used in: TrpcStreamInitMeta

• int32 ret = 1

  Error return code at framework layer Specific value corresponds to TrpcRetCode

• bytes error_msg = 2

  Call result information description Used when failed