Cadabra
Computer algebra system for field theory problems
Loading...
Searching...
No Matches
ComputeThread.hh
Go to the documentation of this file.
1
2#pragma once
3
4#include <signal.h>
5#include <thread>
6#include <set>
7#include <glibmm/spawn.h>
8#include "websocket_client.hh"
9
10#include "DataCell.hh"
11
12namespace cadabra {
13
14 class GUIBase;
15 class DocumentThread;
16
28
30 public:
33
34 ComputeThread(int server_port=0, std::string token="", std::string ip_address="127.0.0.1");
35 ComputeThread(const ComputeThread& )=delete; // You cannot copy this object
37
41
46
47 void run();
48
59
60 void execute_cell(DTree::iterator, std::string no_assign="",
61 std::vector<uint64_t> output_cell_ids=std::vector<uint64_t>() );
62
63 void execute_interactive(uint64_t id, const std::string& code);
64
68
69 void update_variable_on_server(std::string variable, double value);
70
73
74 void stop();
75
77
78 void restart_kernel();
79
85
86 bool complete(DTree::iterator, int pos, int alternative);
87
88 // Determine if there are still cells running on the server.
89 // FIXME: this does not guarantee thread-safety but at the moment
90 // is only used for updating status bars etc.
91 // FIXME: can be moved to DocumentThread.
92
93 int number_of_cells_executing(void) const;
94
97
98 void terminate();
99
101 bool kernel_is_connected() const;
102
103 private:
106
107 // For debugging purposes, we keep record of the gui thread id,
108 // so that we can flag when code runs on the wrong thread.
109 // Gets initialised in the ComputeThread constructor.
110 std::thread::id gui_thread_id;
111
112 // Keeping track of cells which are running on the server, in
113 // a form which allows us to look them up quickly based only
114 // on the id (which is all that the server knows about). A
115 // cell can be queued multiple times for running; this is the
116 // integer in the map.
117
118 std::map<DataCell::id_t, int> running_cells;
119
120 // WebSocket++ things.
123
124 void init();
125 void try_connect();
126 void try_spawn_server();
127 void on_open();
128 void on_fail(const boost::beast::error_code&);
129 void on_close();
130 void on_message(const std::string& msg);
131
133
137
138 std::set<uint64_t> interactive_cells;
139
140 // Self-started server
141 Glib::Pid server_pid;
143 unsigned short port;
148 };
149
150 }
Base class which talks to the server and sends Action objects back to the DocumentThread.
Definition ComputeThread.hh:29
void init()
Definition ComputeThread.cc:48
void try_connect()
Definition ComputeThread.cc:53
void stop()
Stop the current cell execution on the server and remove all other cells from the run queue as well.
Definition ComputeThread.cc:619
void update_variable_on_server(std::string variable, double value)
Update a variable in the kernel.
Definition ComputeThread.cc:593
~ComputeThread()
Definition ComputeThread.cc:30
std::thread::id gui_thread_id
Definition ComputeThread.hh:110
std::string authentication_token
Definition ComputeThread.hh:144
std::string forced_server_ip_address
Definition ComputeThread.hh:147
void run()
Main entry point, which will connect to the server and then start an event loop to handle communicati...
Definition ComputeThread.cc:67
Glib::Pid server_pid
Definition ComputeThread.hh:141
void on_open()
Definition ComputeThread.cc:208
std::string forced_server_token
Definition ComputeThread.hh:146
void on_close()
Definition ComputeThread.cc:237
bool kernel_is_connected() const
Return the status of the connection to the kernel.
Definition ComputeThread.cc:106
void restart_kernel()
Restart the kernel.
Definition ComputeThread.cc:643
ComputeThread(const ComputeThread &)=delete
bool connection_is_open
Definition ComputeThread.hh:122
int server_stdout
Definition ComputeThread.hh:142
bool restarting_kernel
Definition ComputeThread.hh:122
int forced_server_port
Definition ComputeThread.hh:145
void terminate()
Terminate the compute thread, in preparation for shutting down the client altogether.
Definition ComputeThread.cc:81
void cell_finished_running(DataCell::id_t)
Definition ComputeThread.cc:256
void try_spawn_server()
Definition ComputeThread.cc:147
GUIBase * gui
Definition ComputeThread.hh:104
websocket_client wsclient
Definition ComputeThread.hh:121
DocumentThread * docthread
Definition ComputeThread.hh:105
std::set< uint64_t > interactive_cells
Definition ComputeThread.hh:138
int number_of_cells_executing(void) const
Definition ComputeThread.cc:614
void on_fail(const boost::beast::error_code &)
Definition ComputeThread.cc:125
std::map< DataCell::id_t, int > running_cells
Definition ComputeThread.hh:118
void all_cells_nonrunning()
Set all cells to be non-running (e.g.
Definition ComputeThread.cc:111
void set_master(GUIBase *, DocumentThread *)
Determine the objects that this compute thread should be talking to.
Definition ComputeThread.cc:42
void execute_interactive(uint64_t id, const std::string &code)
Definition ComputeThread.cc:481
void on_message(const std::string &msg)
Definition ComputeThread.cc:281
int server_stderr
Definition ComputeThread.hh:142
void execute_cell(DTree::iterator, std::string no_assign="", std::vector< uint64_t > output_cell_ids=std::vector< uint64_t >())
In order to execute code on the server, call the following from the GUI thread.
Definition ComputeThread.cc:511
unsigned short port
Definition ComputeThread.hh:143
Each cell is identified by a serial number 'id' which is used to keep track of it across network call...
Definition DataCell.hh:53
A base class with all the logic to manipulate a Cadabra notebook document.
Definition DocumentThread.hh:41
Abstract base class with methods that need to be implemented by any GUI.
Definition GUIBase.hh:16
Complete a set of coordinate rules so that they also cover related tensors.
Definition complete.hh:14
Definition websocket_client.hh:15
Functions to handle the exchange properties of two or more symbols in a product.
Definition Adjform.cc:83
void set(rset_t::iterator &num, multiplier_t fac)
Definition Storage.cc:1064