Packages

package protocol

Type Members

  1. abstract class AbstractMessage extends Message

    Abstract class for messages which optionally contain a body kept in a separate buffer.

  2. abstract class AbstractResponseMessage extends AbstractMessage with ResponseMessage

    Abstract class for response messages.

  3. final class ChunkFetchFailure extends AbstractMessage with ResponseMessage

    Response to ChunkFetchRequest when there is an error fetching the chunk.

  4. 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).

  5. final class ChunkFetchSuccess extends AbstractResponseMessage

    Response to ChunkFetchRequest when a chunk exists and has been successfully fetched.

    Response to ChunkFetchRequest when 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.

  6. 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.

  7. class Encoders extends AnyRef

    Provides a canonical set of Encoders for simple types.

  8. 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

  9. class MergedBlockMetaSuccess extends AbstractResponseMessage

    Response to MergedBlockMetaRequest request.

    Response to MergedBlockMetaRequest request. Note that the server-side encoding of this messages does NOT include the buffer itself.

    Since

    3.2.0

  10. trait Message extends Encodable

    An on-the-wire transmittable message.

  11. 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()
  12. 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()
  13. 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.

  14. trait RequestMessage extends Message

    Messages from the client to the server.

  15. trait ResponseMessage extends Message

    Messages from the server to the client.

  16. final class RpcFailure extends AbstractMessage with ResponseMessage

    Response to RpcRequest for a failed RPC.

  17. 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 single org.apache.spark.network.protocol.ResponseMessage (either success or failure).

  18. final class RpcResponse extends AbstractResponseMessage

    Response to RpcRequest for a successful RPC.

  19. final class StreamChunkId extends Encodable

    Encapsulates a request for a particular chunk of a stream.

  20. final class StreamFailure extends AbstractMessage with ResponseMessage

    Message indicating an error when transferring a stream.

  21. 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.

  22. final class StreamResponse extends AbstractResponseMessage

    Response to StreamRequest when the stream has been successfully opened.

    Response to StreamRequest when 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.

  23. 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.

Ungrouped