RPCProtoMessage (Alluxio Parent 305-SNAPSHOT API)

java.lang.Object
- alluxio.network.protocol.RPCMessage
- - alluxio.network.protocol.RPCProtoMessage

All Implemented Interfaces:

EncodedMessage
```
@ThreadSafe
public final class RPCProtoMessage
extends RPCMessage
```
This is the main base class for all protocol buffer based RPC messages to the DataServer. Each RPC message is composed of a proto message and a data buffer.
Encoded format: [proto message length][serialized proto message][data buffer] The proto message length doesn't include the length of itself (the length field).
Note: The data buffer must be released when it is not used. Usually this is how it is released: 1. On the consumer side, a RPCProtoMessage is decoded and the data buffer is extracted. The ownership of the data buffer is transferred from then on. 2. On the producer side, a RPCProtoMessage is created. It will be sent on the wire via netty which will take ownership of the data buffer. Given the above usage patterns, RPCProtoMessage doesn't provide a 'release' interface to avoid confusing the user.

Nested Class Summary
- Nested classes/interfaces inherited from class alluxio.network.protocol.RPCMessage
  RPCMessage.Type

Constructor Summary

Constructors
Constructor and Description
`RPCProtoMessage(byte[] serialized, ProtoMessage prototype, DataBuffer data)` Creates an instance of `RPCProtoMessage` from a serialized proto message.
`RPCProtoMessage(ProtoMessage message)` Creates an instance of `RPCProtoMessage` without data part.
`RPCProtoMessage(ProtoMessage message, DataBuffer data)` Creates an instance of `RPCProtoMessage`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RPCProtoMessage`	`createCancelResponse()` Creates a response in CANCELLED state.
`static RPCProtoMessage`	`createOkResponse(DataBuffer data)` Creates an OK response with data.
`static RPCProtoMessage`	`createResponse(AlluxioStatusException se)` Creates a response for a given `AlluxioStatusException`.
`static RPCProtoMessage`	`createResponse(io.grpc.Status status, String message, DataBuffer data)` Creates a response for a given status, message, and data buffer.
`static RPCProtoMessage`	`decode(io.netty.buffer.ByteBuf in, ProtoMessage prototype)` Decodes the message from a buffer.
`void`	`encode(io.netty.buffer.ByteBuf out)` Encodes the message to the output `ByteBuf`.
`static io.grpc.Status`	`fromProto(Status.PStatus status)` Creates a `Status` from a protocol buffer type status.
`int`	`getEncodedLength()` Returns the number bytes for the message when it is encoded.
`ProtoMessage`	`getMessage()`
`DataBuffer`	`getPayloadDataBuffer()` Returns the data buffer of the payload.
`RPCMessage.Type`	`getType()` Returns the type of the message.
`boolean`	`hasPayload()` Returns true if the message has a payload.
`static Status.PStatus`	`toProto(io.grpc.Status status)` Converts an internal exception status to a protocol buffer type status.
`String`	`toString()`
`void`	`validate()` Validates the message.

Methods inherited from class alluxio.network.protocol.RPCMessage
createFrameDecoder, decodeMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RPCProtoMessage
```
public RPCProtoMessage(ProtoMessage message,
                       DataBuffer data)
```
    Creates an instance of RPCProtoMessage.
    
    Parameters:
    
    message - the message
    
    data - the data which can be null. Ownership is taken by this class
  - RPCProtoMessage
```
public RPCProtoMessage(ProtoMessage message)
```
    Creates an instance of RPCProtoMessage without data part.
    
    Parameters:
    
    message - the message
  - RPCProtoMessage
```
public RPCProtoMessage(byte[] serialized,
                       ProtoMessage prototype,
                       DataBuffer data)
