Builder for multipart MIME responses. More...

#include <dicomweb_endpoints.h>

Collaboration diagram for kcenon::pacs::web::dicomweb::multipart_builder:

Classes
struct	part

Public Member Functions
	multipart_builder (std::string_view content_type=media_type::dicom)
	Construct a multipart builder.

void	add_part (std::vector< uint8_t > data, std::optional< std::string_view > content_type=std::nullopt)
	Add a part to the multipart response.

void	add_part_with_location (std::vector< uint8_t > data, std::string_view location, std::optional< std::string_view > content_type=std::nullopt)
	Add a part with location header.

auto	build () const -> std::string
	Build the complete multipart response body.

auto	content_type_header () const -> std::string
	Get the Content-Type header value for this multipart response.

auto	boundary () const -> std::string_view
	Get the boundary string.

auto	empty () const noexcept -> bool
	Check if any parts have been added.

auto	size () const noexcept -> size_t
	Get the number of parts.

Static Private Member Functions
static auto	generate_boundary () -> std::string
	Generate a unique boundary string.

Private Attributes
std::string	boundary_

std::string	default_content_type_

std::vector< part >	parts_

Detailed Description

Builder for multipart MIME responses.

Generates multipart/related responses as required by WADO-RS for returning multiple DICOM objects.

Definition at line 98 of file dicomweb_endpoints.h.

Constructor & Destructor Documentation

◆ multipart_builder()

kcenon::pacs::web::dicomweb::multipart_builder::multipart_builder ( std::string_view content_type = media_type::dicom )

explicit

Construct a multipart builder.

Parameters

content_type The content type for parts (default: application/dicom)

Definition at line 206 of file dicomweb_endpoints.cpp.

207 : boundary_(generate_boundary()),

208 default_content_type_(content_type) {}

kcenon::pacs::web::dicomweb::multipart_builder::boundary_

std::string boundary_

Definition dicomweb_endpoints.h:163

kcenon::pacs::web::dicomweb::multipart_builder::generate_boundary

static auto generate_boundary() -> std::string

Generate a unique boundary string.

Definition dicomweb_endpoints.cpp:275

kcenon::pacs::web::dicomweb::multipart_builder::default_content_type_

std::string default_content_type_

Definition dicomweb_endpoints.h:164

Member Function Documentation

◆ add_part()

void kcenon::pacs::web::dicomweb::multipart_builder::add_part	(	std::vector< uint8_t >	data,
		std::optional< std::string_view >	content_type = std::nullopt )

Add a part to the multipart response.

Parameters

data	The binary data for this part
content_type	Optional override content type for this part

Definition at line 210 of file dicomweb_endpoints.cpp.

                                              {
    part p;
    p.data = std::move(data);
    p.content_type = content_type.has_value()
                         ? std::string(*content_type)
                         : default_content_type_;
    parts_.push_back(std::move(p));
}

References kcenon::pacs::web::dicomweb::multipart_builder::part::content_type, kcenon::pacs::web::dicomweb::multipart_builder::part::data, default_content_type_, and parts_.

◆ add_part_with_location()

void kcenon::pacs::web::dicomweb::multipart_builder::add_part_with_location	(	std::vector< uint8_t >	data,
		std::string_view	location,
		std::optional< std::string_view >	content_type = std::nullopt )

Add a part with location header.

Parameters

data	The binary data for this part
location	The Content-Location header value
content_type	Optional override content type for this part

Definition at line 221 of file dicomweb_endpoints.cpp.

                                              {
    part p;
    p.data = std::move(data);
    p.content_type = content_type.has_value()
                         ? std::string(*content_type)
                         : default_content_type_;
    p.location = std::string(location);
    parts_.push_back(std::move(p));
}

References kcenon::pacs::web::dicomweb::multipart_builder::part::content_type, kcenon::pacs::web::dicomweb::multipart_builder::part::data, default_content_type_, kcenon::pacs::web::dicomweb::multipart_builder::part::location, and parts_.

Referenced by kcenon::pacs::web::endpoints::register_dicomweb_endpoints_impl().

Here is the caller graph for this function:

◆ boundary()

auto kcenon::pacs::web::dicomweb::multipart_builder::boundary ( ) const -> std::string_view

nodiscard

Get the boundary string.

Returns: The boundary string

Definition at line 263 of file dicomweb_endpoints.cpp.

                                                         {
    return boundary_;
}

References boundary_.

◆ build()

auto kcenon::pacs::web::dicomweb::multipart_builder::build ( ) const -> std::string

