irsol::protocol::Serializer Class Reference

Serializes outgoing protocol messages and primitive values. More...

#include <serializer.hpp>

Classes
struct	SpecialBytes
	Special byte constants used in the Simple Communication Protocol. More...

Static Public Member Functions
static internal::SerializedMessage	serialize (OutMessage &&msg)
	Serialize an irsol::protocol::OutMessage variant into a serialized protocol message.
template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant_v< T, OutMessage >, int > = 0>
static internal::SerializedMessage	serialize (T &&msg)
	Serialize a specific irsol::protocol::OutMessage type into a serialized protocol message.
static std::string	serializeValue (irsol::types::protocol_value_t &&value)
	Serialize a protocol primitive value to a string.
template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant< T, irsol::types::protocol_value_t >::value, int > = 0>
static std::string	serializeValue (T &&value)
	Serialize a specific primitive type to a string.
static std::string	serializeBinaryDataAttribute (irsol::protocol::BinaryDataAttribute &&att)
	Serialize a irsol::protocol::BinaryDataAttribute to a string.

Static Public Attributes
static constexpr const char *	message_termination = "\n"
	Message line termination sequence (newline character) used to "close" a serialized message.

Private Member Functions
	Serializer ()=delete
	This class cannot be instantiated.

Static Private Member Functions
static internal::SerializedMessage	serializeSuccess (Success &&msg)
	Serializes a irsol::protocol::Success message to a binary protocol message.
static internal::SerializedMessage	serializeBinaryDataBuffer (BinaryDataBuffer &&msg)
	Serializes a irsol::protocol::BinaryDataBuffer message to a binary protocol message.
static internal::SerializedMessage	serializeImageBinaryData (ImageBinaryData &&msg)
	Serializes a irsol::protocol::ImageBinaryData message to a binary protocol message.
static internal::SerializedMessage	serializeColorImageBinaryData (ColorImageBinaryData &&msg)
	Serializes a irsol::protocol::ColorImageBinaryData message to a binary protocol message.
static internal::SerializedMessage	serializeError (Error &&msg)
	Serializes a irsol::protocol::Error message to a binary protocol message.

Detailed Description

Serializes outgoing protocol messages and primitive values.

This class offers a collection of static methods to serialize irsol::protocol::OutMessage variant types, as well as protocol primitive values such as integers, doubles, and strings (irsol::types::protocol_value_t), into irsol::protocol::internal::SerializedMessage instances or plain strings.

The class uses compile-time checks to ensure that only valid message types are serialized. It also provides utility constants for the special byte markers used in the protocol, following the Simple Communication Protocol specification used by irsol.

The serialization consumes the input message or value (via rvalue references), leaving the original object in a valid but unspecified state.

Definition at line 45 of file serializer.hpp.

Constructor & Destructor Documentation

Serializer()

irsol::protocol::Serializer::Serializer ( )

privatedelete

This class cannot be instantiated.

Member Function Documentation

serialize() [1/2]

internal::SerializedMessage irsol::protocol::Serializer::serialize ( OutMessage &&  msg )

static

Serialize an irsol::protocol::OutMessage variant into a serialized protocol message.

The message is consumed by this operation.

Parameters

msg	The irsol::protocol::OutMessage to serialize.

Returns

A irsol::protocol::internal::SerializedMessage containing the serialized message.

Definition at line 14 of file serializer.cpp.

{
 
  return std::visit(
    [](auto&& msg) -> internal::SerializedMessage {
      using T = std::decay_t<decltype(msg)>;
      return serialize<T>(std::move(msg));
    },
    msg);
}

serialize() [2/2]

template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant_v< T, OutMessage >, int > = 0>

static internal::SerializedMessage irsol::protocol::Serializer::serialize ( T &&  msg )

inlinestatic

Serialize a specific irsol::protocol::OutMessage type into a serialized protocol message.

Enabled only for types contained in the irsol::protocol::OutMessage variant. The method dispatches to specialized serialization functions based on message type.

Template Parameters

T	The specific irsol::protocol::OutMessage type to serialize.

Parameters

msg	The message to serialize.

Returns

A irsol::protocol::internal::SerializedMessage containing the serialized message.

Warning

The input msg is consumed by this function and is left in a valid but unspecified state after the call.

Definition at line 95 of file serializer.hpp.

  {
    if constexpr(std::is_same_v<T, Success>) {
      return serializeSuccess(std::move(msg));
    } else if constexpr(std::is_same_v<T, BinaryDataBuffer>) {
      return serializeBinaryDataBuffer(std::move(msg));
    } else if constexpr(std::is_same_v<T, ImageBinaryData>) {
      return serializeImageBinaryData(std::move(msg));
    } else if constexpr(std::is_same_v<T, ColorImageBinaryData>) {
      return serializeColorImageBinaryData(std::move(msg));
    } else if constexpr(std::is_same_v<T, Error>) {
      return serializeError(std::move(msg));
    } else
      IRSOL_MISSING_TEMPLATE_SPECIALIZATION(T, "Serializer::serialize()");
  }

