Slic3r::FileTransferJob Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/FileTransferUtils.hpp>

Collaboration diagram for Slic3r::FileTransferJob:

Public Types
using	ResultCb = std::function<void(int res, int resp_ec, std::string json_res, std::vector<std::byte> bin_res)>
using	MsgCb = std::function<void(int kind, std::string json)>

Public Member Functions
	FileTransferJob (FileTransferModule &m, const std::string &params_json)
	~FileTransferJob ()
	FileTransferJob (const FileTransferJob &)=delete
FileTransferJob &	operator= (const FileTransferJob &)=delete
	FileTransferJob (FileTransferJob &&)=delete
FileTransferJob &	operator= (FileTransferJob &&)=delete
void	on_result (ResultCb cb)
bool	get_result (int &ec, int &resp_ec, std::string &json, std::vector< std::byte > &bin, uint32_t timeout_ms)
void	start_on (FileTransferTunnel &t)
void	on_msg (MsgCb cb)
bool	try_get_msg (int &kind, std::string &json)
bool	get_msg (uint32_t timeout_ms, int &kind, std::string &json)
FT_JobHandle *	native () const noexcept
bool	check_valid () const
bool	finished () const
void	cancel ()

Private Member Functions
void	reset () noexcept
void	solve_result (ft_job_result result)

Private Attributes
FileTransferModule *	m_ {}
FT_JobHandle *	h_ {}
ResultCb	result_cb_ {}
MsgCb	msg_cb_ {}
bool	finished_ = false
int	res_ = 0
int	resp_ec_ = 0
std::string	res_json_
std::vector< std::byte >	res_bin_

Detailed Description

Member Typedef Documentation

MsgCb

using Slic3r::FileTransferJob::MsgCb = std::function<void(int kind, std::string json)>

ResultCb

using Slic3r::FileTransferJob::ResultCb = std::function<void(int res, int resp_ec, std::string json_res, std::vector<std::byte> bin_res)>

Constructor & Destructor Documentation

FileTransferJob() [1/3]

Slic3r::FileTransferJob::FileTransferJob ( FileTransferModule & m, const std::string & params_json )

explicit

                                                                                    : m_(&m)
{
    FT_JobHandle *h{};
    if (m_->ft_job_create(params_json.c_str(), &h) != 0 || !h) {
 
    }
    h_ = h;
 
    // C API: ft_job_result_cb(void* user, int tunnel_err, ft_job_result result)
    auto tramp = [](void *user, ft_job_result r) noexcept {
        auto *self = reinterpret_cast<FileTransferJob *>(user);
        if (!self) return;
 
        try {
            self->finished_ = true;
            self->solve_result(r);
 
            if (self->result_cb_) self->result_cb_(self->res_, self->resp_ec_, self->res_json_, self->res_bin_);
            self->m_->ft_job_result_destroy(&r);
        } catch (...) {
            // swallow
        }
 
        try {
            if (auto *mod = self ? self->m_ : nullptr) {
                if (mod->ft_job_result_destroy)
                    mod->ft_job_result_destroy(&r);
                else if (mod->ft_free) {
                    if (r.json) mod->ft_free((void *) r.json);
                    if (r.bin) mod->ft_free((void *) r.bin);
                }
            }
        } catch (...) {}
    };
 
    if (m_->ft_job_set_result_cb(h_, tramp, this) == ft_err::FT_EXCEPTION) { throw std::runtime_error("ft_job_set_result_cb failed"); }
}

References FileTransferJob(), Slic3r::ft_job_result::bin, h_, Slic3r::ft_job_result::json, and m_.

