Class: OsCtld::Commands::Base
- Inherits:
-
Object
- Object
- OsCtld::Commands::Base
show all
- Defined in:
- lib/osctld/commands/base.rb
Direct Known Subclasses
Container::Assets, Container::Attach, Container::CGParamApply, Container::CGParamList, Container::CGParamReplace, Container::Console, Container::DeviceList, Container::Exec, Container::Freeze, Container::List, Container::Mount, Container::MountList, Container::Passwd, Container::PrLimitList, Container::Reconfigure, Container::RecoverCleanup, Container::RecoverState, Container::Runscript, Container::SendCancel, Container::SendCleanup, Container::SendConfig, Container::SendNow, Container::SendRootfs, Container::SendState, Container::SendSync, Container::Show, Container::Su, Container::Unfreeze, Container::Wall, CpuScheduler::Disable, CpuScheduler::Enable, CpuScheduler::PackageDisable, CpuScheduler::PackageEnable, CpuScheduler::PackageList, CpuScheduler::Status, CpuScheduler::Upkeep, Dataset::Create, Dataset::Delete, Dataset::List, Debug::LockRegistry, Debug::ThreadList, Debug::UGidkRegistry, Event::Subscribe, Group::Assets, Group::CGParamApply, Group::CGParamList, Group::CGParamReplace, Group::CGSubsystems, Group::DeviceList, Group::List, Group::Show, History::List, IdRange::Assets, IdRange::List, IdRange::Show, IdRange::TableList, IdRange::TableShow, Logged, Lxcfs::WorkerDisable, Lxcfs::WorkerEnable, Lxcfs::WorkerList, Lxcfs::WorkerPrune, Lxcfs::WorkerSet, NetInterface::IpList, NetInterface::List, NetInterface::RouteList, NetInterface::Show, Pool::AbortExport, Pool::Assets, Pool::AutoStartCancel, Pool::AutoStartQueue, Pool::AutoStartTrigger, Pool::Export, Pool::Import, Pool::Install, Pool::List, Pool::Show, Pool::Uninstall, Receive::AuthKeyList, Repository::Assets, Repository::ImageList, Repository::List, Repository::Show, Self::AbortShutdown, Self::Activate, Self::Assets, Self::HealthCheck, Self::Ping, Self::Shutdown, Self::Status, Send::KeyPath, TrashBin::DatasetAdd, TrashBin::Prune, User::Assets, User::IdMapList, User::List, User::LxcUsernet, User::Register, User::Setup, User::Show, User::SubUGIds, User::Unregister, SendReceive::Commands::Base, UserControl::Commands::Base
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(cmd_opts, opts) ⇒ Base
Returns a new instance of Base.
38
39
40
41
42
43
44
|
# File 'lib/osctld/commands/base.rb', line 38
def initialize(cmd_opts, opts)
@opts = cmd_opts
@id = opts[:id]
@client_handler = opts[:handler]
@client = @client_handler && @client_handler.socket
@indirect = opts[:indirect] || false
end
|
Instance Attribute Details
#client ⇒ Object
Returns the value of attribute client.
36
37
38
|
# File 'lib/osctld/commands/base.rb', line 36
def client
@client
end
|
#client_handler ⇒ Object
Returns the value of attribute client_handler.
71
72
73
|
# File 'lib/osctld/commands/base.rb', line 71
def client_handler
@client_handler
end
|
#id ⇒ Object
Returns the value of attribute id.
36
37
38
|
# File 'lib/osctld/commands/base.rb', line 36
def id
@id
end
|
#opts ⇒ Object
Returns the value of attribute opts.
36
37
38
|
# File 'lib/osctld/commands/base.rb', line 36
def opts
@opts
end
|
Class Method Details
.cmd ⇒ Object
8
9
10
|
# File 'lib/osctld/commands/base.rb', line 8
def self.cmd
@cmd
end
|
.handle(name) ⇒ Object
3
4
5
6
|
# File 'lib/osctld/commands/base.rb', line 3
def self.handle(name)
@cmd = name
Command.register(name, self)
end
|
.run(internal: {}, **kwargs) ⇒ Object
17
18
19
20
21
|
# File 'lib/osctld/commands/base.rb', line 17
def self.run(internal: {}, **kwargs)
kwargs[:id] ||= Command.get_id
c = new(kwargs, internal)
c.base_execute
end
|
.run!(**kwargs) ⇒ Object
23
24
25
26
27
28
29
30
31
32
33
34
|
# File 'lib/osctld/commands/base.rb', line 23
def self.run!(**kwargs)
ret = run(**kwargs)
if !ret.is_a?(Hash)
fail "invalid return value '#{ret.inspect}'"
elsif !ret[:status]
fail ret[:message]
end
ret
end
|
Instance Method Details
#base_execute ⇒ Object
This method is for command templates, do not override it in your command
47
48
49
|
# File 'lib/osctld/commands/base.rb', line 47
def base_execute
execute
end
|
#call_cmd(klass, **opts) ⇒ Object
73
74
75
|
# File 'lib/osctld/commands/base.rb', line 73
def call_cmd(klass, **opts)
klass.run(internal: {handler: client_handler, indirect: true}, **opts)
end
|
#call_cmd!(*args, **kwargs) ⇒ Object
77
78
79
80
81
82
83
84
85
86
87
88
|
# File 'lib/osctld/commands/base.rb', line 77
def call_cmd!(*args, **kwargs)
ret = call_cmd(*args, **kwargs)
if !ret.is_a?(Hash)
error!("invalid return value '#{ret.inspect}'")
elsif !ret[:status]
error!(ret[:message])
end
ret
end
|
#error(msg) ⇒ Object
134
135
136
|
# File 'lib/osctld/commands/base.rb', line 134
def error(msg)
{status: false, message: msg}
end
|
#error!(msg) ⇒ Object
138
139
140
|
# File 'lib/osctld/commands/base.rb', line 138
def error!(msg)
raise CommandFailed, msg
end
|
#execute ⇒ Object
Implement this method in your command, or follow instructions from your command template.
53
54
55
|
# File 'lib/osctld/commands/base.rb', line 53
def execute
raise NotImplementedError
end
|
#handled ⇒ Object
130
131
132
|
# File 'lib/osctld/commands/base.rb', line 130
def handled
{status: :handled}
end
|
#indirect? ⇒ Boolean
148
149
150
|
# File 'lib/osctld/commands/base.rb', line 148
def indirect?
@indirect
end
|
#manipulate(manipulable) { ... } ⇒ Object
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
# File 'lib/osctld/commands/base.rb', line 92
def manipulate(manipulable, &codeblock)
block = opts[:manipulation_lock] == 'wait'
if opts[:manipulation_lock] == 'ignore'
codeblock.call
elsif manipulable.is_a?(Array)
locked = []
begin
manipulable.each do |m|
m.acquire_manipulation_lock(self, block: block) || (fail 'unable to lock')
locked << m
end
rescue ResourceLocked
locked.reverse_each(&:release_manipulation_lock)
raise
end
begin
codeblock.call
ensure
locked.reverse_each(&:release_manipulation_lock)
end
else
manipulable.manipulate(self, block: block, &codeblock)
end
end
|
#manipulation_holder ⇒ Object
62
63
64
65
66
67
68
|
# File 'lib/osctld/commands/base.rb', line 62
def manipulation_holder
if opts[:cli]
"'#{opts[:cli]}'"
else
self.class.cmd.to_s
end
end
|
#ok(resp = nil) ⇒ Object
126
127
128
|
# File 'lib/osctld/commands/base.rb', line 126
def ok(resp = nil)
{status: true, output: resp}
end
|
#progress(msg) ⇒ Object
142
143
144
145
146
|
# File 'lib/osctld/commands/base.rb', line 142
def progress(msg)
if @client_handler && (opts[:progress].nil? || opts[:progress])
@client_handler.send_update(msg)
end
end
|
#request_stop ⇒ Object
Implement to prematurely stop the client thread
58
59
60
|
# File 'lib/osctld/commands/base.rb', line 58
def request_stop
end
|