kcenon::pacs::network::pipeline::response_encode_job Class Reference

Job for encoding DIMSE responses into PDU bytes. More...

#include <response_encode_job.h>

Inheritance diagram for kcenon::pacs::network::pipeline::response_encode_job:

Collaboration diagram for kcenon::pacs::network::pipeline::response_encode_job:

Public Types
using	encode_callback = std::function<void(const encoded_response& response)>
	Callback type for encoded response.
using	error_callback
	Callback type for encoding errors.

Public Member Functions
	response_encode_job (service_result result, uint32_t max_pdu_size=16384, encode_callback on_encoded=nullptr, error_callback on_error=nullptr)
	Construct an encode job.
	~response_encode_job () override=default
	response_encode_job (const response_encode_job &)=delete
response_encode_job &	operator= (const response_encode_job &)=delete
	response_encode_job (response_encode_job &&)=default
response_encode_job &	operator= (response_encode_job &&)=default
auto	execute (pipeline_coordinator &coordinator) -> VoidResult override
	Execute the encode job.
auto	get_context () const noexcept -> const job_context &override
	Get the job context.
auto	get_context () noexcept -> job_context &override
	Get the job context (mutable)
auto	get_name () const -> std::string override
	Get the job name.
auto	get_result () const noexcept -> const service_result &
	Get the service result.
Public Member Functions inherited from kcenon::pacs::network::pipeline::pipeline_job_base
virtual	~pipeline_job_base ()=default
	Virtual destructor.

Private Member Functions
auto	encode_response () -> Result< std::vector< encoded_response > >
	Encode the response into PDU bytes.
auto	encode_dimse_command () -> Result< std::vector< uint8_t > >
	Encode DIMSE command.
auto	fragment_data (const std::vector< uint8_t > &data) -> std::vector< std::vector< uint8_t > >
	Fragment large data if needed.

Private Attributes
job_context	context_
service_result	result_
uint32_t	max_pdu_size_
encode_callback	on_encoded_
error_callback	on_error_

Additional Inherited Members
Protected Member Functions inherited from kcenon::pacs::network::pipeline::pipeline_job_base
	pipeline_job_base ()=default
	pipeline_job_base (const pipeline_job_base &)=delete
pipeline_job_base &	operator= (const pipeline_job_base &)=delete
	pipeline_job_base (pipeline_job_base &&)=default
pipeline_job_base &	operator= (pipeline_job_base &&)=default

Detailed Description

Job for encoding DIMSE responses into PDU bytes.

Stage 5 of the pipeline. Encodes service results into PDU format and submits to the network send stage.

Definition at line 62 of file response_encode_job.h.

Member Typedef Documentation

encode_callback

using kcenon::pacs::network::pipeline::response_encode_job::encode_callback = std::function<void(const encoded_response& response)>

Callback type for encoded response.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 65 of file response_encode_job.h.

error_callback

using kcenon::pacs::network::pipeline::response_encode_job::error_callback

Initial value:

 std::function<void(uint64_t session_id,
                                              const std::string& error)>

Callback type for encoding errors.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 68 of file response_encode_job.h.

Constructor & Destructor Documentation

response_encode_job() [1/3]

kcenon::pacs::network::pipeline::response_encode_job::response_encode_job	(	service_result	result,
		uint32_t	max_pdu_size = 16384,
		encode_callback	on_encoded = nullptr,
		error_callback	on_error = nullptr )

Construct an encode job.

Parameters

result	The service result to encode
max_pdu_size	Maximum PDU size for fragmentation
on_encoded	Callback for encoded response
on_error	Callback for errors

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 20 of file response_encode_job.cpp.

    : result_(std::move(result))
    , max_pdu_size_(max_pdu_size)
    , on_encoded_(std::move(on_encoded))
    , on_error_(std::move(on_error)) {
 
    context_.session_id = result_.session_id;
    context_.message_id = result_.message_id;
    context_.stage = pipeline_stage::response_encode;
    context_.enqueue_time_ns = static_cast<uint64_t>(
        std::chrono::duration_cast<std::chrono::nanoseconds>(
            std::chrono::steady_clock::now().time_since_epoch()
        ).count()
    );
}

