irsol::protocol::Success Struct Reference

Represents a success response message from the server. More...

#include <success.hpp>

Public Member Functions
std::string	toString () const
	Converts the success message to a human-readable string.
bool	hasBody () const
bool	hasInt () const
bool	hasDouble () const
bool	hasString () const

Static Public Member Functions
static Success	from (const Assignment &msg, std::optional< irsol::types::protocol_value_t > overrideValue=std::nullopt)
	Creates a success message from an Assignment.
static Success	from (const Command &msg)
	Creates a success message from a Command.
static Success	from (const Inquiry &msg, irsol::types::protocol_value_t result)
	Creates a success message from an Inquiry.
static Success	asStatus (const std::string &identifier, irsol::types::protocol_value_t value)
	Creates a standalone status message with a value.

Public Attributes
std::string	identifier
	The identifier associated with the success response.
InMessageKind	source
	The kind of the incoming message that triggered this response.
std::optional< irsol::types::protocol_value_t >	body {}
	Optional result or data associated with the response.

Private Member Functions
	Success (const std::string &identifier, InMessageKind source, std::optional< irsol::types::protocol_value_t > body=std::nullopt)

Detailed Description

Represents a success response message from the server.

A Success message acknowledges the successful processing of an incoming message (such as an irsol::protocol::Assignment, irsol::protocol::Command, or irsol::protocol::Inquiry). It contains the originating identifier, the kind of message that triggered the response, and optionally a result value (e.g., for assignments and inquiries).

Can be stored in a irsol::protocol::OutMessage variant.

Definition at line 38 of file success.hpp.

Constructor & Destructor Documentation

Success()

irsol::protocol::Success::Success ( const std::string &  identifier, InMessageKind  source, std::optional< irsol::types::protocol_value_t >  body = std::nullopt  )

private

Definition at line 10 of file success.cpp.

  : identifier(utils::validateIdentifier(identifier)), source(source), body(body)
{}

Member Function Documentation

asStatus()

static Success irsol::protocol::Success::asStatus ( const std::string &  identifier, irsol::types::protocol_value_t  value  )

inlinestatic

Creates a standalone status message with a value.

Useful in cases where the server responds without having access to the original incoming message (e.g., asynchronous events).

Parameters

identifier	The identifier associated with the result.
value	The value to return.

Returns

A success response with the given identifier and value.

Definition at line 116 of file success.hpp.

  {
    return Success(identifier, InMessageKind::INQUIRY, std::make_optional(value));
  }

from() [1/3]

static Success irsol::protocol::Success::from ( const Assignment &  msg, std::optional< irsol::types::protocol_value_t >  overrideValue = std::nullopt  )

inlinestatic

Creates a success message from an Assignment.

Parameters

msg	The original assignment message.
overrideValue	Optional value to return instead of the original. This is sometimes set by the server, when the original value of the Assignment message was not suitable for storage (e.g. due to precision limitations or min/max constraints).

Returns

A success response based on the assignment.

Definition at line 75 of file success.hpp.

  {
    return Success(
      msg.identifier,
      InMessageKind::ASSIGNMENT,
      overrideValue.has_value() ? overrideValue : std::make_optional(msg.value));
  }

from() [2/3]

static Success irsol::protocol::Success::from ( const Command &  msg )

inlinestatic

Creates a success message from a Command.

Parameters

msg	The original command message.

Returns

A success response based on the command.

Definition at line 90 of file success.hpp.

  {
    return Success(msg.identifier, InMessageKind::COMMAND);
  }

from() [3/3]

static Success irsol::protocol::Success::from ( const Inquiry &  msg, irsol::types::protocol_value_t  result  )

inlinestatic

Creates a success message from an Inquiry.

Parameters

msg	The original inquiry message.
result	The result of the inquiry.

Returns

A success response with the requested value.

Definition at line 101 of file success.hpp.

  {
    return Success(msg.identifier, InMessageKind::INQUIRY, std::make_optional(result));
  }

hasBody()

bool irsol::protocol::Success::hasBody

(

)

const

Returns

true if the success message contains a result body.

Definition at line 38 of file success.cpp.

{
  return body.has_value();
}

hasDouble()

bool irsol::protocol::Success::hasDouble

(

)

const

Returns

true if the result body is of type double.

Definition at line 48 of file success.cpp.

{
  return hasBody() && std::holds_alternative<double>(*body);
}

hasInt()

bool irsol::protocol::Success::hasInt

(

)

const

Returns

true if the result body is of type int.

Definition at line 43 of file success.cpp.

{
  return hasBody() && std::holds_alternative<int>(*body);
}

hasString()

bool irsol::protocol::Success::hasString

(

)

const

Returns

true if the result body is of type string.

Definition at line 53 of file success.cpp.

{
  return hasBody() && std::holds_alternative<std::string>(*body);
}

toString()

std::string irsol::protocol::Success::toString

(

)

const

Converts the success message to a human-readable string.

Returns

A string representation of the success.

Definition at line 18 of file success.cpp.

{
  std::ostringstream oss;
  oss << "Success{"
      << "identifier: '" << identifier << "', source: " << InMessageKindToString(source);
  if(hasBody()) {
    oss << ", body: ";
    if(hasInt()) {
      oss << "<int> " << std::get<int>(*body);
    } else if(hasDouble()) {
      oss << "<double> " << std::get<double>(*body);
    } else if(hasString()) {
      oss << "<string> \"" << std::get<std::string>(*body) << "\"";
    }
  }
  oss << "}";
  return oss.str();
}

Member Data Documentation

body

std::optional<irsol::types::protocol_value_t> irsol::protocol::Success::body {}

Optional result or data associated with the response.

Definition at line 47 of file success.hpp.

{};

identifier

std::string irsol::protocol::Success::identifier

The identifier associated with the success response.

Definition at line 41 of file success.hpp.

source

InMessageKind irsol::protocol::Success::source

The kind of the incoming message that triggered this response.

Definition at line 44 of file success.hpp.

---

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

• src/irsol/include/irsol/protocol/message/success.hpp
• src/irsol/lib/irsol/protocol/message/success.cpp