serializeBinaryDataAttribute()

std::string irsol::protocol::Serializer::serializeBinaryDataAttribute ( irsol::protocol::BinaryDataAttribute &&  att )

static

Serialize a irsol::protocol::BinaryDataAttribute to a string.

Parameters

att	The irsol::protocol::BinaryDataAttribute to serialize.

Returns

A string representation of the serialized attribute.

Definition at line 131 of file serializer.cpp.

{
  std::stringstream ss;
  ss << att.identifier << "=" << serializeValue(std::move(att.value));
  return ss.str();
}

serializeBinaryDataBuffer()

internal::SerializedMessage irsol::protocol::Serializer::serializeBinaryDataBuffer ( BinaryDataBuffer &&  msg )

staticprivate

Serializes a irsol::protocol::BinaryDataBuffer message to a binary protocol message.

Parameters

msg	The BinaryDataBuffer message to serialize.

Returns

A SerializedMessage containing the serialized binary data buffer.

Warning

The input msg is consumed by this function and is left in a valid but unspecified state after the call.

Definition at line 63 of file serializer.cpp.

{
  IRSOL_LOG_TRACE("Serializing binary buffer: {}", msg.toString());
  // TODO: implement serialization
  throw std::runtime_error("Binary data serialization not supported");
}

serializeColorImageBinaryData()

internal::SerializedMessage irsol::protocol::Serializer::serializeColorImageBinaryData ( ColorImageBinaryData &&  msg )

staticprivate

Serializes a irsol::protocol::ColorImageBinaryData message to a binary protocol message.

Parameters

msg	The ColorImageBinaryData message to serialize.

Returns

A SerializedMessage containing the serialized color image data.

Warning

The input msg is consumed by this function and is left in a valid but unspecified state after the call.

Definition at line 116 of file serializer.cpp.

{
  IRSOL_LOG_TRACE("Serializing color image binary data: {}", msg.toString());
  // TODO: implement serialization
  throw std::runtime_error("Binary data serialization not supported");
}

serializeError()

internal::SerializedMessage irsol::protocol::Serializer::serializeError ( Error &&  msg )

staticprivate

Serializes a irsol::protocol::Error message to a binary protocol message.

Parameters

msg	The Error message to serialize.

Returns

A SerializedMessage containing the serialized error message.

Warning

The input msg is consumed by this function and is left in a valid but unspecified state after the call.

Definition at line 124 of file serializer.cpp.

{
  IRSOL_LOG_TRACE("Serializing error message: {}", msg.toString());
  return {msg.identifier + ": Error: " + msg.description + Serializer::message_termination, {}};
}

serializeImageBinaryData()

internal::SerializedMessage irsol::protocol::Serializer::serializeImageBinaryData ( ImageBinaryData &&  msg )

staticprivate

Serializes a irsol::protocol::ImageBinaryData message to a binary protocol message.

This method serializes the image data into a binary buffer suitable for transmission. The image data is assumed to be in unpacked Mono12 format (2 bytes per pixel). During serialization, the bytes for each pixel are swapped (i.e., the order of the two bytes for each pixel is reversed) to match the IRSOL server protocol requirements. The resulting buffer contains the image data with swapped bytes, ready for network transfer.

Parameters

msg	The ImageBinaryData message to serialize.

Returns

A SerializedMessage containing the serialized image data with swapped bytes.

Note

The byte swapping is required so that the client can reconstruct the image correctly using irsol::camera::PixelByteSwapper and related utilities.

Warning

The input msg is consumed by this function and is left in a valid but unspecified state after the call.

Definition at line 71 of file serializer.cpp.

