package yb.rpc

Get desktop application:
View/edit binary Protocol Buffers messages

• string type_url = 1

• bytes value = 2

Used in: RpcCallInProgressPB

• optional string type = 1

• repeated CQLStatementsDetailsPB call_details = 2

Used in: RpcConnectionDetailsPB

• optional string keyspace = 1

Used in: CQLCallDetailsPB

• optional string sql_id = 1

• optional string sql_string = 2

• optional string params = 3

• optional bool include_traces = 1

• optional bool dump_timed_out = 2

• optional bool get_wait_state = 3

• optional bool get_local_calls = 4

• optional bool export_wait_state_code_as_string = 5

• repeated RpcConnectionPB inbound_connections = 1

• repeated RpcConnectionPB outbound_connections = 2

• optional RpcConnectionPB local_calls = 3

An emtpy message. Since CQL RPC server bypasses protobuf to handle requests and responses but RPC context expects the request and response messages to be present, we set up an empty message inside RPC context to satisfy it.

(message has no fields)

Sent as response when is_error == true.

• required string message = 1

• optional ErrorStatusPB.RpcErrorCodePB code = 2

  TODO: Make code required?

  Specific error identifier.

These codes have all been inherited from Hadoop's RPC mechanism.

Used in: ErrorStatusPB

• FATAL_UNKNOWN = 10

• ERROR_APPLICATION = 1

  Non-fatal RPC errors. Connection should be left open for future RPC calls. ------------------------------------------------------------ The application generated an error status. See the message field for more details.

• ERROR_NO_SUCH_METHOD = 2

  The specified method was not valid.

• ERROR_NO_SUCH_SERVICE = 3

  The specified service was not valid.

• ERROR_SERVER_TOO_BUSY = 4

  The server is overloaded - the client should try again shortly.

• ERROR_INVALID_REQUEST = 5

  The request parameter was not parseable or was missing required fields.

• FATAL_SERVER_SHUTTING_DOWN = 11

  FATAL_* errors indicate that the client should shut down the connection. ------------------------------------------------------------ The RPC server is already shutting down.

• FATAL_DESERIALIZING_REQUEST = 13

  Could not deserialize RPC request.

• FATAL_VERSION_MISMATCH = 14

  IPC Layer version mismatch.

• FATAL_UNAUTHORIZED = 15

  Auth failed.

• string name = 1

• bool pointer = 1

• bool force_arena = 1

• RpcSides sides = 1

Used in: RpcCallInProgressPB

• repeated RedisStatementsDetailsPB call_details = 1

Used in: RedisCallDetailsPB

• optional string redis_string = 1

Used in: RequestHeader

• required string service_name = 1

  Service name for the RPC layer. The client created a proxy with this service name. Example: yb.rpc_test.CalculatorService

• required string method_name = 2

  Name of the RPC method.

The header for the RPC request frame.

Used in: RpcCallInProgressPB

• optional int32 call_id = 1

  A sequence number that is sent back in the Response. Hadoop specifies a uint32 and casts it to a signed int. That is counterintuitive, so we use an int32 instead. Allowed values (inherited from Hadoop): 0 through INT32_MAX: Regular RPC call IDs. -2: Invalid call ID. -3: Connection context call ID. -33: SASL negotiation call ID.

• optional RemoteMethodPB remote_method = 2

  RPC method being invoked. Not used for "connection setup" calls.

• optional uint32 timeout_millis = 3

  Propagate the timeout as specified by the user. Note that, since there is some transit time between the client and server, if you wait exactly this amount of time and then respond, you are likely to cause a timeout on the client.

• repeated fixed32 sidecar_offsets = 4

• required int32 call_id = 1

• optional bool is_error = 2

  If this is set, then this is an error response and the response message will be of type ErrorStatusPB instead of the expected response type.

• repeated uint32 sidecar_offsets = 3

  Byte offsets for side cars in the main body of the response message. These offsets are counted AFTER the message header, i.e., offset 0 is the first byte after the bytes for this protobuf.

Used in: RpcConnectionPB

• required RequestHeader header = 1

• optional string trace_buffer = 2

• optional uint64 elapsed_millis = 3

• optional uint64 sending_bytes = 6

• optional RpcCallState state = 7

• oneof call_details

  • CQLCallDetailsPB cql_details = 4

  • RedisCallDetailsPB redis_details = 5

• optional WaitStateInfoPB wait_state = 8

Used in: RpcCallInProgressPB

• READY = 0

• ON_OUTBOUND_QUEUE = 1

• SENT = 2

• TIMED_OUT = 3

• FINISHED_ERROR = 4

• FINISHED_SUCCESS = 5

Used in: RpcConnectionPB

• oneof connection_details

  • CQLConnectionDetailsPB cql_connection_details = 1

Used in: DumpRunningRpcsResponsePB

• required string remote_ip = 1

• required RpcConnectionPB.StateType state = 2

• optional uint64 processed_call_count = 4

• optional uint64 sending_bytes = 7

• optional RpcConnectionDetailsPB connection_details = 5

• repeated RpcCallInProgressPB calls_in_flight = 6

Used in: RpcConnectionPB

• UNKNOWN = 999

• NEGOTIATING = 0

  Connection is still being negotiated.

• OPEN = 1

  Connection is active.

Used in: LightweightMethodOptions

• NONE = 0

• SERVICE = 1

• PROXY = 2

• BOTH = 3