Struct RpcResponseHeaderProto

pub struct RpcResponseHeaderProto {
    pub call_id: u32,
    pub status: i32,
    pub server_ipc_version_num: Option<u32>,
    pub exception_class_name: Option<String>,
    pub error_msg: Option<String>,
    pub error_detail: Option<i32>,
    pub client_id: Option<Vec<u8>>,
    pub retry_count: Option<i32>,
    pub state_id: Option<i64>,
    pub router_federated_state: Option<Vec<u8>>,
}

Rpc Response Header +——————————————————————+ | Rpc total response length in bytes (4 bytes int) | | (sum of next two parts) | +——————————————————————+ | RpcResponseHeaderProto - serialized delimited ie has len | +——————————————————————+ | if request is successful: | | - RpcResponse - The actual rpc response bytes follow | | the response header | | This response is serialized based on RpcKindProto | | if request fails : | | The rpc response header contains the necessary info | +——————————————————————+

Note that rpc response header is also used when connection setup fails. Ie the response looks like a rpc response with a fake callId.

RpcStastus - success or failure The reponseHeader’s errDetail, exceptionClassName and errMsg contains further details on the error

Fields

call_id: u32

callId used in Request

status: i32

server_ipc_version_num: Option<u32>

Sent if success or fail

exception_class_name: Option<String>

if request fails

error_msg: Option<String>

if request fails, often contains strack trace

error_detail: Option<i32>

in case of error

client_id: Option<Vec<u8>>

Globally unique client ID

retry_count: Option<i32>

state_id: Option<i64>

The last written Global State ID

router_federated_state: Option<Vec<u8>>

Alignment context info for use with routers. The client should not interpret these bytes, but only forward them to the router using RpcRequestHeaderProto.routerFederatedState.

Implementations

impl RpcResponseHeaderProto

pub fn status(&self) -> RpcStatusProto

Returns the enum value of status, or the default if the field is set to an invalid enum value.

pub fn set_status(&mut self, value: RpcStatusProto)

Sets status to the provided enum value.

pub fn server_ipc_version_num(&self) -> u32

Returns the value of server_ipc_version_num, or the default value if server_ipc_version_num is unset.

pub fn exception_class_name(&self) -> &str

Returns the value of exception_class_name, or the default value if exception_class_name is unset.

pub fn error_msg(&self) -> &str

Returns the value of error_msg, or the default value if error_msg is unset.

pub fn error_detail(&self) -> RpcErrorCodeProto

Returns the enum value of error_detail, or the default if the field is unset or set to an invalid enum value.

pub fn set_error_detail(&mut self, value: RpcErrorCodeProto)

Sets error_detail to the provided enum value.

pub fn client_id(&self) -> &[u8]

Returns the value of client_id, or the default value if client_id is unset.

pub fn retry_count(&self) -> i32

Returns the value of retry_count, or the default value if retry_count is unset.

pub fn state_id(&self) -> i64

Returns the value of state_id, or the default value if state_id is unset.

pub fn router_federated_state(&self) -> &[u8]

Returns the value of router_federated_state, or the default value if router_federated_state is unset.

Trait Implementations

impl Clone for RpcResponseHeaderProto

fn clone(&self) -> RpcResponseHeaderProto

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RpcResponseHeaderProto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RpcResponseHeaderProto

fn default() -> Self

Returns the “default value” for a type.

impl Message for RpcResponseHeaderProto

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RpcResponseHeaderProto

fn eq(&self, other: &RpcResponseHeaderProto) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RpcResponseHeaderProto