RpcDataPackage (jprotobuf-rpc-core 4.2.1 API)

java.lang.Object
- com.baidu.jprotobuf.pbrpc.data.RpcDataPackage

所有已实现的接口:: Readable, Writerable

public class RpcDataPackage
extends Object
implements Readable, Writerable

RPC 包数据完整定义实现. Data package for baidu RPC. all request and response data package should apply this.

 -----------------------------------
 | Head | Meta | Data | Attachment |
 -----------------------------------
 
 1.  with fixed 12 byte length as follow format
 ----------------------------------------------
 | PRPC | TotalSize(int32) | MetaSize(int32) |
 ----------------------------------------------
 TotalSize = totalSize
 MetaSize = Meta object size
 
 2.  body proto description as follow
 message RpcMeta {
     RpcRequestMeta request = 1;
     RpcResponseMeta response = 2;
     int32 compress_type = 3; // 0:nocompress 1:Snappy 2:gzip
     int64 correlation_id = 4;
     int32 attachment_size = 5;
     ChunkInfo chuck_info = 6;
     bytes authentication_data = 7;
 };
 
 message Request {
     required string service_name = 1;
     required string method_name = 2;
     int64 log_id = 3;
     int64 traceId = 4;
     int64 spanId = 5;
     int64 parentSpanId = 6;
     repeated RpcRequestMetaExtField rpcRequestMetaExt = 7;
     
     bytes extraParam = 110;
 };
 
 message Response {
     int32 error_code = 1;
     string error_text = 2;
 };
 
 message ChunkInfo {
     required int64 stream_id = 1;
     required int64 chunk_id = 2;
 };
 
 message RpcRequestMetaExtField {
     string key = 1;
     string value = 2;
 };
 
 3.  customize transport data message.
 
 4.  attachment body data message

从以下版本开始:: 1.0
作者:: xiemalin

构造器概要

构造器
构造器和说明

RpcDataPackage()