nodiscard

Build the complete multipart response body.

Returns: The multipart response body as string

Definition at line 234 of file dicomweb_endpoints.cpp.

                                                 {
    std::ostringstream oss;
 
    for (const auto& p : parts_) {
        oss << "--" << boundary_ << "\r\n";
        oss << "Content-Type: " << p.content_type << "\r\n";
        if (!p.location.empty()) {
            oss << "Content-Location: " << p.location << "\r\n";
        }
        oss << "\r\n";
        oss.write(reinterpret_cast<const char*>(p.data.data()),
                  static_cast<std::streamsize>(p.data.size()));
        oss << "\r\n";
    }
 
    if (!parts_.empty()) {
        oss << "--" << boundary_ << "--\r\n";
    }
 
    return oss.str();
}

References boundary_, and parts_.

Referenced by kcenon::pacs::web::endpoints::register_dicomweb_endpoints_impl().

Here is the caller graph for this function:

◆ content_type_header()

auto kcenon::pacs::web::dicomweb::multipart_builder::content_type_header ( ) const -> std::string

nodiscard

Get the Content-Type header value for this multipart response.

Returns: Complete Content-Type header including boundary

Definition at line 256 of file dicomweb_endpoints.cpp.

                                                               {
    std::ostringstream oss;
    oss << "multipart/related; type=\"" << default_content_type_
        << "\"; boundary=" << boundary_;
    return oss.str();
}

References boundary_, and default_content_type_.

Referenced by kcenon::pacs::web::endpoints::register_dicomweb_endpoints_impl().

Here is the caller graph for this function:

◆ empty()

auto kcenon::pacs::web::dicomweb::multipart_builder::empty ( ) const -> bool

nodiscardnoexcept

Check if any parts have been added.

Returns: true if at least one part exists

Definition at line 267 of file dicomweb_endpoints.cpp.

                                                     {
    return parts_.empty();
}

References parts_.

Referenced by kcenon::pacs::web::endpoints::register_dicomweb_endpoints_impl().

Here is the caller graph for this function:

◆ generate_boundary()

auto kcenon::pacs::web::dicomweb::multipart_builder::generate_boundary ( ) -> std::string

staticnodiscardprivate

Generate a unique boundary string.

Returns: Boundary string

Definition at line 275 of file dicomweb_endpoints.cpp.

                                                       {
    // Generate a unique boundary using timestamp and random number
    auto now = std::chrono::system_clock::now();
    auto timestamp = std::chrono::duration_cast<std::chrono::microseconds>(
                         now.time_since_epoch())
                         .count();
 
    std::random_device rd;
    std::mt19937 gen(rd());
    std::uniform_int_distribution<> dis(0, 999999);
 
    std::ostringstream oss;
    oss << "----=_Part_" << timestamp << "_" << dis(gen);
    return oss.str();
}

◆ size()

auto kcenon::pacs::web::dicomweb::multipart_builder::size ( ) const -> size_t

nodiscardnoexcept

Get the number of parts.

Returns: Number of parts added

Definition at line 271 of file dicomweb_endpoints.cpp.

                                                      {
    return parts_.size();
}

References parts_.

Referenced by kcenon::pacs::web::endpoints::register_dicomweb_endpoints_impl().

Here is the caller graph for this function:

Member Data Documentation

◆ boundary_

std::string kcenon::pacs::web::dicomweb::multipart_builder::boundary_

private

Definition at line 163 of file dicomweb_endpoints.h.

Referenced by boundary(), build(), and content_type_header().

◆ default_content_type_

std::string kcenon::pacs::web::dicomweb::multipart_builder::default_content_type_

private

Definition at line 164 of file dicomweb_endpoints.h.

Referenced by add_part(), add_part_with_location(), and content_type_header().

◆ parts_

std::vector<part> kcenon::pacs::web::dicomweb::multipart_builder::parts_

private

Definition at line 165 of file dicomweb_endpoints.h.

Referenced by add_part(), add_part_with_location(), build(), empty(), and size().

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

include/kcenon/pacs/web/endpoints/dicomweb_endpoints.h
src/web/endpoints/dicomweb_endpoints.cpp

Classes

Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ multipart_builder()

Member Function Documentation

◆ add_part()

◆ add_part_with_location()

◆ boundary()

◆ build()

◆ content_type_header()

◆ empty()

◆ generate_boundary()

◆ size()

Member Data Documentation

◆ boundary_

◆ default_content_type_

◆ parts_