Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
rapidsmpf::shuffler::detail::ReadyForDataMessage Class Reference

Represents a message indicating readiness to receive data for a specific chunk. More...

#include <chunk.hpp>

Public Member Functions

std::unique_ptr< std::vector< uint8_t > > pack ()
 Serializes the message into a byte array. More...
 
std::string str () const
 Returns a description of this instance. More...
 

Static Public Member Functions

static ReadyForDataMessage unpack (std::unique_ptr< std::vector< uint8_t >> const &msg)
 Deserializes a message from a byte array. More...
 

Public Attributes

ChunkID cid
 Chunk ID associated with the message.
 

Static Public Attributes

static constexpr size_t byte_size = sizeof(ChunkID)
 The size of the message in bytes when serialized. More...
 

Detailed Description

Represents a message indicating readiness to receive data for a specific chunk.

Definition at line 394 of file chunk.hpp.

Member Function Documentation

◆ pack()

std::unique_ptr<std::vector<uint8_t> > rapidsmpf::shuffler::detail::ReadyForDataMessage::pack ( )
inline

Serializes the message into a byte array.

Returns
A serialized byte vector representing the message.

Definition at line 410 of file chunk.hpp.

◆ str()

std::string rapidsmpf::shuffler::detail::ReadyForDataMessage::str ( ) const
inline

Returns a description of this instance.

Returns
The description.

Definition at line 434 of file chunk.hpp.

◆ unpack()

static ReadyForDataMessage rapidsmpf::shuffler::detail::ReadyForDataMessage::unpack ( std::unique_ptr< std::vector< uint8_t >> const &  msg)
inlinestatic

Deserializes a message from a byte array.

Parameters
msgA serialized message byte vector.
Returns
A ReadyForDataMessage object.

Definition at line 422 of file chunk.hpp.

Member Data Documentation

◆ byte_size

constexpr size_t rapidsmpf::shuffler::detail::ReadyForDataMessage::byte_size = sizeof(ChunkID)
staticconstexpr

The size of the message in bytes when serialized.

Returns
The size of the message in bytes.

Definition at line 403 of file chunk.hpp.


The documentation for this class was generated from the following file: