Slic3r::FileTransferTunnel Class Reference

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

Collaboration diagram for Slic3r::FileTransferTunnel:

Public Types
using	ConnectionCb = std::function<void(bool is_success, int err_code, std::string error_msg)>
using	TunnelStatusCb = std::function<void(int old_status, int new_status, int err_code, std::string error_msg)>

Public Member Functions
	FileTransferTunnel (FileTransferModule &m, const std::string &url)
	~FileTransferTunnel ()
	FileTransferTunnel (const FileTransferTunnel &)=delete
FileTransferTunnel &	operator= (const FileTransferTunnel &)=delete
	FileTransferTunnel (FileTransferTunnel &&)=delete
FileTransferTunnel &	operator= (FileTransferTunnel &&)=delete
void	start_connect ()
bool	sync_start_connect ()
void	on_connection (ConnectionCb cb)
void	on_status (TunnelStatusCb cb)
void	shutdown ()
int	get_status () const
bool	check_valid () const
FT_TunnelHandle *	native () const noexcept

Private Member Functions
void	reset () noexcept

Private Attributes
int	status_ {}
FileTransferModule *	m_ {}
FT_TunnelHandle *	h_ {}
ConnectionCb	conn_cb_ {}
TunnelStatusCb	status_cb_ {}

Detailed Description

Member Typedef Documentation

ConnectionCb

using Slic3r::FileTransferTunnel::ConnectionCb = std::function<void(bool is_success, int err_code, std::string error_msg)>

TunnelStatusCb

using Slic3r::FileTransferTunnel::TunnelStatusCb = std::function<void(int old_status, int new_status, int err_code, std::string error_msg)>

Constructor & Destructor Documentation

FileTransferTunnel() [1/3]

Slic3r::FileTransferTunnel::FileTransferTunnel ( FileTransferModule & m, const std::string & url )

explicit

                                                                                  : m_(&m)
{
    // Guard against missing symbols in older Bambu networking plugins.
    // These symbols were added in a newer plugin ABI; if the installed
    // plugin predates them, ft_tunnel_create/ft_tunnel_set_status_cb
    // will be null and calling them crashes.
    if (!m_->ft_tunnel_create || !m_->ft_tunnel_set_status_cb) {
        throw std::runtime_error("Bambu networking plugin is too old: missing ft_tunnel_* symbols. "
                                 "Please update the networking plugin.");
    }
    FT_TunnelHandle *h{};
    if (m_->ft_tunnel_create(url.c_str(), &h) != 0 || !h) {
        throw std::runtime_error("ft_tunnel_create failed");
    }
    h_ = h;
 
    // C API: ft_status_cb(void* user, int old_status, int new_status, int err, const char* msg)
    auto tramp = [](void *user, int old_status, int new_status, int err_code, const char *msg) noexcept {
        auto *self    = reinterpret_cast<FileTransferTunnel *>(user);
        self->status_ = new_status;
        if (!self->status_cb_) return;
        try {
            self->status_cb_(old_status, new_status, err_code, std::string(msg ? msg : ""));
        } catch (...) {}
    };
    if (m_->ft_tunnel_set_status_cb(h_, tramp, this) == ft_err::FT_EXCEPTION) { throw std::runtime_error("ft_tunnel_set_status_cb failed"); }
}

References h_, and m_.

Referenced by FileTransferTunnel(), FileTransferTunnel(), operator=(), and operator=().

Here is the caller graph for this function:

~FileTransferTunnel()

Slic3r::FileTransferTunnel::~FileTransferTunnel ( )

inline

{ reset(); }

References reset().

Here is the call graph for this function:

FileTransferTunnel() [2/3]

Slic3r::FileTransferTunnel::FileTransferTunnel ( const FileTransferTunnel & )

delete

References FileTransferTunnel().

Here is the call graph for this function:

FileTransferTunnel() [3/3]

Slic3r::FileTransferTunnel::FileTransferTunnel ( FileTransferTunnel && )

delete

References FileTransferTunnel().

Here is the call graph for this function:

Member Function Documentation

check_valid()

bool Slic3r::FileTransferTunnel::check_valid ( ) const

inline

{ return h_ != nullptr; }

References h_.

get_status()

int Slic3r::FileTransferTunnel::get_status ( ) const

inline

{ return status_; }

References status_.

native()

FT_TunnelHandle * Slic3r::FileTransferTunnel::native ( ) const

inlinenoexcept

{ return h_; }

References h_.

Referenced by Slic3r::FileTransferJob::start_on().

Here is the caller graph for this function:

on_connection()

void Slic3r::FileTransferTunnel::on_connection

(

ConnectionCb

cb

)

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

References conn_cb_, and on_connection().

Referenced by on_connection().

Here is the call graph for this function:

Here is the caller graph for this function:

on_status()

void Slic3r::FileTransferTunnel::on_status

(

TunnelStatusCb

cb

)

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

References on_status(), and status_cb_.

Referenced by on_status().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

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

delete

References FileTransferTunnel().

Here is the call graph for this function:

operator=() [2/2]

FileTransferTunnel & Slic3r::FileTransferTunnel::operator= ( FileTransferTunnel && )

delete

References FileTransferTunnel().

Here is the call graph for this function:

reset()

void Slic3r::FileTransferTunnel::reset ( )

inlineprivatenoexcept

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

References h_, and m_.

Referenced by ~FileTransferTunnel().

Here is the caller graph for this function:

shutdown()

void Slic3r::FileTransferTunnel::shutdown

(

)

{
    if (m_->ft_tunnel_shutdown) (void) m_->ft_tunnel_shutdown(h_);
}

References h_, m_, and shutdown().

Referenced by shutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

start_connect()

void Slic3r::FileTransferTunnel::start_connect

(

)

{
    // C API: ft_conn_cb(void* user, int ok, int err, const char* msg)
    auto tramp = [](void *user, int ok, int ec, const char *msg) noexcept {
        auto *pcb = reinterpret_cast<ConnectionCb *>(user);
        if (!pcb) return;
        try {
            (*pcb)(ok == 0, ec, std::string(msg ? msg : ""));
        } catch (...) {}
    };
    if (m_->ft_tunnel_start_connect(h_, tramp, &conn_cb_) == ft_err::FT_EXCEPTION) { throw std::runtime_error("ft_tunnel_start_connect failed"); }
}

References conn_cb_, Slic3r::FT_EXCEPTION, h_, m_, and start_connect().

Referenced by start_connect().

Here is the call graph for this function:

Here is the caller graph for this function:

sync_start_connect()

bool Slic3r::FileTransferTunnel::sync_start_connect

(

)

{
    return m_->ft_tunnel_sync_connect(h_) == FT_OK;
}

References Slic3r::FT_OK, h_, m_, and sync_start_connect().

Referenced by sync_start_connect().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

conn_cb_

ConnectionCb Slic3r::FileTransferTunnel::conn_cb_ {}

private

{};

Referenced by on_connection(), and start_connect().

h_

FT_TunnelHandle* Slic3r::FileTransferTunnel::h_ {}

private

{};

Referenced by FileTransferTunnel(), check_valid(), native(), reset(), shutdown(), start_connect(), and sync_start_connect().

m_

FileTransferModule* Slic3r::FileTransferTunnel::m_ {}

private

{};

Referenced by FileTransferTunnel(), reset(), shutdown(), start_connect(), and sync_start_connect().

status_

int Slic3r::FileTransferTunnel::status_ {}

private

{};

Referenced by get_status().

status_cb_

TunnelStatusCb Slic3r::FileTransferTunnel::status_cb_ {}

private

{};

Referenced by on_status().

---

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