References context_, kcenon::pacs::network::pipeline::job_context::enqueue_time_ns, kcenon::pacs::network::pipeline::job_context::message_id, kcenon::pacs::network::pipeline::service_result::message_id, kcenon::pacs::network::pipeline::response_encode, result_, kcenon::pacs::network::pipeline::job_context::session_id, kcenon::pacs::network::pipeline::service_result::session_id, and kcenon::pacs::network::pipeline::job_context::stage.

~response_encode_job()

kcenon::pacs::network::pipeline::response_encode_job::~response_encode_job ( )

overridedefault

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

response_encode_job() [2/3]

kcenon::pacs::network::pipeline::response_encode_job::response_encode_job ( const response_encode_job & )

delete

response_encode_job() [3/3]

kcenon::pacs::network::pipeline::response_encode_job::response_encode_job ( response_encode_job && )

default

Member Function Documentation

encode_dimse_command()

auto kcenon::pacs::network::pipeline::response_encode_job::encode_dimse_command ( ) -> Result<std::vector<uint8_t>>

nodiscardprivate

Encode DIMSE command.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 216 of file response_encode_job.cpp.

                                  {
 
    std::vector<uint8_t> command;
    command.reserve(256);  // Typical command size
 
    // Helper to append element (Implicit VR Little Endian)
    auto append_element = [&command](uint16_t group, uint16_t element,
                                     const void* data, uint32_t length) {
        // Tag
        command.push_back(static_cast<uint8_t>(group & 0xFF));
        command.push_back(static_cast<uint8_t>((group >> 8) & 0xFF));
        command.push_back(static_cast<uint8_t>(element & 0xFF));
        command.push_back(static_cast<uint8_t>((element >> 8) & 0xFF));
        // Length
        command.push_back(static_cast<uint8_t>(length & 0xFF));
        command.push_back(static_cast<uint8_t>((length >> 8) & 0xFF));
        command.push_back(static_cast<uint8_t>((length >> 16) & 0xFF));
        command.push_back(static_cast<uint8_t>((length >> 24) & 0xFF));
        // Data
        const auto* bytes = static_cast<const uint8_t*>(data);
        command.insert(command.end(), bytes, bytes + length);
    };
 
    auto append_uint16 = [&append_element](uint16_t group, uint16_t element,
                                           uint16_t value) {
        append_element(group, element, &value, 2);
    };
 
    auto append_string = [&append_element](uint16_t group, uint16_t element,
                                           const std::string& value) {
        std::string padded = value;
        if (padded.size() % 2 != 0) {
            padded.push_back(' ');  // Pad to even length
        }
        append_element(group, element, padded.data(),
                       static_cast<uint32_t>(padded.size()));
    };
 
    // Placeholder for CommandGroupLength (will be filled after encoding)
    size_t group_length_offset = command.size();
    uint32_t placeholder = 0;
    append_element(0x0000, 0x0000, &placeholder, 4);
 
    // AffectedSOPClassUID (0000,0002) or RequestedSOPClassUID (0000,0003)
    if (!result_.sop_class_uid.empty()) {
        append_string(0x0000, 0x0002, result_.sop_class_uid);
    }
 
    // CommandField (0000,0100)
    append_uint16(0x0000, 0x0100, static_cast<uint16_t>(result_.response_type));
 
    // MessageIDBeingRespondedTo (0000,0120)
    append_uint16(0x0000, 0x0120, result_.message_id);
 
    // CommandDataSetType (0000,0800)
    // 0x0101 = no data set, 0x0001 = data set present
    uint16_t data_set_type = result_.data_set.empty() ? 0x0101 : 0x0001;
    append_uint16(0x0000, 0x0800, data_set_type);
 
    // Status (0000,0900)
    append_uint16(0x0000, 0x0900, static_cast<uint16_t>(result_.status));
 
    // AffectedSOPInstanceUID (0000,1000) if present
    if (!result_.sop_instance_uid.empty()) {
        append_string(0x0000, 0x1000, result_.sop_instance_uid);
    }
 
    // For C-GET/C-MOVE responses, include sub-operation counts
    if (result_.response_type == dimse_command_type::c_get_rsp ||
        result_.response_type == dimse_command_type::c_move_rsp) {
        if (result_.status == dimse_status::pending ||
            result_.status == dimse_status::pending_warning) {
            append_uint16(0x0000, 0x1020, result_.remaining_sub_ops);
            append_uint16(0x0000, 0x1021, result_.completed_sub_ops);
            append_uint16(0x0000, 0x1022, result_.failed_sub_ops);
            append_uint16(0x0000, 0x1023, result_.warning_sub_ops);
        }
    }
 
    // Error comment if present
    if (!result_.error_comment.empty()) {
        append_string(0x0000, 0x0902, result_.error_comment);
    }
 
    // Update CommandGroupLength
    uint32_t group_length = static_cast<uint32_t>(command.size() - group_length_offset - 8);
    command[group_length_offset + 4] = static_cast<uint8_t>(group_length & 0xFF);
    command[group_length_offset + 5] = static_cast<uint8_t>((group_length >> 8) & 0xFF);
    command[group_length_offset + 6] = static_cast<uint8_t>((group_length >> 16) & 0xFF);
    command[group_length_offset + 7] = static_cast<uint8_t>((group_length >> 24) & 0xFF);
 
    return ok(std::move(command));
}

