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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
use crate::Result;
use crate::entity::Entity;
use crate::internal::ffi;
/// A manually triggered condition for use with a [`WaitSet`](crate::WaitSet).
///
/// A `GuardCondition` allows application code to unblock a waiting
/// [`WaitSet`](crate::WaitSet) from another thread or in response to an
/// external event. Set it to `true` to trigger attached waitsets and `false`
/// to reset it.
#[derive(Debug)]
pub struct GuardCondition<'owner> {
pub(crate) inner: cyclonedds_sys::dds_entity_t,
phantom: std::marker::PhantomData<&'owner dyn Entity>,
}
impl<'o> GuardCondition<'o> {
/// Creates a new `GuardCondition` owned by `owner`.
///
/// The guard condition is valid for the lifetime of `owner`.
///
/// # Errors
///
/// Returns an [`Error`](crate::Error) if the guard condition fails to
/// create.
///
/// # Examples
///
/// ```
/// # use cyclonedds::{Domain, Participant};
/// # let domain = Domain::default();
/// # let participant = Participant::new(&domain)?;
/// use cyclonedds::GuardCondition;
///
/// let guard_condition = GuardCondition::new(&participant)?;
/// # Ok::<_, cyclonedds::Error>(())
/// ```
pub fn new(owner: &'o dyn Entity) -> Result<Self> {
let owner = owner.id().inner;
let inner = ffi::dds_create_guardcondition(owner)?;
Ok(Self {
inner,
phantom: std::marker::PhantomData,
})
}
/// Sets the triggered state of this guard condition.
///
/// Setting to `true` unblocks any [`WaitSet`](crate::WaitSet) this
/// condition is attached to. Setting to `false` resets it.
///
/// # Errors
///
/// Returns an [`Error`](crate::Error) if the condition failed to set.
///
/// # Examples
///
/// ```
/// # use cyclonedds::{Domain, Participant};
/// # let domain = Domain::default();
/// # let participant = Participant::new(&domain)?;
/// use cyclonedds::GuardCondition;
///
/// let mut guard_condition = GuardCondition::new(&participant)?;
/// guard_condition.set(true)?;
/// # Ok::<_, cyclonedds::Error>(())
/// ```
pub fn set(&mut self, triggered: bool) -> Result<()> {
ffi::dds_set_guardcondition(self.inner, triggered)
}
/// Returns the current triggered state without clearing it.
///
/// Equivalent to [`read`](GuardCondition::read).
///
/// # Errors
///
/// Returns an [`Error`](crate::Error) if the condition failed to read.
///
/// # Examples
///
/// ```
/// # use cyclonedds::{Domain, Participant};
/// # let domain = Domain::default();
/// # let participant = Participant::new(&domain)?;
/// use cyclonedds::GuardCondition;
///
/// let mut guard = GuardCondition::new(&participant)?;
/// guard.set(true)?;
/// assert_eq!(guard.peek()?, true);
/// # Ok::<_, cyclonedds::Error>(())
/// ```
pub fn peek(&self) -> Result<bool> {
self.read()
}
/// Returns the current triggered state without clearing it.
///
/// # Errors
///
/// Returns an [`Error`](crate::Error) if the condition failed to read.
///
/// # Examples
///
/// ```
/// # use cyclonedds::{Domain, Participant};
/// # let domain = Domain::default();
/// # let participant = Participant::new(&domain)?;
/// use cyclonedds::GuardCondition;
///
/// let mut guard = GuardCondition::new(&participant)?;
/// guard.set(true)?;
/// assert_eq!(guard.read()?, true);
/// // State is preserved after read.
/// assert_eq!(guard.read()?, true);
/// # Ok::<_, cyclonedds::Error>(())
/// ```
pub fn read(&self) -> Result<bool> {
ffi::dds_read_guardcondition(self.inner)
}
/// Returns the current triggered state and clears it.
///
/// Unlike [`read`](GuardCondition::read), this resets the triggered state
/// to `false` after returning it.
///
/// # Errors
///
/// Returns an [`Error`](crate::Error) if the condition failed to take.
///
/// # Examples
///
/// ```
/// # use cyclonedds::{Domain, Participant};
/// # let domain = Domain::default();
/// # let participant = Participant::new(&domain)?;
/// use cyclonedds::GuardCondition;
///
/// let mut guard = GuardCondition::new(&participant)?;
/// guard.set(true)?;
/// assert_eq!(guard.take()?, true);
/// // State has been cleared.
/// assert_eq!(guard.read()?, false);
/// # Ok::<_, cyclonedds::Error>(())
/// ```
pub fn take(&mut self) -> Result<bool> {
ffi::dds_take_guardcondition(self.inner)
}
}
impl Drop for GuardCondition<'_> {
fn drop(&mut self) {
let result = ffi::dds_delete(self.inner);
debug_assert!(
result.is_ok(),
"unable to delete {self:?}: failed with {result:?}"
);
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_guard_condition_create() {
let domain_id = crate::tests::domain::unique_id();
let domain = crate::Domain::new(domain_id).unwrap();
let participant = crate::Participant::new(&domain).unwrap();
let _ = GuardCondition::new(&participant).unwrap();
}
#[test]
fn test_guard_condition_with_invalid_participant() {
let domain_id = crate::tests::domain::unique_id();
let domain = crate::Domain::new(domain_id).unwrap();
let mut participant = crate::Participant::new(&domain).unwrap();
let participant_id = participant.inner;
participant.inner = 0;
let result = GuardCondition::new(&participant).unwrap_err();
participant.inner = participant_id;
assert_eq!(result, crate::Error::BadParameter);
}
#[test]
fn test_guard_condition_set() {
let domain_id = crate::tests::domain::unique_id();
let domain = crate::Domain::new(domain_id).unwrap();
let participant = crate::Participant::new(&domain).unwrap();
let mut guard_condition = GuardCondition::new(&participant).unwrap();
guard_condition.set(true).unwrap();
guard_condition.set(false).unwrap();
}
#[test]
fn test_guard_condition_peek() {
let domain_id = crate::tests::domain::unique_id();
let domain = crate::Domain::new(domain_id).unwrap();
let participant = crate::Participant::new(&domain).unwrap();
let mut guard_condition = GuardCondition::new(&participant).unwrap();
guard_condition.set(true).unwrap();
let triggered = guard_condition.peek().unwrap();
assert!(triggered);
let triggered = guard_condition.peek().unwrap();
assert!(triggered);
guard_condition.set(false).unwrap();
let triggered = guard_condition.peek().unwrap();
assert!(!triggered);
let triggered = guard_condition.peek().unwrap();
assert!(!triggered);
}
#[test]
fn test_guard_condition_read() {
let domain_id = crate::tests::domain::unique_id();
let domain = crate::Domain::new(domain_id).unwrap();
let participant = crate::Participant::new(&domain).unwrap();
let mut guard_condition = GuardCondition::new(&participant).unwrap();
guard_condition.set(true).unwrap();
let triggered = guard_condition.read().unwrap();
assert!(triggered);
let triggered = guard_condition.read().unwrap();
assert!(triggered);
guard_condition.set(false).unwrap();
let triggered = guard_condition.read().unwrap();
assert!(!triggered);
let triggered = guard_condition.read().unwrap();
assert!(!triggered);
}
#[test]
fn test_guard_condition_take() {
let domain_id = crate::tests::domain::unique_id();
let domain = crate::Domain::new(domain_id).unwrap();
let participant = crate::Participant::new(&domain).unwrap();
let mut guard_condition = GuardCondition::new(&participant).unwrap();
guard_condition.set(true).unwrap();
let triggered = guard_condition.take().unwrap();
assert!(triggered);
let triggered = guard_condition.take().unwrap();
assert!(!triggered);
guard_condition.set(false).unwrap();
let triggered = guard_condition.take().unwrap();
assert!(!triggered);
let triggered = guard_condition.take().unwrap();
assert!(!triggered);
}
#[test]
fn test_guard_condition_operations_on_invalid_guard_condition() {
let domain_id = crate::tests::domain::unique_id();
let domain = crate::Domain::new(domain_id).unwrap();
let participant = crate::Participant::new(&domain).unwrap();
let mut guard_condition = GuardCondition::new(&participant).unwrap();
let guard_condition_id = guard_condition.inner;
guard_condition.inner = 0;
let result = guard_condition.set(false).unwrap_err();
assert_eq!(result, crate::Error::BadParameter);
let result = guard_condition.read().unwrap_err();
assert_eq!(result, crate::Error::BadParameter);
let result = guard_condition.take().unwrap_err();
assert_eq!(result, crate::Error::BadParameter);
guard_condition.inner = guard_condition_id;
}
}