Cadabra
Computer algebra system for field theory problems
ComputeThread.hh
Go to the documentation of this file.
1 
2 #pragma once
3 
4 #include <signal.h>
5 #include <websocketpp/config/asio_no_tls_client.hpp>
6 #include <websocketpp/client.hpp>
7 #include <websocketpp/common/thread.hpp>
8 #include <websocketpp/common/functional.hpp>
9 #include <thread>
10 #include <glibmm/spawn.h>
11 
12 typedef websocketpp::client<websocketpp::config::asio_client> WSClient;
13 typedef websocketpp::config::asio_client::message_type::ptr message_ptr;
14 typedef websocketpp::lib::lock_guard<websocketpp::lib::mutex> scoped_lock;
15 
16 #include "DataCell.hh"
17 
18 namespace cadabra {
19 
20  class GUIBase;
21  class DocumentThread;
22 
34 
35  class ComputeThread {
36  public:
39 
40  ComputeThread(int server_port=0, std::string token="", std::string ip_address="127.0.0.1");
41  ComputeThread(const ComputeThread& )=delete; // You cannot copy this object
43 
47 
52 
53  void run();
54 
65 
66  void execute_cell(DTree::iterator);
67 
68  void execute_interactive(const std::string& code);
69 
70  void register_interactive_cell(uint64_t id);
71 
74 
75  void stop();
76 
78 
79  void restart_kernel();
80 
86 
87  bool complete(DTree::iterator, int pos, int alternative);
88 
89  // Determine if there are still cells running on the server.
90  // FIXME: this does not guarantee thread-safety but at the moment
91  // is only used for updating status bars etc.
92  // FIXME: can be moved to DocumentThread.
93 
94  int number_of_cells_executing(void) const;
95 
98 
99  void terminate();
100 
101  private:
104 
105  // For debugging purposes, we keep record of the gui thread id,
106  // so that we can flag when code runs on the wrong thread.
107  // Gets initialised in the ComputeThread constructor.
108  std::thread::id gui_thread_id;
109 
110  // Keeping track of cells which are running on the server, in
111  // a form which allows us to look them up quickly based only
112  // on the id (which is all that the server knows about).
113 
114  // FIXME: moving this away into documentthread, so that we only need to refer to id's.
115  std::map<DataCell::id_t, DTree::iterator> running_cells;
116 
117  // WebSocket++ things.
120  WSClient::connection_ptr connection;
121  websocketpp::connection_hdl our_connection_hdl;
122  void init();
123  void try_connect();
124  void try_spawn_server();
125  void on_open(websocketpp::connection_hdl hdl);
126  void on_fail(websocketpp::connection_hdl hdl);
127  void on_close(websocketpp::connection_hdl hdl);
128  void on_message(websocketpp::connection_hdl hdl, message_ptr msg);
129 
131 
134  void all_cells_nonrunning();
135 
137  std::vector<uint64_t> console_child_ids;
138 
139  // Self-started server
140  Glib::Pid server_pid;
142  unsigned short port;
143  std::string authentication_token;
145  std::string forced_server_token;
147  };
148 
149  }
void try_spawn_server()
Definition: ComputeThread.cc:169
std::string forced_server_token
Definition: ComputeThread.hh:145
void set_master(GUIBase *, DocumentThread *)
Determine the objects that this compute thread should be talking to.
Definition: ComputeThread.cc:43
void on_fail(websocketpp::connection_hdl hdl)
Definition: ComputeThread.cc:147
Abstract base class with methods that need to be implemented by any GUI.
Definition: GUIBase.hh:16
void on_message(websocketpp::connection_hdl hdl, message_ptr msg)
Definition: ComputeThread.cc:274
websocketpp::lib::lock_guard< websocketpp::lib::mutex > scoped_lock
Definition: ComputeThread.hh:14
WSClient::connection_ptr connection
Definition: ComputeThread.hh:120
void cell_finished_running(DataCell::id_t)
Definition: ComputeThread.cc:263
int number_of_cells_executing(void) const
Definition: ComputeThread.cc:546
std::vector< uint64_t > console_child_ids
Definition: ComputeThread.hh:137
unsigned short port
Definition: ComputeThread.hh:142
void execute_cell(DTree::iterator)
In order to execute code on the server, call the following from the GUI thread.
Definition: ComputeThread.cc:473
websocketpp::connection_hdl our_connection_hdl
Definition: ComputeThread.hh:121
DocumentThread * docthread
Definition: ComputeThread.hh:103
A base class with all the logic to manipulate a Cadabra notebook document.
Definition: DocumentThread.hh:40
bool complete(DTree::iterator, int pos, int alternative)
Request completion of a string.
Definition: ComputeThread.cc:600
void try_connect()
Definition: ComputeThread.cc:57
void stop()
Stop the current cell execution on the server and remove all other cells from the run queue as well...
Definition: ComputeThread.cc:551
void run()
Main entry point, which will connect to the server and then start an event loop to handle communicati...
Definition: ComputeThread.cc:96
std::thread::id gui_thread_id
Definition: ComputeThread.hh:108
std::string authentication_token
Definition: ComputeThread.hh:143
GUIBase * gui
Definition: ComputeThread.hh:102
void execute_interactive(const std::string &code)
Definition: ComputeThread.cc:442
void on_close(websocketpp::connection_hdl hdl)
Definition: ComputeThread.cc:249
void register_interactive_cell(uint64_t id)
Definition: ComputeThread.cc:468
bool restarting_kernel
Definition: ComputeThread.hh:119
int server_stdout
Definition: ComputeThread.hh:141
Functions to handle the exchange properties of two or more symbols in a product.
Definition: Adjform.cc:83
std::string forced_server_ip_address
Definition: ComputeThread.hh:146
int server_stderr
Definition: ComputeThread.hh:141
void terminate()
Terminate the compute thread, in preparation for shutting down the client altogether.
Definition: ComputeThread.cc:108
int forced_server_port
Definition: ComputeThread.hh:144
std::map< DataCell::id_t, DTree::iterator > running_cells
Definition: ComputeThread.hh:115
Glib::Pid server_pid
Definition: ComputeThread.hh:140
~ComputeThread()
Definition: ComputeThread.cc:31
websocketpp::client< websocketpp::config::asio_client > WSClient
Definition: ComputeThread.hh:12
ComputeThread(int server_port=0, std::string token="", std::string ip_address="127.0.0.1")
If the ComputeThread is constructed with a null pointer to the gui, there will be no gui updates...
Definition: ComputeThread.cc:19
uint64_t interactive_cell
Definition: ComputeThread.hh:136
void restart_kernel()
Restart the kernel.
Definition: ComputeThread.cc:571
void all_cells_nonrunning()
Set all cells to be non-running (e.g.
Definition: ComputeThread.cc:133
Base class which talks to the server and sends Action objects back to the DocumentThread.
Definition: ComputeThread.hh:35
void init()
Definition: ComputeThread.cc:49
bool connection_is_open
Definition: ComputeThread.hh:119
Each cell is identified by a serial number &#39;id&#39; which is used to keep track of it across network call...
Definition: DataCell.hh:51
WSClient wsclient
Definition: ComputeThread.hh:118
websocketpp::config::asio_client::message_type::ptr message_ptr
Definition: ComputeThread.hh:13
void on_open(websocketpp::connection_hdl hdl)
Definition: ComputeThread.cc:222