ORE Studio 0.0.4
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
bootstrap_status_response Struct Referencefinal

Response containing the bootstrap mode status. More...

#include <bootstrap_protocol.hpp>

Collaboration diagram for bootstrap_status_response:
Collaboration graph

Public Member Functions

std::vector< std::byte > serialize () const
 Serialize response to bytes.
 

Static Public Member Functions

static std::expected< bootstrap_status_response, ores::utility::serialization::error_code > deserialize (std::span< const std::byte > data)
 Deserialize response from bytes.
 

Public Attributes

bool is_in_bootstrap_mode
 
std::string message
 
std::vector< bootstrap_bundle_infoavailable_bundles
 Available dataset bundles for provisioning.
 

Detailed Description

Response containing the bootstrap mode status.

Member Function Documentation

◆ serialize()

std::vector< std::byte > serialize ( ) const

Serialize response to bytes.

Format:

  • 1 byte: is_in_bootstrap_mode (boolean)
  • 2 bytes: message length
  • N bytes: message (UTF-8)
  • 4 bytes: bundle count
  • For each bundle:
    • 2 bytes: code length + N bytes code
    • 2 bytes: name length + N bytes name
    • 2 bytes: description length + N bytes description

Member Data Documentation

◆ available_bundles

std::vector<bootstrap_bundle_info> available_bundles

Available dataset bundles for provisioning.

Only populated when is_in_bootstrap_mode is true.