```
    Creates an instance of RPCProtoMessage from a serialized proto message.
    
    Parameters:
    
    serialized - the serialized message
    
    prototype - the prototype of the message used to identify the type of the message
    
    data - the data which can be null
- Method Detail
  - getEncodedLength
```
public int getEncodedLength()
```
    Description copied from interface: EncodedMessage
    
    Returns the number bytes for the message when it is encoded.
    
    Returns:
    
    the length of the encoded message, in bytes
  - encode
```
public void encode(io.netty.buffer.ByteBuf out)
```
    Description copied from interface: EncodedMessage
    
    Encodes the message to the output ByteBuf.
    
    Parameters:
    
    out - the output ByteBuf where the message should be encoded
  - decode
```
public static RPCProtoMessage decode(io.netty.buffer.ByteBuf in,
                                     ProtoMessage prototype)
```
    Decodes the message from a buffer. This method increments the refcount of the bytebuf passed by 1.
    
    Parameters:
    
    in - the buffer
    
    prototype - a message prototype used to infer the type of the message
    
    Returns:
    
    the message decoded
  - getType
```
public RPCMessage.Type getType()
```
    Description copied from class: RPCMessage
    
    Returns the type of the message.
    
    Specified by:
    
    getType in class RPCMessage
    
    Returns:
    
    the message type
  - validate
```
public void validate()
```
    Description copied from class: RPCMessage
    
    Validates the message. Throws an Exception if the message is invalid.
    
    Overrides:
    
    validate in class RPCMessage
  - hasPayload
```
public boolean hasPayload()
```
    Description copied from class: RPCMessage
    
    Returns true if the message has a payload. The encoder will send the payload with a more efficient method.
    
    Overrides:
    
    hasPayload in class RPCMessage
    
    Returns:
    
    true if the message has a payload, false otherwise
  - getPayloadDataBuffer
```
public DataBuffer getPayloadDataBuffer()
```
    Description copied from class: RPCMessage
    
    Returns the data buffer of the payload.
    
    Overrides:
    
    getPayloadDataBuffer in class RPCMessage
    
    Returns:
    
    The DataBuffer representing the payload
  - getMessage
```
public ProtoMessage getMessage()
```
    Returns:
    
    the message
  - createResponse
```
public static RPCProtoMessage createResponse(AlluxioStatusException se)
```
    Creates a response for a given AlluxioStatusException.
    
    Parameters:
    
    se - the AlluxioStatusException
    
    Returns:
    
    the created RPCProtoMessage
  - createResponse
```
public static RPCProtoMessage createResponse(io.grpc.Status status,
                                             String message,
                                             DataBuffer data)
```
    Creates a response for a given status, message, and data buffer.
    
    Parameters:
    
    status - the status code
    
    message - the message
    
    data - the data buffer
    
    Returns:
    
    the created RPCProtoMessage
  - createOkResponse
```
public static RPCProtoMessage createOkResponse(DataBuffer data)
```
    Creates an OK response with data.
    
    Parameters:
    
    data - the data
    
    Returns:
    
    the message created
  - createCancelResponse
```
public static RPCProtoMessage createCancelResponse()
```
    Creates a response in CANCELLED state.
    
    Returns:
    
    the message created
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toProto
```
public static Status.PStatus toProto(io.grpc.Status status)
```
    Converts an internal exception status to a protocol buffer type status.
    
    Parameters:
    
    status - the status to convert
    
    Returns:
    
    the protocol buffer type status
  - fromProto
```
public static io.grpc.Status fromProto(Status.PStatus status)
```
    Creates a Status from a protocol buffer type status.
    
    Parameters:
    
    status - the protocol buffer type status
    
    Returns:
    
    the corresponding Status

Class RPCProtoMessage

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.network.protocol.RPCMessage

Constructor Summary

Method Summary

Methods inherited from class alluxio.network.protocol.RPCMessage

Methods inherited from class java.lang.Object

Constructor Detail

RPCProtoMessage

RPCProtoMessage

RPCProtoMessage

Method Detail

getEncodedLength

encode

decode

getType

validate

hasPayload

getPayloadDataBuffer

getMessage

createResponse

createResponse

createOkResponse

createCancelResponse

toString

toProto

fromProto