References kcenon::pacs::network::pipeline::c_get_rsp, kcenon::pacs::network::pipeline::c_move_rsp, kcenon::pacs::network::pipeline::pending, and kcenon::pacs::network::pipeline::pending_warning.

encode_response()

auto kcenon::pacs::network::pipeline::response_encode_job::encode_response ( ) -> Result<std::vector<encoded_response>>

nodiscardprivate

Encode the response into PDU bytes.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 102 of file response_encode_job.cpp.

                                           {
 
    std::vector<encoded_response> responses;
 
    // Encode DIMSE command
    auto command_result = encode_dimse_command();
    if (!command_result.is_ok()) {
        return Result<std::vector<encoded_response>>(command_result.error());
    }
 
    auto command_data = command_result.value();
 
    // Fragment the command data if needed
    auto command_fragments = fragment_data(command_data);
 
    // Create P-DATA-TF PDUs for command
    for (size_t i = 0; i < command_fragments.size(); ++i) {
        encoded_response response;
        response.session_id = result_.session_id;
        response.message_id = result_.message_id;
        response.is_final = (i == command_fragments.size() - 1) && result_.data_set.empty();
 
        // Build P-DATA-TF PDU
        // PDU: Type (1) + Reserved (1) + Length (4) + PDV Items
        // PDV: Length (4) + Presentation Context ID (1) + Control Header (1) + Data
 
        const auto& frag = command_fragments[i];
        size_t pdv_length = 2 + frag.size();  // Context ID + Control + Data
        size_t pdu_length = 4 + pdv_length;    // PDV Length + PDV
 
        response.pdu_data.resize(6 + pdu_length);
 
        // PDU header
        response.pdu_data[0] = 0x04;  // P-DATA-TF
        response.pdu_data[1] = 0x00;  // Reserved
 
        // PDU length (big-endian)
        response.pdu_data[2] = static_cast<uint8_t>((pdu_length >> 24) & 0xFF);
        response.pdu_data[3] = static_cast<uint8_t>((pdu_length >> 16) & 0xFF);
        response.pdu_data[4] = static_cast<uint8_t>((pdu_length >> 8) & 0xFF);
        response.pdu_data[5] = static_cast<uint8_t>(pdu_length & 0xFF);
 
        // PDV length (big-endian)
        size_t offset = 6;
        response.pdu_data[offset++] = static_cast<uint8_t>((pdv_length >> 24) & 0xFF);
        response.pdu_data[offset++] = static_cast<uint8_t>((pdv_length >> 16) & 0xFF);
        response.pdu_data[offset++] = static_cast<uint8_t>((pdv_length >> 8) & 0xFF);
        response.pdu_data[offset++] = static_cast<uint8_t>(pdv_length & 0xFF);
 
        // Presentation context ID
        response.pdu_data[offset++] = result_.presentation_context_id;
 
        // Control header: command (bit 0) + last fragment (bit 1)
        uint8_t control = 0x01;  // Command fragment
        if (i == command_fragments.size() - 1) {
            control |= 0x02;  // Last command fragment
        }
        response.pdu_data[offset++] = control;
 
        // Copy fragment data
        std::copy(frag.begin(), frag.end(), response.pdu_data.begin() + offset);
 
        responses.push_back(std::move(response));
    }
 
    // Encode data set if present
    if (!result_.data_set.empty()) {
        auto data_fragments = fragment_data(result_.data_set);
 
        for (size_t i = 0; i < data_fragments.size(); ++i) {
            encoded_response response;
            response.session_id = result_.session_id;
            response.message_id = result_.message_id;
            response.is_final = (i == data_fragments.size() - 1);
 
            const auto& frag = data_fragments[i];
            size_t pdv_length = 2 + frag.size();
            size_t pdu_length = 4 + pdv_length;
 
            response.pdu_data.resize(6 + pdu_length);
 
            // PDU header
            response.pdu_data[0] = 0x04;
            response.pdu_data[1] = 0x00;
 
            response.pdu_data[2] = static_cast<uint8_t>((pdu_length >> 24) & 0xFF);
            response.pdu_data[3] = static_cast<uint8_t>((pdu_length >> 16) & 0xFF);
            response.pdu_data[4] = static_cast<uint8_t>((pdu_length >> 8) & 0xFF);
            response.pdu_data[5] = static_cast<uint8_t>(pdu_length & 0xFF);
 
            size_t offset = 6;
            response.pdu_data[offset++] = static_cast<uint8_t>((pdv_length >> 24) & 0xFF);
            response.pdu_data[offset++] = static_cast<uint8_t>((pdv_length >> 16) & 0xFF);
            response.pdu_data[offset++] = static_cast<uint8_t>((pdv_length >> 8) & 0xFF);
            response.pdu_data[offset++] = static_cast<uint8_t>(pdv_length & 0xFF);
 
            response.pdu_data[offset++] = result_.presentation_context_id;
 
            uint8_t control = 0x00;  // Data fragment
            if (i == data_fragments.size() - 1) {
                control |= 0x02;  // Last data fragment
            }
            response.pdu_data[offset++] = control;
 
            std::copy(frag.begin(), frag.end(), response.pdu_data.begin() + offset);
 
            responses.push_back(std::move(response));
        }
    }
 
    return ok(std::move(responses));
}