{
  IRSOL_LOG_TRACE("Serializing image binary data: {}", msg.toString());
 
  std::vector<irsol::types::byte_t> payload;
  payload.reserve(msg.data.size() + 128);  // Reserve extra for header/meta
 
  {
    std::string imagePrefix        = "img=";
    auto        imagePrefixAsBytes = irsol::utils::stringToBytes(imagePrefix);
    std::move(imagePrefixAsBytes.begin(), imagePrefixAsBytes.end(), std::back_inserter(payload));
  }
  payload.emplace_back(Serializer::SpecialBytes::SOH);
  {
    std::stringstream ss;
    ss << "u" << msg.BYTES_PER_ELEMENT * 8 << "[" << msg.shape[0] << "," << msg.shape[1] << "]";
    for(auto& att : msg.attributes) {
      ss << " " << serializeBinaryDataAttribute(std::move(att));
    }
    auto attributesString = ss.str();
    IRSOL_LOG_DEBUG(
      "Attributes for message '{}' serialized to {}", msg.toString(), attributesString);
    auto attributesStringAsBytes = irsol::utils::stringToBytes(attributesString);
 
    payload.insert(payload.end(), attributesStringAsBytes.begin(), attributesStringAsBytes.end());
  }
  payload.emplace_back(Serializer::SpecialBytes::STX);
 
  // Copy image data to the end of the payload buffer
  size_t dataOffset = payload.size();
  payload.resize(payload.size() + msg.data.size());
  std::memcpy(&payload[dataOffset], msg.data.data(), msg.data.size());
 
  // Swap bytes in-place for 16-bit data (assume always 16-bit)
  // This swaps each pair of bytes in the image data region of the payload.
  irsol::camera::PixelByteSwapper<true>()(
    payload.begin() + static_cast<std::ptrdiff_t>(dataOffset), payload.end());
 
  payload.emplace_back(Serializer::SpecialBytes::ETX);
 
  auto message = internal::SerializedMessage("", std::move(payload));
  return std::move(message);
}

serializeSuccess()

internal::SerializedMessage irsol::protocol::Serializer::serializeSuccess ( Success &&  msg )

staticprivate

Serializes a irsol::protocol::Success message to a binary protocol message.

Parameters

msg	The Success message to serialize.

Returns

A SerializedMessage containing the serialized Success message.

Warning

The input msg is consumed by this function and is left in a valid but unspecified state after the call.

Definition at line 37 of file serializer.cpp.

{
  IRSOL_LOG_TRACE("Serializing Success message: {}", msg.toString());
  std::string result = msg.identifier;
  if(msg.source == InMessageKind::ASSIGNMENT) {
    IRSOL_ASSERT_ERROR(
      msg.hasBody(),
      "Body is not present in 'Success' message, created from 'Assignment'. This should "
      "never happen, as a successful assignment should always provide a body for the "
      "associated Success message.");
    auto body = *msg.body;
    result += "=" + serializeValue(std::move(body)) + Serializer::message_termination;
  } else if(msg.source == InMessageKind::INQUIRY) {
    if(msg.hasBody()) {
      auto body = *msg.body;
      result += "=" + serializeValue(std::move(body)) + Serializer::message_termination;
    } else {
      result += Serializer::message_termination;
    }
  } else if(msg.source == InMessageKind::COMMAND) {
    result += ";\n";
  }
  return {result, {}};
}

serializeValue() [1/2]

std::string irsol::protocol::Serializer::serializeValue ( irsol::types::protocol_value_t &&  value )

static

Serialize a protocol primitive value to a string.

Supported types include int, double, and std::string (see irsol::types::protocol_value_t).

Parameters

value

The protocol value to serialize.

Returns

A string representation of the serialized value.

Definition at line 26 of file serializer.cpp.

{
  return std::visit(
    [](auto&& val) -> std::string {
      using T = std::decay_t<decltype(val)>;
      return serializeValue<T>(std::move(val));
    },
    value);
}

serializeValue() [2/2]

template<typename T , std::enable_if_t< irsol::traits::is_type_in_variant< T, irsol::types::protocol_value_t >::value, int > = 0>

static std::string irsol::protocol::Serializer::serializeValue ( T &&  value )

inlinestatic

Serialize a specific primitive type to a string.

Enabled only for types contained in irsol::types::protocol_value_t.

Template Parameters

T	The primitive type to serialize (int, double, or std::string).

Parameters

value

The value to serialize.

Returns

A string representation of the serialized value.

Definition at line 136 of file serializer.hpp.

  {
    if constexpr(std::is_same_v<T, int>) {
      return std::to_string(value);
    } else if constexpr(std::is_same_v<T, double>) {
      return std::to_string(value);
    } else if constexpr(std::is_same_v<T, std::string>) {
      return "{" + value + "}";
    } else
      IRSOL_MISSING_TEMPLATE_SPECIALIZATION(T, "Serializer::serializeValue()");
  }

Member Data Documentation

message_termination

constexpr const char* irsol::protocol::Serializer::message_termination = "\n"

staticconstexpr

Message line termination sequence (newline character) used to "close" a serialized message.

Definition at line 65 of file serializer.hpp.

---

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

• src/irsol/include/irsol/protocol/serialization/serializer.hpp
• src/irsol/lib/irsol/protocol/serialization/serializer.cpp