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
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
use crate::enums::VBoxEventType;
use crate::event::Event;
use crate::event_listener::EventListener;
use crate::utility::macros::macros::{get_function_result_pointer, get_function_result_unit};
use crate::{EventSource, VboxError};
use vbox_raw::sys_lib::{IEvent, IEventListener, IEventSource};
impl EventSource {
/// Creates a new listener object, useful for passive mode.
///
/// # Returns
///
/// Returns a new instance of the [`EventListener`] class on success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
///
/// let vbox = VirtualBox::init().unwrap();
/// let event_source = vbox.get_event_source().unwrap();
/// let listener = event_source.create_listener().unwrap();
pub fn create_listener(&self) -> Result<EventListener, VboxError> {
let listener =
get_function_result_pointer!(self.object, CreateListener, *mut IEventListener)?;
Ok(EventListener::new(listener))
}
/// Creates a new listener object, useful for passive mode.
///
/// # Arguments
///
/// * `sources` - Subordinate event source this one aggregates.
///
/// # Returns
///
/// Returns a new instance of the [`EventSource`] class on success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
///
/// let vbox = VirtualBox::init().unwrap();
/// let event_source1 = vbox.get_event_source().unwrap();
/// let event_source2 = vbox.get_event_source().unwrap();
/// let event_source3 = vbox.get_event_source().unwrap();
/// let event_source = event_source1.create_aggregator(vec![&event_source2, &event_source3]);
pub fn create_aggregator(&self, sources: Vec<&EventSource>) -> Result<EventSource, VboxError> {
let mut sources_ptr_vec = Vec::new();
for source_ptr in sources {
sources_ptr_vec.push(source_ptr.object);
}
let sources_ptr = sources_ptr_vec.as_mut_ptr();
let sources_count: u32 = sources_ptr_vec.len() as u32;
let source = get_function_result_pointer!(
self.object,
CreateAggregator,
*mut IEventSource,
sources_count,
sources_ptr
)?;
Ok(EventSource::new(source))
}
/// Creates a new listener object, useful for passive mode.
///
/// # Arguments
///
/// * `event_listener` - [`EventListener`] to register.
/// * `event_types` - Event types listener is interested in. One can use wildcards like - [`VBoxEventType::Any`] to specify wildcards, matching more than one event.
/// * `active` - Which mode this listener is operating in.
///
/// # Returns
///
/// Returns Ok(()) on success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::VBoxEventType;
///
/// let vbox = VirtualBox::init().unwrap();
/// let event_source = vbox.get_event_source().unwrap();
/// let listener = event_source.create_listener().unwrap();
/// event_source.register_listener(&listener, vec![VBoxEventType::Any], false).unwrap()
pub fn register_listener(
&self,
event_listener: &EventListener,
event_types: Vec<VBoxEventType>,
active: bool,
) -> Result<(), VboxError> {
let mut event_types_ptr_vec: Vec<u32> = Vec::new();
for event_type in event_types {
event_types_ptr_vec.push(event_type.into());
}
let event_listener_ptr = event_listener.object;
let active = if active { 1 } else { 0 };
let event_types_ptr = event_types_ptr_vec.as_mut_ptr();
let event_types_count: u32 = event_types_ptr_vec.len() as u32;
get_function_result_unit!(
self.object,
RegisterListener,
event_listener_ptr,
event_types_count,
event_types_ptr,
active
)
}
/// Creates a new listener object, useful for passive mode.
///
/// # Arguments
///
/// * `event_listener` - [`EventListener`] to unregister.
///
/// # Returns
///
/// Returns Ok(()) on success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
/// use virtualbox_rs::enums::VBoxEventType;
///
/// let vbox = VirtualBox::init().unwrap();
/// let event_source = vbox.get_event_source().unwrap();
/// let listener = event_source.create_listener().unwrap();
/// event_source.register_listener(&listener, vec![VBoxEventType::Any], false).unwrap();
/// event_source.unregister_listener(&listener).unwrap();
pub fn unregister_listener(&self, event_listener: &EventListener) -> Result<(), VboxError> {
let event_listener_ptr = event_listener.object;
get_function_result_unit!(self.object, UnregisterListener, event_listener_ptr)
}
/// Creates a new listener object, useful for passive mode.
///
/// # Arguments
///
/// * `event_listener` - [`EventListener`] to unregister.
///
/// # Returns
///
/// Returns Ok(()) on success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
///
/// let vbox = VirtualBox::init().unwrap();
/// let event_source = vbox.get_event_source().unwrap();
/// let listener = event_source.create_listener().unwrap();
/// let event = event_source.get_event(&listener, 20).unwrap();
pub fn get_event(
&self,
event_listener: &EventListener,
timeout: i32,
) -> Result<Event, VboxError> {
let event_listener_ptr = event_listener.object;
let event = get_function_result_pointer!(
self.object,
GetEvent,
*mut IEvent,
event_listener_ptr,
timeout
)?;
Ok(Event::new(event))
}
/// Creates a new listener object, useful for passive mode.
///
/// # Arguments
///
/// * `event_listener` - [`EventListener`] to unregister.
///
/// # Returns
///
/// Returns Ok(()) on success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::{Session, VirtualBox};
///
/// let vbox = VirtualBox::init().unwrap();
/// let event_source = vbox.get_event_source().unwrap();
/// let listener = event_source.create_listener().unwrap();
/// let event = event_source.get_event(&listener, 20).unwrap();
/// event_source.event_processed(&listener, &event).unwrap()
pub fn event_processed(
&self,
event_listener: &EventListener,
event: &Event,
) -> Result<(), VboxError> {
let event_listener_ptr = event_listener.object;
let event_ptr = event.object;
get_function_result_unit!(self.object, EventProcessed, event_listener_ptr, event_ptr)
}
}