publish_bundle_response Struct Reference

Response containing results of bundle publication. More...

#include <publish_bundle_protocol.hpp>

Collaboration diagram for publish_bundle_response:

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

Static Public Member Functions
static std::expected< publish_bundle_response, ores::utility::serialization::error_code >	deserialize (std::span< const std::byte > data)
	Deserialize response from bytes.

Public Attributes
bool	success = false
	Overall success flag.
std::string	error_message
	Error message if overall publication failed.
std::uint32_t	datasets_processed = 0
	Number of datasets processed.
std::uint32_t	datasets_succeeded = 0
	Number of datasets successfully published.
std::uint32_t	datasets_failed = 0
	Number of datasets that failed.
std::uint32_t	datasets_skipped = 0
	Number of datasets skipped.
std::uint64_t	total_records_inserted = 0
	Total records inserted across all datasets.
std::uint64_t	total_records_updated = 0
	Total records updated across all datasets.
std::uint64_t	total_records_skipped = 0
	Total records skipped across all datasets.
std::uint64_t	total_records_deleted = 0
	Total records deleted across all datasets.
std::vector< bundle_dataset_result >	dataset_results
	Per-dataset publication results.

Detailed Description

Response containing results of bundle publication.

Member Function Documentation

serialize()

std::vector< std::byte > serialize

(

)

const

Serialize response to bytes.

Format:

• 1 byte: success
• 2 bytes: error_message length
• N bytes: error_message (UTF-8)
• 4 bytes: datasets_processed
• 4 bytes: datasets_succeeded
• 4 bytes: datasets_failed
• 4 bytes: datasets_skipped
• 8 bytes: total_records_inserted
• 8 bytes: total_records_updated
• 8 bytes: total_records_skipped
• 8 bytes: total_records_deleted
• 4 bytes: dataset_results count
• For each result: (bundle_dataset_result serialization)

Member Data Documentation

success

bool success = false

Overall success flag.

In atomic mode, this is true only if all datasets succeeded. In non-atomic mode, this is true if at least one dataset succeeded.