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

@ -32,21 +32,20 @@ namespace pt = boost::property_tree;
namespace Slic3r { namespace Slic3r {
MKS::MKS(DynamicPrintConfig* config) : MKS::MKS(DynamicPrintConfig* config) :
host(config->opt_string("print_host")), console_port("8080") 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 bool MKS::test(wxString& msg) const
{ {
Utils::TCPConsole console(host, console_port); Utils::TCPConsole console(m_host, m_console_port);
console.enqueue_cmd("M105"); console.enqueue_cmd("M105");
bool ret = console.run_queue(); bool ret = console.run_queue();
if (!ret) { if (!ret)
msg = wxString::FromUTF8(console.error_message().c_str()); msg = wxString::FromUTF8(console.error_message().c_str());
}
return ret; return ret;
} }
@ -115,7 +114,7 @@ namespace Slic3r {
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%") return (boost::format("http://%1%/upload?X-Filename=%2%")
% host % m_host
% Http::url_encode(filename)).str(); % Http::url_encode(filename)).str();
} }
@ -126,16 +125,15 @@ namespace Slic3r {
// TODO: Inspect reasons // TODO: Inspect reasons
std::this_thread::sleep_for(std::chrono::milliseconds(1500)); 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(std::string("M23 ") + filename);
console.enqueue_cmd("M24"); console.enqueue_cmd("M24");
bool ret = console.run_queue(); bool ret = console.run_queue();
if (!ret) { if (!ret)
msg = wxString::FromUTF8(console.error_message().c_str()); msg = wxString::FromUTF8(console.error_message().c_str());
}
return ret; return ret;
} }

View File