References kcenon::pacs::network::pipeline::control, kcenon::pacs::network::pipeline::encoded_response::is_final, kcenon::pacs::network::pipeline::encoded_response::message_id, kcenon::pacs::network::pipeline::encoded_response::pdu_data, and kcenon::pacs::network::pipeline::encoded_response::session_id.

execute()

auto kcenon::pacs::network::pipeline::response_encode_job::execute ( pipeline_coordinator & coordinator ) -> VoidResult

nodiscardoverridevirtual

Execute the encode job.

Encodes the result and submits to the network send stage.

Parameters

coordinator

Pipeline coordinator for stage submission

Returns

VoidResult indicating success or error

Implements kcenon::pacs::network::pipeline::pipeline_job_base.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 39 of file response_encode_job.cpp.

                                                                                 {
    // Encode the response
    auto encode_result = encode_response();
    if (!encode_result.is_ok()) {
        if (on_error_) {
            auto err = encode_result.error();
            on_error_(result_.session_id, err.message);
        }
        return VoidResult(encode_result.error());
    }
 
    auto responses = encode_result.value();
 
    // Submit each encoded response to the send stage
    for (auto& response : responses) {
        // Invoke callback if set
        if (on_encoded_) {
            on_encoded_(response);
        }
 
        // Create send job
        // Note: send_fn will be set by the adapter layer
        auto send_job = std::make_unique<send_network_io_job>(
            response.session_id,
            std::move(response.pdu_data),
            nullptr  // send_fn set by adapter
        );
 
        send_job->get_context() = context_;
        send_job->get_context().stage = pipeline_stage::network_send;
 
        auto submit_result = coordinator.submit_to_stage(
            pipeline_stage::network_send,
            std::move(send_job)
        );
 
        if (!submit_result.is_ok()) {
            return submit_result;
        }
    }
 
    return ok();
}

