package protocol
Type Members
- abstract class AbstractMessage extends Message
Abstract class for messages which optionally contain a body kept in a separate buffer.
- abstract class AbstractResponseMessage extends AbstractMessage with ResponseMessage
Abstract class for response messages.
- final class ChunkFetchFailure extends AbstractMessage with ResponseMessage
Response to
ChunkFetchRequestwhen there is an error fetching the chunk. - final class ChunkFetchRequest extends AbstractMessage with RequestMessage
Request to fetch a sequence of a single chunk of a stream.
Request to fetch a sequence of a single chunk of a stream. This will correspond to a single
org.apache.spark.network.protocol.ResponseMessage(either success or failure). - final class ChunkFetchSuccess extends AbstractResponseMessage
Response to
ChunkFetchRequestwhen a chunk exists and has been successfully fetched.Response to
ChunkFetchRequestwhen a chunk exists and has been successfully fetched.Note that the server-side encoding of this messages does NOT include the buffer itself, as this may be written by Netty in a more efficient manner (i.e., zero-copy write). Similarly, the client-side decoding will reuse the Netty ByteBuf as the buffer.
- trait Encodable extends AnyRef
Interface for an object which can be encoded into a ByteBuf.
Interface for an object which can be encoded into a ByteBuf. Multiple Encodable objects are stored in a single, pre-allocated ByteBuf, so Encodables must also provide their length.
Encodable objects should provide a static "decode(ByteBuf)" method which is invoked by
MessageDecoder. During decoding, if the object uses the ByteBuf as its data (rather than just copying data from it), then you must retain() the ByteBuf.Additionally, when adding a new Encodable Message, add it to
Message.Type. - class Encoders extends AnyRef
Provides a canonical set of Encoders for simple types.
- class MergedBlockMetaRequest extends AbstractMessage with RequestMessage
Request to find the meta information for the specified merged block.
Request to find the meta information for the specified merged block. The meta information contains the number of chunks in the merged blocks and the maps ids in each chunk.
- Since
3.2.0
- class MergedBlockMetaSuccess extends AbstractResponseMessage
Response to
MergedBlockMetaRequestrequest.Response to
MergedBlockMetaRequestrequest. Note that the server-side encoding of this messages does NOT include the buffer itself.- Since
3.2.0
- trait Message extends Encodable
An on-the-wire transmittable message.
- final class MessageDecoder extends MessageToMessageDecoder[ByteBuf]
Decoder used by the client side to encode server-to-client responses.
Decoder used by the client side to encode server-to-client responses. This encoder is stateless so it is safe to be shared by multiple threads.
- Annotations
- @Sharable()
- final class MessageEncoder extends MessageToMessageEncoder[Message]
Encoder used by the server side to encode server-to-client responses.
Encoder used by the server side to encode server-to-client responses. This encoder is stateless so it is safe to be shared by multiple threads.
- Annotations
- @Sharable()
- final class OneWayMessage extends AbstractMessage with RequestMessage
A RPC that does not expect a reply, which is handled by a remote
org.apache.spark.network.server.RpcHandler. - trait RequestMessage extends Message
Messages from the client to the server.
- trait ResponseMessage extends Message
Messages from the server to the client.
- final class RpcFailure extends AbstractMessage with ResponseMessage
Response to
RpcRequestfor a failed RPC. - final class RpcRequest extends AbstractMessage with RequestMessage
A generic RPC which is handled by a remote
org.apache.spark.network.server.RpcHandler.A generic RPC which is handled by a remote
org.apache.spark.network.server.RpcHandler. This will correspond to a singleorg.apache.spark.network.protocol.ResponseMessage(either success or failure). - final class RpcResponse extends AbstractResponseMessage
Response to
RpcRequestfor a successful RPC. - final class StreamChunkId extends Encodable
Encapsulates a request for a particular chunk of a stream.
- final class StreamFailure extends AbstractMessage with ResponseMessage
Message indicating an error when transferring a stream.
- final class StreamRequest extends AbstractMessage with RequestMessage
Request to stream data from the remote end.
Request to stream data from the remote end.
The stream ID is an arbitrary string that needs to be negotiated between the two endpoints before the data can be streamed.
- final class StreamResponse extends AbstractResponseMessage
Response to
StreamRequestwhen the stream has been successfully opened.Response to
StreamRequestwhen the stream has been successfully opened.Note the message itself does not contain the stream data. That is written separately by the sender. The receiver is expected to set a temporary channel handler that will consume the number of bytes this message says the stream has.
- final class UploadStream extends AbstractMessage with RequestMessage
An RPC with data that is sent outside of the frame, so it can be read as a stream.