Referenced by FileTransferJob(), FileTransferJob(), FileTransferJob(), on_msg(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

~FileTransferJob()

Slic3r::FileTransferJob::~FileTransferJob ( )

inline

{ reset(); }

References reset().

Here is the call graph for this function:

FileTransferJob() [2/3]

Slic3r::FileTransferJob::FileTransferJob ( const FileTransferJob & )

delete

References FileTransferJob().

Here is the call graph for this function:

FileTransferJob() [3/3]

Slic3r::FileTransferJob::FileTransferJob ( FileTransferJob && )

delete

References FileTransferJob().

Here is the call graph for this function:

Member Function Documentation

cancel()

void Slic3r::FileTransferJob::cancel ( )

inline

    {
        if (m_->ft_job_cancel && h_) m_->ft_job_cancel(h_);
    }

References h_, and m_.

check_valid()

bool Slic3r::FileTransferJob::check_valid ( ) const

inline

{ return h_ != nullptr; }

References h_.

finished()

bool Slic3r::FileTransferJob::finished ( ) const

inline

{ return finished_; }

References finished_.

get_msg()

bool Slic3r::FileTransferJob::get_msg	(	uint32_t	timeout_ms,
		int &	kind,
		std::string &	json )

{
    if (!h_) return false;
    ft_job_msg m{};
    int        rc = m_->ft_job_get_msg(h_, timeout_ms, &m);
    if (rc != 0) return false;
 
    kind = m.kind;
    json.assign(m.json ? m.json : "");
 
    if (m_->ft_job_msg_destroy)
        m_->ft_job_msg_destroy(&m);
    else if (m_->ft_free && m.json)
        m_->ft_free((void *) m.json);
 
    return true;
}

References h_, Slic3r::ft_job_msg::json, Slic3r::ft_job_msg::kind, and m_.

get_result()

bool Slic3r::FileTransferJob::get_result	(	int &	ec,
		int &	resp_ec,
		std::string &	json,
		std::vector< std::byte > &	bin,
		uint32_t	timeout_ms )

{
    if (!h_) throw std::runtime_error("job handle invalid");
    ft_job_result result;
    if (m_->ft_job_get_result(h_, timeout_ms, &result) == ft_err::FT_EXCEPTION) return false;
    solve_result(result);
    m_->ft_job_result_destroy(&result);
    ec = res_;
    resp_ec = res_;
    json    = res_json_;
    bin     = res_bin_;
    return true;
}

References Slic3r::FT_EXCEPTION, h_, m_, res_, res_bin_, res_json_, and solve_result().

Here is the call graph for this function:

native()

FT_JobHandle * Slic3r::FileTransferJob::native ( ) const

inlinenoexcept

{ return h_; }

References h_.

on_msg()

void Slic3r::FileTransferJob::on_msg

(

MsgCb

cb

)

{
    msg_cb_ = std::move(cb);
    if (!h_) return;
 
    // C API: ft_job_msg_cb(void* user, ft_job_msg msg)
    auto tramp = [](void *user, ft_job_msg m) noexcept {
        auto *self = reinterpret_cast<FileTransferJob *>(user);
        if (!self) return;
        try {
            if (self->msg_cb_) { self->msg_cb_(m.kind, std::string(m.json ? m.json : "")); }
        } catch (...) {}
 
        try {
            if (auto *mod = self->m_) {
                if (mod->ft_job_msg_destroy)
                    mod->ft_job_msg_destroy(&m);
                else if (mod->ft_free && m.json)
                    mod->ft_free((void *) m.json);
            }
        } catch (...) {}
    };
 
    if (m_->ft_job_set_msg_cb(h_, tramp, this) == ft_err::FT_EXCEPTION) { throw std::runtime_error("ft_job_set_msg_cb failed"); }
}

References FileTransferJob(), Slic3r::FT_EXCEPTION, h_, m_, and msg_cb_.

Here is the call graph for this function:

on_result()

void Slic3r::FileTransferJob::on_result

(

ResultCb

cb

)

{ result_cb_ = std::move(cb); }

References result_cb_.

operator=() [1/2]

FileTransferJob & Slic3r::FileTransferJob::operator= ( const FileTransferJob & )

delete

References FileTransferJob().

Here is the call graph for this function:

operator=() [2/2]

FileTransferJob & Slic3r::FileTransferJob::operator= ( FileTransferJob && )

delete

References FileTransferJob().

Here is the call graph for this function:

reset()

void Slic3r::FileTransferJob::reset ( )

inlineprivatenoexcept

    {
        if (h_) {
            m_->ft_job_release(h_);
            h_ = nullptr;
        }
    }

References h_, and m_.

Referenced by ~FileTransferJob().

Here is the caller graph for this function:

solve_result()

void Slic3r::FileTransferJob::solve_result ( ft_job_result result )

private

{
    res_     = result.ec;
    resp_ec_ = result.resp_ec;
 
    res_bin_.clear();
    if (result.bin && result.bin_size) res_bin_.assign(reinterpret_cast<const std::byte *>(result.bin),
        reinterpret_cast<const std::byte *>(result.bin) + result.bin_size);
    res_json_.assign(result.json ? result.json : "");
}

References Slic3r::ft_job_result::bin, Slic3r::ft_job_result::bin_size, Slic3r::ft_job_result::ec, Slic3r::ft_job_result::json, res_, res_bin_, res_json_, Slic3r::ft_job_result::resp_ec, and resp_ec_.

Referenced by get_result().

Here is the caller graph for this function:

start_on()

void Slic3r::FileTransferJob::start_on

(

FileTransferTunnel &

t

)

{
    if (!h_) throw std::runtime_error("job handle invalid");
    if (m_->ft_tunnel_start_job(t.native(), h_) == ft_err::FT_EXCEPTION) { throw std::runtime_error("ft_tunnel_start_job failed"); }
}

References Slic3r::FT_EXCEPTION, h_, m_, and Slic3r::FileTransferTunnel::native().

Here is the call graph for this function:

try_get_msg()

bool Slic3r::FileTransferJob::try_get_msg	(	int &	kind,
		std::string &	json )

{
    if (!h_) return false;
    ft_job_msg m{};
    int        rc = m_->ft_job_try_get_msg(h_, &m);
    if (rc != 0) return false;
 
    kind = m.kind;
    json.assign(m.json ? m.json : "");
 
    if (m_->ft_job_msg_destroy)
        m_->ft_job_msg_destroy(&m);
    else if (m_->ft_free && m.json)
        m_->ft_free((void *) m.json);
 
    return true;
}

References h_, Slic3r::ft_job_msg::json, Slic3r::ft_job_msg::kind, and m_.

Member Data Documentation

finished_

bool Slic3r::FileTransferJob::finished_ = false

private

Referenced by finished().

h_

FT_JobHandle* Slic3r::FileTransferJob::h_ {}

private

{};

Referenced by FileTransferJob(), cancel(), check_valid(), get_msg(), get_result(), native(), on_msg(), reset(), start_on(), and try_get_msg().

m_

FileTransferModule* Slic3r::FileTransferJob::m_ {}

private

{};

Referenced by FileTransferJob(), cancel(), get_msg(), get_result(), on_msg(), reset(), start_on(), and try_get_msg().

msg_cb_

MsgCb Slic3r::FileTransferJob::msg_cb_ {}

private

{};

Referenced by on_msg().

res_

int Slic3r::FileTransferJob::res_ = 0

private

Referenced by get_result(), and solve_result().

res_bin_

std::vector<std::byte> Slic3r::FileTransferJob::res_bin_

private

Referenced by get_result(), and solve_result().

res_json_

std::string Slic3r::FileTransferJob::res_json_

private

Referenced by get_result(), and solve_result().

resp_ec_

int Slic3r::FileTransferJob::resp_ec_ = 0

private

Referenced by solve_result().

result_cb_

ResultCb Slic3r::FileTransferJob::result_cb_ {}

private

{};

Referenced by on_result().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/FileTransferUtils.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/Utils/FileTransferUtils.cpp