Follow up to the MKS merge:

Reformatted for code conformity.
Changed the xxx_ member variables to m_xxx
Replaced std::list with std::deque
This commit is contained in:
Vojtech Bubnik 2021-11-29 18:12:35 +01:00
parent eddcd93e82
commit 56d5a340ce
4 changed files with 354 additions and 380 deletions

View File

@ -31,40 +31,39 @@ namespace pt = boost::property_tree;
namespace Slic3r {
MKS::MKS(DynamicPrintConfig* config) :
host(config->opt_string("print_host")), console_port("8080")
{}
MKS::MKS(DynamicPrintConfig* config) :
m_host(config->opt_string("print_host")), m_console_port("8080")
{}
const char* MKS::get_name() const { return "MKS"; }
const char* MKS::get_name() const { return "MKS"; }
bool MKS::test(wxString& msg) const
{
Utils::TCPConsole console(host, console_port);
bool MKS::test(wxString& msg) const
{
Utils::TCPConsole console(m_host, m_console_port);
console.enqueue_cmd("M105");
bool ret = console.run_queue();
if (!ret) {
if (!ret)
msg = wxString::FromUTF8(console.error_message().c_str());
}
return ret;
}
}
wxString MKS::get_test_ok_msg() const
{
wxString MKS::get_test_ok_msg() const
{
return _(L("Connection to MKS works correctly."));
}
}
wxString MKS::get_test_failed_msg(wxString& msg) const
{
wxString MKS::get_test_failed_msg(wxString& msg) const
{
return GUI::from_u8((boost::format("%s: %s")
% _utf8(L("Could not connect to MKS"))
% std::string(msg.ToUTF8())).str());
}
}
bool MKS::upload(PrintHostUpload upload_data, ProgressFn prorgess_fn, ErrorFn error_fn) const
{
bool MKS::upload(PrintHostUpload upload_data, ProgressFn prorgess_fn, ErrorFn error_fn) const
{
bool res = true;
auto upload_cmd = get_upload_url(upload_data.upload_path.string());
@ -110,43 +109,42 @@ namespace Slic3r {
return res;
}
}
std::string MKS::get_upload_url(const std::string& filename) const
{
std::string MKS::get_upload_url(const std::string& filename) const
{
return (boost::format("http://%1%/upload?X-Filename=%2%")
% host
% m_host
% Http::url_encode(filename)).str();
}
}
bool MKS::start_print(wxString& msg, const std::string& filename) const
{
bool MKS::start_print(wxString& msg, const std::string& filename) const
{
// For some reason printer firmware does not want to respond on gcode commands immediately after file upload.
// So we just introduce artificial delay to workaround it.
// TODO: Inspect reasons
std::this_thread::sleep_for(std::chrono::milliseconds(1500));
Utils::TCPConsole console(host, console_port);
Utils::TCPConsole console(m_host, m_console_port);
console.enqueue_cmd(std::string("M23 ") + filename);
console.enqueue_cmd("M24");
bool ret = console.run_queue();
if (!ret) {
if (!ret)
msg = wxString::FromUTF8(console.error_message().c_str());
}
return ret;
}
}
int MKS::get_err_code_from_body(const std::string& body) const
{
int MKS::get_err_code_from_body(const std::string& body) const
{
pt::ptree root;
std::istringstream iss(body); // wrap returned json to istringstream
pt::read_json(iss, root);
return root.get<int>("err", 0);
}
}
} // Slic3r

View File

@ -8,12 +8,12 @@
#include "TCPConsole.hpp"
namespace Slic3r {
class DynamicPrintConfig;
class Http;
class DynamicPrintConfig;
class Http;
class MKS : public PrintHost
{
public:
class MKS : public PrintHost
{
public:
explicit MKS(DynamicPrintConfig* config);
~MKS() override = default;
@ -26,16 +26,16 @@ namespace Slic3r {
bool has_auto_discovery() const override { return false; }
bool can_test() const override { return true; }
bool can_start_print() const override { return true; }
std::string get_host() const override { return host; }
std::string get_host() const override { return m_host; }
private:
std::string host;
std::string console_port;
private:
std::string m_host;
std::string m_console_port;
std::string get_upload_url(const std::string& filename) const;
bool start_print(wxString& msg, const std::string& filename) const;
int get_err_code_from_body(const std::string& body) const;
};
};
}

View File

@ -18,195 +18,173 @@ using boost::asio::steady_timer;
using boost::asio::ip::tcp;
namespace Slic3r {
namespace Utils {
namespace Utils {
TCPConsole::TCPConsole() : resolver_(io_context_), socket_(io_context_)
{
set_defaults();
}
TCPConsole::TCPConsole(const std::string& host_name, const std::string& port_name) :
resolver_(io_context_), socket_(io_context_)
{
set_defaults();
set_remote(host_name, port_name);
}
void TCPConsole::transmit_next_command()
{
if (cmd_queue_.empty()) {
io_context_.stop();
void TCPConsole::transmit_next_command()
{
if (m_cmd_queue.empty()) {
m_io_context.stop();
return;
}
std::string cmd = cmd_queue_.front();
cmd_queue_.pop_front();
std::string cmd = m_cmd_queue.front();
m_cmd_queue.pop_front();
BOOST_LOG_TRIVIAL(debug) << boost::format("TCPConsole: transmitting '%3%' to %1%:%2%")
% host_name_
% port_name_
% m_host_name
% m_port_name
% cmd;
m_send_buffer = cmd + m_newline;
send_buffer_ = cmd + newline_;
set_deadline_in(write_timeout_);
set_deadline_in(m_write_timeout);
boost::asio::async_write(
socket_,
boost::asio::buffer(send_buffer_),
m_socket,
boost::asio::buffer(m_send_buffer),
boost::bind(&TCPConsole::handle_write, this, _1, _2)
);
}
}
void TCPConsole::wait_next_line()
{
set_deadline_in(read_timeout_);
void TCPConsole::wait_next_line()
{
set_deadline_in(m_read_timeout);
boost::asio::async_read_until(
socket_,
recv_buffer_,
newline_,
m_socket,
m_recv_buffer,
m_newline,
boost::bind(&TCPConsole::handle_read, this, _1, _2)
);
}
}
// TODO: Use std::optional here
std::string TCPConsole::extract_next_line()
{
// TODO: Use std::optional here
std::string TCPConsole::extract_next_line()
{
char linebuf[1024];
std::istream is(&recv_buffer_);
std::istream is(&m_recv_buffer);
is.getline(linebuf, sizeof(linebuf));
if (is.good()) {
return linebuf;
}
return is.good() ? linebuf : std::string{};
}
return "";
}
void TCPConsole::handle_read(
void TCPConsole::handle_read(
const boost::system::error_code& ec,
std::size_t bytes_transferred)
{
error_code_ = ec;
{
m_error_code = ec;
if (ec) {
BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't read from %1%:%2%: %3%")
% host_name_
% port_name_
% m_host_name
% m_port_name
% ec.message();
io_context_.stop();
m_io_context.stop();
}
else {
std::string line = extract_next_line();
boost::trim(line);
BOOST_LOG_TRIVIAL(debug) << boost::format("TCPConsole: received '%3%' from %1%:%2%")
% host_name_
% port_name_
% m_host_name
% m_port_name
% line;
boost::to_lower(line);
if (line == done_string_) {
if (line == m_done_string)
transmit_next_command();
}
else {
else
wait_next_line();
}
}
}
}
void TCPConsole::handle_write(
void TCPConsole::handle_write(
const boost::system::error_code& ec,
std::size_t)
{
error_code_ = ec;
{
m_error_code = ec;
if (ec) {
BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't write to %1%:%2%: %3%")
% host_name_
% port_name_
% m_host_name
% m_port_name
% ec.message();
io_context_.stop();
m_io_context.stop();
}
else {
wait_next_line();
}
}
}
void TCPConsole::handle_connect(const boost::system::error_code& ec)
{
error_code_ = ec;
void TCPConsole::handle_connect(const boost::system::error_code& ec)
{
m_error_code = ec;
if (ec) {
BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't connect to %1%:%2%: %3%")
% host_name_
% port_name_
% m_host_name
% m_port_name
% ec.message();
io_context_.stop();
m_io_context.stop();
}
else {
is_connected_ = true;
m_is_connected = true;
BOOST_LOG_TRIVIAL(info) << boost::format("TCPConsole: connected to %1%:%2%")
% host_name_
% port_name_;
% m_host_name
% m_port_name;
transmit_next_command();
}
}
}
void TCPConsole::set_deadline_in(std::chrono::steady_clock::duration d)
{
deadline_ = std::chrono::steady_clock::now() + d;
}
bool TCPConsole::is_deadline_over()
{
return deadline_ < std::chrono::steady_clock::now();
}
void TCPConsole::set_deadline_in(std::chrono::steady_clock::duration d)
{
m_deadline = std::chrono::steady_clock::now() + d;
}
bool TCPConsole::is_deadline_over() const
{
return m_deadline < std::chrono::steady_clock::now();
}
bool TCPConsole::run_queue()
{
bool TCPConsole::run_queue()
{
auto now = std::chrono::steady_clock::now();
try {
// TODO: Add more resets and initializations after previous run (reset() method?..)
set_deadline_in(connect_timeout_);
is_connected_ = false;
io_context_.restart();
set_deadline_in(m_connect_timeout);
m_is_connected = false;
m_io_context.restart();
auto endpoints = resolver_.resolve(host_name_, port_name_);
auto endpoints = m_resolver.resolve(m_host_name, m_port_name);
socket_.async_connect(endpoints->endpoint(),
m_socket.async_connect(endpoints->endpoint(),
boost::bind(&TCPConsole::handle_connect, this, _1)
);
// Loop until we get any reasonable result. Negative result is also result.
// TODO: Rewrite to more graceful way using deadlime_timer
bool timeout = false;
while (!(timeout = is_deadline_over()) && !io_context_.stopped()) {
if (error_code_) {
io_context_.stop();
while (!(timeout = is_deadline_over()) && !m_io_context.stopped()) {
if (m_error_code) {
m_io_context.stop();
}
io_context_.run_for(boost::asio::chrono::milliseconds(100));
m_io_context.run_for(boost::asio::chrono::milliseconds(100));
}
// Override error message if timeout is set
if (timeout) {
error_code_ = make_error_code(boost::asio::error::timed_out);
}
if (timeout)
m_error_code = make_error_code(boost::asio::error::timed_out);
// Socket is not closed automatically by boost
socket_.close();
m_socket.close();
if (error_code_) {
if (m_error_code) {
// We expect that message is logged in handler
return false;
}
// It's expected to have empty queue after successful exchange
if (!cmd_queue_.empty()) {
if (!m_cmd_queue.empty()) {
BOOST_LOG_TRIVIAL(error) << "TCPConsole: command queue is not empty after end of exchange";
return false;
}
@ -214,16 +192,15 @@ namespace Slic3r {
catch (std::exception& e)
{
BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Exception while talking with %1%:%2%: %3%")
% host_name_
% port_name_
% m_host_name
% m_port_name
% e.what();
return false;
}
return true;
}
}
}
} // namespace Utils
} // namespace Slic3r

View File

@ -2,58 +2,57 @@
#define slic3r_Utils_TCPConsole_hpp_
#include <string>
#include <list>
#include <deque>
#include <boost/system/error_code.hpp>
#include <boost/system/system_error.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <boost/asio/streambuf.hpp>
namespace Slic3r {
namespace Utils {
namespace Utils {
using boost::asio::ip::tcp;
using boost::asio::ip::tcp;
class TCPConsole
{
public:
TCPConsole();
TCPConsole(const std::string& host_name, const std::string& port_name);
~TCPConsole() {}
class TCPConsole
{
public:
TCPConsole() : m_resolver(m_io_context), m_socket(m_io_context) { set_defaults(); }
TCPConsole(const std::string& host_name, const std::string& port_name) : m_resolver(m_io_context), m_socket(m_io_context)
{ set_defaults(); set_remote(host_name, port_name); }
~TCPConsole() = default;
void set_defaults()
{
newline_ = "\n";
done_string_ = "ok";
connect_timeout_ = std::chrono::milliseconds(5000);
write_timeout_ = std::chrono::milliseconds(10000);
read_timeout_ = std::chrono::milliseconds(10000);
m_newline = "\n";
m_done_string = "ok";
m_connect_timeout = std::chrono::milliseconds(5000);
m_write_timeout = std::chrono::milliseconds(10000);
m_read_timeout = std::chrono::milliseconds(10000);
}
void set_line_delimiter(const std::string& newline) {
newline_ = newline;
m_newline = newline;
}
void set_command_done_string(const std::string& done_string) {
done_string_ = done_string;
m_done_string = done_string;
}
void set_remote(const std::string& host_name, const std::string& port_name)
{
host_name_ = host_name;
port_name_ = port_name;
m_host_name = host_name;
m_port_name = port_name;
}
bool enqueue_cmd(const std::string& cmd) {
// TODO: Add multithread protection to queue
cmd_queue_.push_back(cmd);
m_cmd_queue.push_back(cmd);
return true;
}
bool run_queue();
std::string error_message() {
return error_code_.message();
}
std::string error_message() const { return m_error_code.message(); }
private:
private:
void handle_connect(const boost::system::error_code& ec);
void handle_read(const boost::system::error_code& ec, std::size_t bytes_transferred);
void handle_write(const boost::system::error_code& ec, std::size_t bytes_transferred);
@ -63,30 +62,30 @@ namespace Slic3r {
std::string extract_next_line();
void set_deadline_in(std::chrono::steady_clock::duration);
bool is_deadline_over();
bool is_deadline_over() const;
std::string host_name_;
std::string port_name_;
std::string newline_;
std::string done_string_;
std::chrono::steady_clock::duration connect_timeout_;
std::chrono::steady_clock::duration write_timeout_;
std::chrono::steady_clock::duration read_timeout_;
std::string m_host_name;
std::string m_port_name;
std::string m_newline;
std::string m_done_string;
std::chrono::steady_clock::duration m_connect_timeout;
std::chrono::steady_clock::duration m_write_timeout;
std::chrono::steady_clock::duration m_read_timeout;
std::list<std::string> cmd_queue_;
std::deque<std::string> m_cmd_queue;
boost::asio::io_context io_context_;
tcp::resolver resolver_;
tcp::socket socket_;
boost::asio::streambuf recv_buffer_;
std::string send_buffer_;
boost::asio::io_context m_io_context;
tcp::resolver m_resolver;
tcp::socket m_socket;
boost::asio::streambuf m_recv_buffer;
std::string m_send_buffer;
bool is_connected_;
boost::system::error_code error_code_;
std::chrono::steady_clock::time_point deadline_;
};
bool m_is_connected;
boost::system::error_code m_error_code;
std::chrono::steady_clock::time_point m_deadline;
};
} // Utils
} // Utils
} // Slic3r
#endif