com.alipay.sofa.jraft.rpc

Interface RpcResponseFactory

public interface RpcResponseFactory

Helper to create error response.

Author:

boyan (boyan@alibaba-inc.com), jiachun.fjc

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_RESPONSE_NUM This is a convention that if a Message contains an RpcRequests.ErrorResponse field, it can only be in position 99.

Method Summary

Modifier and Type	Method and Description
default com.google.protobuf.Message	newResponse(com.google.protobuf.Message parent, int code, String fmt, Object... args) Creates an error response with parameters.
default com.google.protobuf.Message	newResponse(com.google.protobuf.Message parent, RaftError error, String fmt, Object... args) Creates an error response with parameters.
default com.google.protobuf.Message	newResponse(com.google.protobuf.Message parent, Status st) Creates a RPC response from status, return OK response when status is null.

Field Detail

ERROR_RESPONSE_NUM

static final int ERROR_RESPONSE_NUM

This is a convention that if a Message contains an RpcRequests.ErrorResponse field, it can only be in position 99.

See Also:

Constant Field Values

Method Detail

newResponse

default com.google.protobuf.Message newResponse(com.google.protobuf.Message parent,
                                                Status st)

Creates a RPC response from status, return OK response when status is null.

Parameters:

parent - parent message

st - status with response

Returns:

a response instance

newResponse

default com.google.protobuf.Message newResponse(com.google.protobuf.Message parent,
                                                RaftError error,
                                                String fmt,
                                                Object... args)

Creates an error response with parameters.

Parameters:

parent - parent message

error - error with raft info

fmt - message with format string

args - arguments referenced by the format specifiers in the format string

Returns:

a response instance

newResponse

default com.google.protobuf.Message newResponse(com.google.protobuf.Message parent,
                                                int code,
                                                String fmt,
                                                Object... args)

Creates an error response with parameters.

Parameters:

parent - parent message

code - error code with raft info

fmt - message with format string

args - arguments referenced by the format specifiers in the format string

Returns:

a response instance