package flare.rpc

Get desktop application:
View/edit binary Protocol Buffers messages

Compresison algorithm, Offset of bit mask.

Used in: RpcMeta

• COMPRESSION_ALGORITHM_UNKNOWN = 0

• COMPRESSION_ALGORITHM_NONE = 1

• COMPRESSION_ALGORITHM_GZIP = 2

• COMPRESSION_ALGORITHM_LZ4_FRAME = 3

• COMPRESSION_ALGORITHM_SNAPPY = 4

• COMPRESSION_ALGORITHM_ZSTD = 5

Bit mask.

• MESSAGE_FLAGS_UNKNOWN = 0

• MESSAGE_FLAGS_START_OF_STREAM = 1

  Applicable if `method_type` is `METHOD_TYPE_STREAM`. FIXME(2020/06/02, luobogao): Does not make much sense, we might want to remove it sometime later.

• MESSAGE_FLAGS_END_OF_STREAM = 2

• MESSAGE_FLAGS_NO_PAYLOAD = 4

  After serialization, both "no-payload" and empty message are 0 byte, so we need this flag to differentiate between them.

Method type expected by the sender. This can be inferred from `method_name` by the receiver. However, by providing this by the sender, on receiver side we can dispatch the message earlier without having to look into the method's descriptor, so as not to block processing of other messages.

Used in: RpcMeta

• METHOD_TYPE_UNKNOWN = 0

• METHOD_TYPE_SINGLE = 1

• METHOD_TYPE_STREAM = 2

• required uint64 correlation_id = 1

  Used for matching request / response if the connection is multiplexed.

• required MethodType method_type = 7

• optional uint64 flags = 8

  Bitwise or of `MessageFlags`. Protocol Buffers' enumeration does not allow bitmask, unfornatunately.

• optional CompressionAlgorithm compression_algorithm = 9

  Message body used compression algorithm.

• optional bool attachment_compressed = 10

  If set, attachment will also be compressed by the same compression algorithm as the message body.

• optional RpcRequestMeta request_meta = 5

  Don't use `oneof` here, it does not get along well with object pooling. Protocol Buffer's own `Arena` is not a viable way either, as it cannot optimize allocation of `std::string`s. Note that this definition is wire-format compatible with `oneof` (given that at most one of them is present.)

• optional RpcResponseMeta response_meta = 6

Used in: RpcMeta

• required string method_name = 2

  `MethodDescriptor::full_name()`.

• optional uint32 request_id = 3

  For logging purpose.

• optional uint32 timeout = 4

  Relative time. In milliseconds.

• optional bytes tracing_context = 5

  Opaque, provider-serialized span context. @sa: flare::tracing::TracingOpsProvider::Inject(...)

• optional uint64 acceptable_compression_algorithms = 6

  Bitwise or of `CompressionAlgorithms`, representing acceptable compression algorithms.

Used in: RpcMeta

• required int32 status = 1

  @sa: `Status`.

• optional string description = 2

• optional bool trace_forcibly_sampled = 3

  If set, the receiver should report the trace (if distributed tracing is enabled) corresponding to this RPC. What's more, the flag should be propagated backwards further.

Only responses are stored. We (`RpcChannel`) don't care about requests.

• int32 status = 1

• bool streaming_rpc = 2

• bool using_raw_bytes = 5

• bytes body = 3

• bytes attachment = 4

Only requests are stored.

• string method = 1

• bool streaming_rpc = 2

• bool using_raw_bytes = 5

• bytes body = 3

• bytes attachment = 4

KEEP IN SYNC WITH `common/rpc/rpc_error_code.proto`

Status codes here are business independent.

• STATUS_SUCCESS = 0

• STATUS_CHANNEL_SHUTDOWN = 1

  Mostly not used by Flare.

• STATUS_FAIL_TO_CONNECT = 2

• STATUS_SERIALIZE_REQUEST = 4

• STATUS_PARSE_REQUEST = 5

• STATUS_SERIALIZE_RESPONSE = 6

• STATUS_PARSE_RESPONSE = 7

• STATUS_INVALID_METHOD_NAME = 8

• STATUS_INVALID_TRANSFER_MODE = 12

• STATUS_FROM_USER_FEEDBACK = 13

• STATUS_OUT_OF_SERVICE = 14

• STATUS_GET_ROUTE = 15

• STATUS_GET_ROUTE_ALL_DISABLED = 17

• STATUS_FROM_USER = 100

  Why do we have this?

• STATUS_TIMEOUT = 3

  Used by both framework.

• STATUS_OVERLOADED = 11

• STATUS_SERVICE_NOT_FOUND = 9

• STATUS_METHOD_NOT_FOUND = 10

• STATUS_NO_PEER = 16

  Was `STATUS_GET_ROUTE_EMPTY`.

• STATUS_FAILED = 99

  Was `STATUS_UNKNOWN`

• STATUS_NOT_SUPPORTED = 101

  Defined solely by Flare.

• STATUS_MALFORMED_DATA = 102

• STATUS_INVALID_CHANNEL = 103

• STATUS_IO_ERROR = 104

• STATUS_RESERVED_MAX = 1000

  Values greater than 1000 (not 100) are reserved for end user's use.