构造器
构造器和说明
`RpcDataPackage()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`RpcDataPackage`	`attachment(byte[] attachment)` Attachment.
`RpcDataPackage`	`authenticationData(byte[] authenticationData)` Authentication data.
`static RpcDataPackage`	`buildRpcDataPackage(RpcMethodInfo methodInfo, Object[] args)` Builds the rpc data package.
`List<RpcDataPackage>`	`chunk(long chunkSize)` To split current `RpcDataPackage` by chunkSize. if chunkSize great than data length will not do split.
`RpcDataPackage`	`chunkInfo(long streamId, int chunkId)` Chunk info.
`RpcDataPackage`	`compressType(int compressType)` Compress type.
`RpcDataPackage`	`copy()` Copy.
`RpcDataPackage`	`correlationId(long correlationId)` Correlation id.
`RpcDataPackage`	`data(byte[] data)` Data.
`RpcDataPackage`	`errorCode(int errorCode)` Error code.
`RpcDataPackage`	`errorText(String errorText)` Error text.
`RpcDataPackage`	`extraParams(byte[] params)` Extra params.
`byte[]`	`getAttachment()` Gets the attachment.
`Long`	`getChunkStreamId()` Gets the chunk stream id.
`byte[]`	`getData()` Gets the data.
`RpcDataPackage`	`getErrorResponseRpcDataPackage(int errorCode, String errorText)` Gets the error response rpc data package.
`RpcDataPackage`	`getErrorResponseRpcDataPackage(RpcResponseMeta responseMeta)` Gets the error response rpc data package.
`RpcHeadMeta`	`getHead()` Gets the head.
`RpcMeta`	`getRpcMeta()` Gets the rpc meta.
`long`	`getTimeStamp()` Gets the time stamp.
`boolean`	`isChunkPackage()` Checks if is chunk package.
`boolean`	`isFinalPackage()` Checks if is final package.
`RpcDataPackage`	`logId(long logId)` Log id.
`RpcDataPackage`	`magicCode(String magicCode)` set magic code.
`void`	`mergeData(byte[] data)` Merge data.
`String`	`methodName()` Method name.
`RpcDataPackage`	`methodName(String methodName)` Method name.
`void`	`read(byte[] bytes)` Do deserializable action.
`String`	`serviceName()` Service name.
`RpcDataPackage`	`serviceName(String serviceName)` Service name.
`void`	`setAttachment(byte[] attachment)` Sets the attachment.
`void`	`setData(byte[] data)` Sets the data.
`void`	`setHead(RpcHeadMeta head)` Sets the head.
`void`	`setMagicCode(String magicCode)` Sets the magic code.
`protected void`	`setRpcMeta(RpcMeta rpcMeta)` Sets the rpc meta.
`void`	`setTimeStamp(long timeStamp)` Sets the time stamp.
`Trace`	`trace()` Trace.
`RpcDataPackage`	`trace(Trace trace)` set Trace value.
`byte[]`	`write()` Write.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - RpcDataPackage
```
public RpcDataPackage()
```
- 方法详细资料
  - mergeData
```
public void mergeData(byte[] data)
```
    Merge data.
    
    参数:
    
    data - the data
  - isChunkPackage
```
public boolean isChunkPackage()
```
    Checks if is chunk package.
    
    返回:
    
    true, if is chunk package
  - isFinalPackage
```
public boolean isFinalPackage()
```
    Checks if is final package.
    
    返回:
    
    true, if is final package
  - getChunkStreamId
```
public Long getChunkStreamId()
```
    Gets the chunk stream id.
    
    返回:
    
    the chunk stream id
  - chunk
```
public List<RpcDataPackage> chunk(long chunkSize)
```
    To split current RpcDataPackage by chunkSize. if chunkSize great than data length will not do split.
    List return will never be null or empty.
    
    参数:
    
    chunkSize - target size to split
    
    返回:
    
    List of RpcDataPackage after split
  - copy
```
public RpcDataPackage copy()
```
    Copy.
    
    返回:
    
    the rpc data package
  - magicCode
```
public RpcDataPackage magicCode(String magicCode)
```
    set magic code.
    
    参数:
    
    magicCode - the magic code
    
    返回:
    
    the rpc data package
  - serviceName
```
public RpcDataPackage serviceName(String serviceName)
```
    Service name.
    
    参数:
    
    serviceName - the service name
    
    返回:
    
    the rpc data package
  - serviceName
```
public String serviceName()
```
    Service name.
    
    返回:
    
    the string
  - methodName
```
public String methodName()
```
    Method name.
    
    返回:
    
    the string
  - methodName
```
public RpcDataPackage methodName(String methodName)
```
    Method name.
    
    参数:
    
    methodName - the method name
    
    返回:
    
    the rpc data package
  - data
```
public RpcDataPackage data(byte[] data)
```
    Data.
    
    参数:
    
    data - the data
    
    返回:
    
    the rpc data package
  - attachment
```
public RpcDataPackage attachment(byte[] attachment)
```
    Attachment.
    
    参数:
    
    attachment - the attachment
    
    返回:
    
    the rpc data package
  - authenticationData
```
public RpcDataPackage authenticationData(byte[] authenticationData)
```
    Authentication data.
    
    参数:
    
    authenticationData - the authentication data
    
    返回:
    
    the rpc data package
  - correlationId
```
public RpcDataPackage correlationId(long correlationId)
```
    Correlation id.
    
    参数:
    
    correlationId - the correlation id
    
    返回:
    
    the rpc data package
  - compressType
```
public RpcDataPackage compressType(int compressType)
```
    Compress type.
    
    参数:
    
    compressType - the compress type
    
    返回:
    
    the rpc data package
  - logId
```
public RpcDataPackage logId(long logId)
```
    Log id.
    
    参数:
    
    logId - the log id
    
    返回:
    
    the rpc data package
  - errorCode
```
public RpcDataPackage errorCode(int errorCode)
```
    Error code.
    
    参数:
    
    errorCode - the error code
    
    返回:
    
    the rpc data package
  - errorText
```
public RpcDataPackage errorText(String errorText)
```
    Error text.
    
    参数:
    
    errorText - the error text
    
    返回:
    
    the rpc data package
  - extraParams
```
public RpcDataPackage extraParams(byte[] params)
```
    Extra params.
    
    参数:
    
    params - the params
    
    返回:
    
    the rpc data package
  - chunkInfo
```
public RpcDataPackage chunkInfo(long streamId,
                                int chunkId)