References kcenon::pacs::network::pipeline::network_send.

fragment_data()

auto kcenon::pacs::network::pipeline::response_encode_job::fragment_data ( const std::vector< uint8_t > & data ) -> std::vector<std::vector<uint8_t>>

nodiscardprivate

Fragment large data if needed.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 311 of file response_encode_job.cpp.

                                     {
 
    std::vector<std::vector<uint8_t>> fragments;
 
    // Max fragment size = max_pdu_size - PDU header (6) - PDV header (6)
    size_t max_fragment_size = max_pdu_size_ - 12;
    if (max_fragment_size > 16376) {
        max_fragment_size = 16376;  // Reasonable default
    }
 
    size_t offset = 0;
    while (offset < data.size()) {
        size_t fragment_size = std::min(max_fragment_size, data.size() - offset);
        fragments.emplace_back(data.begin() + offset,
                               data.begin() + offset + fragment_size);
        offset += fragment_size;
    }
 
    if (fragments.empty()) {
        fragments.emplace_back();  // Empty fragment for empty data
    }
 
    return fragments;
}

get_context() [1/2]

auto kcenon::pacs::network::pipeline::response_encode_job::get_context ( ) const -> const job_context&

nodiscardoverridevirtualnoexcept

Get the job context.

Implements kcenon::pacs::network::pipeline::pipeline_job_base.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 83 of file response_encode_job.cpp.

                                                                           {
    return context_;
}

References context_.

get_context() [2/2]

auto kcenon::pacs::network::pipeline::response_encode_job::get_context ( ) -> job_context &override

nodiscardoverridevirtualnoexcept

Get the job context (mutable)

Returns

Reference to the job context

Implements kcenon::pacs::network::pipeline::pipeline_job_base.

Definition at line 87 of file response_encode_job.cpp.

                                                               {
    return context_;
}

References context_.

get_name()

auto kcenon::pacs::network::pipeline::response_encode_job::get_name ( ) const -> std::string

nodiscardoverridevirtual

Get the job name.

Implements kcenon::pacs::network::pipeline::pipeline_job_base.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 91 of file response_encode_job.cpp.

                                                      {
    return "response_encode_job[session=" +
           std::to_string(context_.session_id) +
           ", msgid=" + std::to_string(result_.message_id) +
           ", status=" + std::to_string(static_cast<uint16_t>(result_.status)) + "]";
}

References context_, kcenon::pacs::network::pipeline::service_result::message_id, result_, kcenon::pacs::network::pipeline::job_context::session_id, and kcenon::pacs::network::pipeline::service_result::status.

get_result()

auto kcenon::pacs::network::pipeline::response_encode_job::get_result ( ) const -> const service_result&

nodiscardnoexcept

Get the service result.

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 98 of file response_encode_job.cpp.

                                                                             {
    return result_;
}

References result_.

operator=() [1/2]

response_encode_job & kcenon::pacs::network::pipeline::response_encode_job::operator= ( const response_encode_job & )

delete

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

operator=() [2/2]

response_encode_job & kcenon::pacs::network::pipeline::response_encode_job::operator= ( response_encode_job && )

default

Member Data Documentation

context_

job_context kcenon::pacs::network::pipeline::response_encode_job::context_

private

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 119 of file response_encode_job.h.

Referenced by get_context(), get_context(), get_name(), and response_encode_job().

max_pdu_size_

uint32_t kcenon::pacs::network::pipeline::response_encode_job::max_pdu_size_

private

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 121 of file response_encode_job.h.

on_encoded_

encode_callback kcenon::pacs::network::pipeline::response_encode_job::on_encoded_

private

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 122 of file response_encode_job.h.

on_error_

error_callback kcenon::pacs::network::pipeline::response_encode_job::on_error_

private

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 123 of file response_encode_job.h.

result_

service_result kcenon::pacs::network::pipeline::response_encode_job::result_

private

Examples

/home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h.

Definition at line 120 of file response_encode_job.h.

Referenced by get_name(), get_result(), and response_encode_job().

---

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

• include/kcenon/pacs/network/pipeline/jobs/response_encode_job.h
• src/network/pipeline/jobs/response_encode_job.cpp