@ -26,11 +26,11 @@ namespace Slic3r {
bool has_auto_discovery() const override { return false; } bool has_auto_discovery() const override { return false; }
bool can_test() const override { return true; } bool can_test() const override { return true; }
bool can_start_print() 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: private:
std::string host; std::string m_host;
std::string console_port; std::string m_console_port;
std::string get_upload_url(const std::string& filename) const; std::string get_upload_url(const std::string& filename) const;
bool start_print(wxString& msg, const std::string& filename) const; bool start_print(wxString& msg, const std::string& filename) const;

View File

@ -20,51 +20,38 @@ using boost::asio::ip::tcp;
namespace Slic3r { 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() void TCPConsole::transmit_next_command()
{ {
if (cmd_queue_.empty()) { if (m_cmd_queue.empty()) {
io_context_.stop(); m_io_context.stop();
return; return;
} }
std::string cmd = cmd_queue_.front(); std::string cmd = m_cmd_queue.front();
cmd_queue_.pop_front(); m_cmd_queue.pop_front();
BOOST_LOG_TRIVIAL(debug) << boost::format("TCPConsole: transmitting '%3%' to %1%:%2%") BOOST_LOG_TRIVIAL(debug) << boost::format("TCPConsole: transmitting '%3%' to %1%:%2%")
% host_name_ % m_host_name
% port_name_ % m_port_name
% cmd; % cmd;
m_send_buffer = cmd + m_newline;
send_buffer_ = cmd + newline_; set_deadline_in(m_write_timeout);
set_deadline_in(write_timeout_);
boost::asio::async_write( boost::asio::async_write(
socket_, m_socket,
boost::asio::buffer(send_buffer_), boost::asio::buffer(m_send_buffer),
boost::bind(&TCPConsole::handle_write, this, _1, _2) boost::bind(&TCPConsole::handle_write, this, _1, _2)
); );
} }
void TCPConsole::wait_next_line() void TCPConsole::wait_next_line()
{ {
set_deadline_in(read_timeout_); set_deadline_in(m_read_timeout);
boost::asio::async_read_until( boost::asio::async_read_until(
socket_, m_socket,
recv_buffer_, m_recv_buffer,
newline_, m_newline,
boost::bind(&TCPConsole::handle_read, this, _1, _2) boost::bind(&TCPConsole::handle_read, this, _1, _2)
); );
} }
@ -73,62 +60,55 @@ namespace Slic3r {
std::string TCPConsole::extract_next_line() std::string TCPConsole::extract_next_line()
{ {
char linebuf[1024]; char linebuf[1024];
std::istream is(&m_recv_buffer);
std::istream is(&recv_buffer_);
is.getline(linebuf, sizeof(linebuf)); is.getline(linebuf, sizeof(linebuf));
if (is.good()) { return is.good() ? linebuf : std::string{};
return linebuf;
}
return "";
} }
void TCPConsole::handle_read( void TCPConsole::handle_read(
const boost::system::error_code& ec, const boost::system::error_code& ec,
std::size_t bytes_transferred) std::size_t bytes_transferred)
{ {
error_code_ = ec; m_error_code = ec;
if (ec) { if (ec) {
BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't read from %1%:%2%: %3%") BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't read from %1%:%2%: %3%")
% host_name_ % m_host_name
% port_name_ % m_port_name
% ec.message(); % ec.message();
io_context_.stop(); m_io_context.stop();
} }
else { else {
std::string line = extract_next_line(); std::string line = extract_next_line();
boost::trim(line); boost::trim(line);
BOOST_LOG_TRIVIAL(debug) << boost::format("TCPConsole: received '%3%' from %1%:%2%") BOOST_LOG_TRIVIAL(debug) << boost::format("TCPConsole: received '%3%' from %1%:%2%")
% host_name_ % m_host_name
% port_name_ % m_port_name
% line; % line;
boost::to_lower(line); boost::to_lower(line);
if (line == done_string_) { if (line == m_done_string)
transmit_next_command(); transmit_next_command();
} else
else {
wait_next_line(); wait_next_line();
} }
} }
}
void TCPConsole::handle_write( void TCPConsole::handle_write(
const boost::system::error_code& ec, const boost::system::error_code& ec,
std::size_t) std::size_t)
{ {
error_code_ = ec; m_error_code = ec;
if (ec) { if (ec) {
BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't write to %1%:%2%: %3%") BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't write to %1%:%2%: %3%")
% host_name_ % m_host_name
% port_name_ % m_port_name
% ec.message(); % ec.message();
io_context_.stop(); m_io_context.stop();
} }
else { else {
wait_next_line(); wait_next_line();
@ -137,22 +117,21 @@ namespace Slic3r {
void TCPConsole::handle_connect(const boost::system::error_code& ec) void TCPConsole::handle_connect(const boost::system::error_code& ec)
{ {
error_code_ = ec; m_error_code = ec;
if (ec) { if (ec) {
BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't connect to %1%:%2%: %3%") BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Can't connect to %1%:%2%: %3%")
% host_name_ % m_host_name
% port_name_ % m_port_name
% ec.message(); % ec.message();
io_context_.stop(); m_io_context.stop();
} }
else { else {
is_connected_ = true; m_is_connected = true;
BOOST_LOG_TRIVIAL(info) << boost::format("TCPConsole: connected to %1%:%2%") BOOST_LOG_TRIVIAL(info) << boost::format("TCPConsole: connected to %1%:%2%")
% host_name_ % m_host_name
% port_name_; % m_port_name;
transmit_next_command(); transmit_next_command();
} }
@ -160,11 +139,11 @@ namespace Slic3r {
void TCPConsole::set_deadline_in(std::chrono::steady_clock::duration d) void TCPConsole::set_deadline_in(std::chrono::steady_clock::duration d)
{ {
deadline_ = std::chrono::steady_clock::now() + d; m_deadline = std::chrono::steady_clock::now() + d;
} }
bool TCPConsole::is_deadline_over() bool TCPConsole::is_deadline_over() const
{ {
return deadline_ < std::chrono::steady_clock::now(); return m_deadline < std::chrono::steady_clock::now();
} }
bool TCPConsole::run_queue() bool TCPConsole::run_queue()
@ -172,41 +151,40 @@ namespace Slic3r {
auto now = std::chrono::steady_clock::now(); auto now = std::chrono::steady_clock::now();
try { try {
// TODO: Add more resets and initializations after previous run (reset() method?..) // TODO: Add more resets and initializations after previous run (reset() method?..)
set_deadline_in(connect_timeout_); set_deadline_in(m_connect_timeout);
is_connected_ = false; m_is_connected = false;
io_context_.restart(); 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) boost::bind(&TCPConsole::handle_connect, this, _1)
); );
// Loop until we get any reasonable result. Negative result is also result. // Loop until we get any reasonable result. Negative result is also result.
// TODO: Rewrite to more graceful way using deadlime_timer // TODO: Rewrite to more graceful way using deadlime_timer
bool timeout = false; bool timeout = false;
while (!(timeout = is_deadline_over()) && !io_context_.stopped()) { while (!(timeout = is_deadline_over()) && !m_io_context.stopped()) {
if (error_code_) { if (m_error_code) {
io_context_.stop(); 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 // Override error message if timeout is set
if (timeout) { if (timeout)
error_code_ = make_error_code(boost::asio::error::timed_out); m_error_code = make_error_code(boost::asio::error::timed_out);
}
// Socket is not closed automatically by boost // 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 // We expect that message is logged in handler
return false; return false;
} }
// It's expected to have empty queue after successful exchange // 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"; BOOST_LOG_TRIVIAL(error) << "TCPConsole: command queue is not empty after end of exchange";
return false; return false;
} }
@ -214,8 +192,8 @@ namespace Slic3r {
catch (std::exception& e) catch (std::exception& e)
{ {
BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Exception while talking with %1%:%2%: %3%") BOOST_LOG_TRIVIAL(error) << boost::format("TCPConsole: Exception while talking with %1%:%2%: %3%")
% host_name_ % m_host_name
% port_name_ % m_port_name
% e.what(); % e.what();
return false; return false;
@ -224,6 +202,5 @@ namespace Slic3r {
return true; return true;
} }
} // namespace Utils
} } // namespace Slic3r
}

View File

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