```
    Chunk info.
    
    参数:
    
    streamId - the stream id
    
    chunkId - the chunk id
    
    返回:
    
    the rpc data package
  - trace
```
public RpcDataPackage trace(Trace trace)
```
    set Trace value.
    
    参数:
    
    trace - the trace
    
    返回:
    
    the rpc data package
  - trace
```
public Trace trace()
```
    Trace.
    
    返回:
    
    the trace
  - setMagicCode
```
public void setMagicCode(String magicCode)
```
    Sets the magic code.
    
    参数:
    
    magicCode - the new magic code
  - getHead
```
public RpcHeadMeta getHead()
```
    Gets the head.
    
    返回:
    
    the head
  - setHead
```
public void setHead(RpcHeadMeta head)
```
    Sets the head.
    
    参数:
    
    head - the new head
  - getRpcMeta
```
public RpcMeta getRpcMeta()
```
    Gets the rpc meta.
    
    返回:
    
    the rpc meta
  - setRpcMeta
```
protected void setRpcMeta(RpcMeta rpcMeta)
```
    Sets the rpc meta.
    
    参数:
    
    rpcMeta - the new rpc meta
  - getData
```
public byte[] getData()
```
    Gets the data.
    
    返回:
    
    the data
  - setData
```
public void setData(byte[] data)
```
    Sets the data.
    
    参数:
    
    data - the new data
  - getTimeStamp
```
public long getTimeStamp()
```
    Gets the time stamp.
    
    返回:
    
    the time stamp
  - setTimeStamp
```
public void setTimeStamp(long timeStamp)
```
    Sets the time stamp.
    
    参数:
    
    timeStamp - the new time stamp
  - getAttachment
```
public byte[] getAttachment()
```
    Gets the attachment.
    
    返回:
    
    the attachment
  - setAttachment
```
public void setAttachment(byte[] attachment)
```
    Sets the attachment.
    
    参数:
    
    attachment - the new attachment
  - getErrorResponseRpcDataPackage
```
public RpcDataPackage getErrorResponseRpcDataPackage(int errorCode,
                                                     String errorText)
```
    Gets the error response rpc data package.
    
    参数:
    
    errorCode - the error code
    
    errorText - the error text
    
    返回:
    
    the error response rpc data package
  - getErrorResponseRpcDataPackage
```
public RpcDataPackage getErrorResponseRpcDataPackage(RpcResponseMeta responseMeta)
```
    Gets the error response rpc data package.
    
    参数:
    
    responseMeta - the response meta
    
    返回:
    
    the error response rpc data package
  - write
```
public byte[] write()
```
    从接口复制的说明: Writerable
    
    Write.
    
    指定者:
    
    write 在接口中 Writerable
    
    返回:
    
    all content as byte array
  - read
```
public void read(byte[] bytes)
```
    从接口复制的说明: Readable
    
    Do deserializable action.
    
    指定者:
    
    read 在接口中 Readable
    
    参数:
    
    bytes - the bytes
  - buildRpcDataPackage
```
public static RpcDataPackage buildRpcDataPackage(RpcMethodInfo methodInfo,
                                                 Object[] args)
                                          throws IOException
```
    Builds the rpc data package.
    
    参数:
    
    methodInfo - the method info
    
    args - the args
    
    返回:
    
    the rpc data package
    
    抛出:
    
    IOException - Signals that an I/O exception has occurred.

类 RpcDataPackage

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

RpcDataPackage

方法详细资料

mergeData

isChunkPackage

isFinalPackage

getChunkStreamId

chunk

copy

magicCode

serviceName

serviceName

methodName

methodName

data

attachment

authenticationData

correlationId

compressType

logId

errorCode

errorText

extraParams

chunkInfo

trace

trace

setMagicCode

getHead

setHead

getRpcMeta

setRpcMeta

getData

setData

getTimeStamp

setTimeStamp

getAttachment

setAttachment

getErrorResponseRpcDataPackage

getErrorResponseRpcDataPackage

write

read

buildRpcDataPackage