1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
// file : bbot/agent/machine.hxx -*- C++ -*-
// license : TBC; see accompanying LICENSE file
#ifndef BBOT_AGENT_MACHINE_HXX
#define BBOT_AGENT_MACHINE_HXX
#include <bbot/types.hxx>
#include <bbot/utility.hxx>
namespace bbot
{
// A running build machine (container, vm, etc).
//
// Note that if the machine is destroyed while it is still running, the
// destructor will block until the machine process terminates.
//
// Some functions can fail softly if the fail_hard argument is false.
//
class machine
{
public:
// Shut the machine down cleanly waiting up to the specified number of
// seconds for completion. Update the timeout and return false if the
// machine is still running, true if the machine exited successfully, and
// throw failed otherwise.
//
virtual bool
shutdown (size_t& seconds) = 0;
// Force the machine down.
//
virtual void
forcedown (bool fail_hard = true) = 0;
// Suspend the machine.
//
virtual void
suspend (bool fail_hard = true) = 0;
// Wait for the machine to terminate up to the specified number of seconds
// (with 0 meaning don't wait). Update the timeout and return false if the
// machine is still running, true if the machine exited successfully, and
// throw failed otherwise.
//
virtual bool
wait (size_t& seconds, bool fail_hard = true) = 0;
bool
wait (bool fail_hard = true)
{
size_t sec (~0); // Wait indefinitely.
return wait (sec, fail_hard);
}
// Cleanup machine resources (logs, etc). Normally you would only call
// this after a successful (or successfully investigated) completion.
//
virtual void
cleanup () = 0;
// Print information about the machine (as info diagnostics) that can be
// useful for debugging (e.g., how to connect/login, etc).
//
virtual void
print_info (diag_record&) = 0;
public:
const string mac; // MAC address (inside the machine).
public:
virtual
~machine () = default;
protected:
machine (string m)
: mac (move (m)) {}
};
class machine_manifest;
unique_ptr<machine>
start_machine (const dir_path&,
const machine_manifest&,
const optional<string>& mac,
const string& br_iface,
uint16_t tftp_port,
bool pub_vnc);
// Return the machine's public or private VNC session endpoint in the
// '<ip>:<port>' form.
//
string
machine_vnc (bool pub_vnc);
}
#endif // BBOT_AGENT_MACHINE_HXX
|
