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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
// Take a look at the license at the top of the repository in the LICENSE file.
use std::{
collections::VecDeque,
fmt, mem, ptr,
sync::{mpsc, Arc, Condvar, Mutex},
};
use crate::{
thread_guard::ThreadGuard, translate::*, ControlFlow, MainContext, Priority, Source, SourceId,
};
enum ChannelSourceState {
NotAttached,
Attached(*mut ffi::GSource),
Destroyed,
}
unsafe impl Send for ChannelSourceState {}
unsafe impl Sync for ChannelSourceState {}
struct ChannelInner<T> {
queue: VecDeque<T>,
source: ChannelSourceState,
num_senders: usize,
}
impl<T> ChannelInner<T> {
fn receiver_disconnected(&self) -> bool {
match self.source {
ChannelSourceState::Destroyed => true,
// Receiver exists but is already destroyed
ChannelSourceState::Attached(source)
if unsafe { ffi::g_source_is_destroyed(source) } != ffi::GFALSE =>
{
true
}
// Not attached yet so the Receiver still exists
ChannelSourceState::NotAttached => false,
// Receiver still running
ChannelSourceState::Attached(_) => false,
}
}
#[doc(alias = "g_source_set_ready_time")]
fn set_ready_time(&mut self, ready_time: i64) {
if let ChannelSourceState::Attached(source) = self.source {
unsafe {
ffi::g_source_set_ready_time(source, ready_time);
}
}
}
}
struct ChannelBound {
bound: usize,
cond: Condvar,
}
struct Channel<T>(Arc<(Mutex<ChannelInner<T>>, Option<ChannelBound>)>);
impl<T> Clone for Channel<T> {
fn clone(&self) -> Channel<T> {
Channel(self.0.clone())
}
}
impl<T> Channel<T> {
fn new(bound: Option<usize>) -> Channel<T> {
Channel(Arc::new((
Mutex::new(ChannelInner {
queue: VecDeque::new(),
source: ChannelSourceState::NotAttached,
num_senders: 0,
}),
bound.map(|bound| ChannelBound {
bound,
cond: Condvar::new(),
}),
)))
}
fn send(&self, t: T) -> Result<(), mpsc::SendError<T>> {
let mut inner = (self.0).0.lock().unwrap();
// If we have a bounded channel then we need to wait here until enough free space is
// available or the receiver disappears
//
// A special case here is a bound of 0: the queue must be empty for accepting
// new data and then we will again wait later for the data to be actually taken
// out
if let Some(ChannelBound { bound, ref cond }) = (self.0).1 {
while inner.queue.len() >= bound
&& !inner.queue.is_empty()
&& !inner.receiver_disconnected()
{
inner = cond.wait(inner).unwrap();
}
}
// Error out directly if the receiver is disconnected
if inner.receiver_disconnected() {
return Err(mpsc::SendError(t));
}
// Store the item on our queue
inner.queue.push_back(t);
// and then wake up the GSource
inner.set_ready_time(0);
// If we have a bound of 0 we need to wait until the receiver actually
// handled the data
if let Some(ChannelBound { bound: 0, ref cond }) = (self.0).1 {
while !inner.queue.is_empty() && !inner.receiver_disconnected() {
inner = cond.wait(inner).unwrap();
}
// If the receiver was destroyed in the meantime take out the item and report an error
if inner.receiver_disconnected() {
// If the item is not in the queue anymore then the receiver just handled it before
// getting disconnected and all is good
if let Some(t) = inner.queue.pop_front() {
return Err(mpsc::SendError(t));
}
}
}
Ok(())
}
fn try_send(&self, t: T) -> Result<(), mpsc::TrySendError<T>> {
let mut inner = (self.0).0.lock().unwrap();
let ChannelBound { bound, ref cond } = (self.0)
.1
.as_ref()
.expect("called try_send() on an unbounded channel");
// Check if the queue is full and handle the special case of a 0 bound
if inner.queue.len() >= *bound && !inner.queue.is_empty() {
return Err(mpsc::TrySendError::Full(t));
}
// Error out directly if the receiver is disconnected
if inner.receiver_disconnected() {
return Err(mpsc::TrySendError::Disconnected(t));
}
// Store the item on our queue
inner.queue.push_back(t);
// and then wake up the GSource
inner.set_ready_time(0);
// If we have a bound of 0 we need to wait until the receiver actually
// handled the data
if *bound == 0 {
while !inner.queue.is_empty() && !inner.receiver_disconnected() {
inner = cond.wait(inner).unwrap();
}
// If the receiver was destroyed in the meantime take out the item and report an error
if inner.receiver_disconnected() {
// If the item is not in the queue anymore then the receiver just handled it before
// getting disconnected and all is good
if let Some(t) = inner.queue.pop_front() {
return Err(mpsc::TrySendError::Disconnected(t));
}
}
}
Ok(())
}
// SAFETY: Must be called from the main context the channel was attached to.
unsafe fn try_recv(&self) -> Result<T, mpsc::TryRecvError> {
let mut inner = (self.0).0.lock().unwrap();
// Pop item if we have any
if let Some(item) = inner.queue.pop_front() {
// Wake up a sender that is currently waiting, if any
if let Some(ChannelBound { ref cond, .. }) = (self.0).1 {
cond.notify_one();
}
return Ok(item);
}
// If there are no senders left we are disconnected or otherwise empty. That's the case if
// the only remaining strong reference is the one of the receiver
if inner.num_senders == 0 {
Err(mpsc::TryRecvError::Disconnected)
} else {
Err(mpsc::TryRecvError::Empty)
}
}
}
#[repr(C)]
struct ChannelSource<T, F: FnMut(T) -> ControlFlow + 'static> {
source: ffi::GSource,
source_funcs: Box<ffi::GSourceFuncs>,
channel: Channel<T>,
callback: ThreadGuard<F>,
}
unsafe extern "C" fn dispatch<T, F: FnMut(T) -> ControlFlow + 'static>(
source: *mut ffi::GSource,
callback: ffi::GSourceFunc,
_user_data: ffi::gpointer,
) -> ffi::gboolean {
let source = &mut *(source as *mut ChannelSource<T, F>);
debug_assert!(callback.is_none());
// Set ready-time to -1 so that we won't get called again before a new item is added
// to the channel queue.
ffi::g_source_set_ready_time(&mut source.source, -1);
// Get a reference to the callback. This will panic if we're called from a different
// thread than where the source was attached to the main context.
let callback = source.callback.get_mut();
// Now iterate over all items that we currently have in the channel until it is
// empty again. If all senders are disconnected at some point we remove the GSource
// from the main context it was attached to as it will never ever be called again.
loop {
match source.channel.try_recv() {
Err(mpsc::TryRecvError::Empty) => break,
Err(mpsc::TryRecvError::Disconnected) => return ffi::G_SOURCE_REMOVE,
Ok(item) => {
if callback(item).is_break() {
return ffi::G_SOURCE_REMOVE;
}
}
}
}
ffi::G_SOURCE_CONTINUE
}
#[cfg(feature = "v2_64")]
unsafe extern "C" fn dispose<T, F: FnMut(T) -> ControlFlow + 'static>(source: *mut ffi::GSource) {
let source = &mut *(source as *mut ChannelSource<T, F>);
// Set the source inside the channel to None so that all senders know that there
// is no receiver left and wake up the condition variable if any
let mut inner = (source.channel.0).0.lock().unwrap();
inner.source = ChannelSourceState::Destroyed;
if let Some(ChannelBound { ref cond, .. }) = (source.channel.0).1 {
cond.notify_all();
}
}
unsafe extern "C" fn finalize<T, F: FnMut(T) -> ControlFlow + 'static>(source: *mut ffi::GSource) {
let source = &mut *(source as *mut ChannelSource<T, F>);
// Drop all memory we own by taking it out of the Options
#[cfg(not(feature = "v2_64"))]
{
// FIXME: This is the same as would otherwise be done in the dispose() function but
// unfortunately it doesn't exist in older version of GLib. Doing it only here can
// cause a channel sender to get a reference to the source with reference count 0
// if it happens just before the mutex is taken below.
//
// This is exactly the pattern why g_source_set_dispose_function() was added.
//
// Set the source inside the channel to None so that all senders know that there
// is no receiver left and wake up the condition variable if any
let mut inner = (source.channel.0).0.lock().unwrap();
inner.source = ChannelSourceState::Destroyed;
if let Some(ChannelBound { ref cond, .. }) = (source.channel.0).1 {
cond.notify_all();
}
}
ptr::drop_in_place(&mut source.channel);
ptr::drop_in_place(&mut source.source_funcs);
// Take the callback out of the source. This will panic if the value is dropped
// from a different thread than where the callback was created so try to drop it
// from the main context if we're on another thread and the main context still exists.
//
// This can only really happen if the caller to `attach()` gets the `Source` from the returned
// `SourceId` and sends it to another thread or otherwise retrieves it from the main context,
// but better safe than sorry.
if source.callback.is_owner() {
ptr::drop_in_place(&mut source.callback);
} else {
let callback = ptr::read(&source.callback);
let context =
ffi::g_source_get_context(source as *mut ChannelSource<T, F> as *mut ffi::GSource);
if !context.is_null() {
let context = MainContext::from_glib_none(context);
context.invoke(move || {
drop(callback);
});
}
}
}
// rustdoc-stripper-ignore-next
/// A `Sender` that can be used to send items to the corresponding main context receiver.
///
/// This `Sender` behaves the same as `std::sync::mpsc::Sender`.
///
/// See [`MainContext::channel()`] for how to create such a `Sender`.
///
/// [`MainContext::channel()`]: struct.MainContext.html#method.channel
pub struct Sender<T>(Channel<T>);
// It's safe to send the Sender to other threads for attaching it as
// long as the items to be sent can also be sent between threads.
unsafe impl<T: Send> Send for Sender<T> {}
impl<T> fmt::Debug for Sender<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("Sender").finish()
}
}
impl<T> Clone for Sender<T> {
fn clone(&self) -> Sender<T> {
Self::new(&self.0)
}
}
impl<T> Sender<T> {
fn new(channel: &Channel<T>) -> Self {
let mut inner = (channel.0).0.lock().unwrap();
inner.num_senders += 1;
Self(channel.clone())
}
// rustdoc-stripper-ignore-next
/// Sends a value to the channel.
pub fn send(&self, t: T) -> Result<(), mpsc::SendError<T>> {
self.0.send(t)
}
}
impl<T> Drop for Sender<T> {
fn drop(&mut self) {
// Decrease the number of senders and wake up the channel if this
// was the last sender that was dropped.
let mut inner = ((self.0).0).0.lock().unwrap();
inner.num_senders -= 1;
if inner.num_senders == 0 {
inner.set_ready_time(0);
}
}
}
// rustdoc-stripper-ignore-next
/// A `SyncSender` that can be used to send items to the corresponding main context receiver.
///
/// This `SyncSender` behaves the same as `std::sync::mpsc::SyncSender`.
///
/// See [`MainContext::sync_channel()`] for how to create such a `SyncSender`.
///
/// [`MainContext::sync_channel()`]: struct.MainContext.html#method.sync_channel
pub struct SyncSender<T>(Channel<T>);
// It's safe to send the SyncSender to other threads for attaching it as
// long as the items to be sent can also be sent between threads.
unsafe impl<T: Send> Send for SyncSender<T> {}
impl<T> fmt::Debug for SyncSender<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("SyncSender").finish()
}
}
impl<T> Clone for SyncSender<T> {
fn clone(&self) -> SyncSender<T> {
Self::new(&self.0)
}
}
impl<T> SyncSender<T> {
fn new(channel: &Channel<T>) -> Self {
let mut inner = (channel.0).0.lock().unwrap();
inner.num_senders += 1;
Self(channel.clone())
}
// rustdoc-stripper-ignore-next
/// Sends a value to the channel and blocks if the channel is full.
pub fn send(&self, t: T) -> Result<(), mpsc::SendError<T>> {
self.0.send(t)
}
// rustdoc-stripper-ignore-next
/// Sends a value to the channel.
pub fn try_send(&self, t: T) -> Result<(), mpsc::TrySendError<T>> {
self.0.try_send(t)
}
}
impl<T> Drop for SyncSender<T> {
fn drop(&mut self) {
// Decrease the number of senders and wake up the channel if this
// was the last sender that was dropped.
let mut inner = ((self.0).0).0.lock().unwrap();
inner.num_senders -= 1;
if inner.num_senders == 0 {
inner.set_ready_time(0);
}
}
}
// rustdoc-stripper-ignore-next
/// A `Receiver` that can be attached to a main context to receive items from its corresponding
/// `Sender` or `SyncSender`.
///
/// See [`MainContext::channel()`] or [`MainContext::sync_channel()`] for how to create
/// such a `Receiver`.
///
/// [`MainContext::channel()`]: struct.MainContext.html#method.channel
/// [`MainContext::sync_channel()`]: struct.MainContext.html#method.sync_channel
pub struct Receiver<T>(Option<Channel<T>>, Priority);
impl<T> fmt::Debug for Receiver<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("Receiver").finish()
}
}
// It's safe to send the Receiver to other threads for attaching it as
// long as the items to be sent can also be sent between threads.
unsafe impl<T: Send> Send for Receiver<T> {}
impl<T> Drop for Receiver<T> {
fn drop(&mut self) {
// If the receiver was never attached to a main context we need to let all the senders know
if let Some(channel) = self.0.take() {
let mut inner = (channel.0).0.lock().unwrap();
inner.source = ChannelSourceState::Destroyed;
if let Some(ChannelBound { ref cond, .. }) = (channel.0).1 {
cond.notify_all();
}
}
}
}
impl<T> Receiver<T> {
// rustdoc-stripper-ignore-next
/// Attaches the receiver to the given `context` and calls `func` whenever an item is
/// available on the channel.
///
/// Passing `None` for the context will attach it to the thread default main context.
///
/// # Panics
///
/// This function panics if called from a thread that is not the owner of the provided
/// `context`, or, if `None` is provided, of the thread default main context.
pub fn attach<F: FnMut(T) -> ControlFlow + 'static>(
mut self,
context: Option<&MainContext>,
func: F,
) -> SourceId {
unsafe {
let channel = self.0.take().expect("Receiver without channel");
let source_funcs = Box::new(ffi::GSourceFuncs {
check: None,
prepare: None,
dispatch: Some(dispatch::<T, F>),
finalize: Some(finalize::<T, F>),
closure_callback: None,
closure_marshal: None,
});
let source = ffi::g_source_new(
mut_override(&*source_funcs),
mem::size_of::<ChannelSource<T, F>>() as u32,
) as *mut ChannelSource<T, F>;
#[cfg(feature = "v2_64")]
{
ffi::g_source_set_dispose_function(
source as *mut ffi::GSource,
Some(dispose::<T, F>),
);
}
// Set up the GSource
{
let source = &mut *source;
let mut inner = (channel.0).0.lock().unwrap();
ffi::g_source_set_priority(mut_override(&source.source), self.1.into_glib());
// We're immediately ready if the queue is not empty or if no sender is left at this point
ffi::g_source_set_ready_time(
mut_override(&source.source),
if !inner.queue.is_empty() || inner.num_senders == 0 {
0
} else {
-1
},
);
inner.source = ChannelSourceState::Attached(&mut source.source);
}
// Store all our data inside our part of the GSource
{
let source = &mut *source;
ptr::write(ptr::addr_of_mut!(source.channel), channel);
ptr::write(ptr::addr_of_mut!(source.callback), ThreadGuard::new(func));
ptr::write(ptr::addr_of_mut!(source.source_funcs), source_funcs);
}
let source = Source::from_glib_full(mut_override(&(*source).source));
let context = match context {
Some(context) => context.clone(),
None => MainContext::ref_thread_default(),
};
let _acquire = context
.acquire()
.expect("main context already acquired by another thread");
source.attach(Some(&context))
}
}
}
impl MainContext {
// rustdoc-stripper-ignore-next
/// Creates a channel for a main context.
///
/// The `Receiver` has to be attached to a main context at a later time, together with a
/// closure that will be called for every item sent to a `Sender`.
///
/// The `Sender` can be cloned and both the `Sender` and `Receiver` can be sent to different
/// threads as long as the item type implements the `Send` trait.
///
/// When the last `Sender` is dropped the channel is removed from the main context. If the
/// `Receiver` is dropped and not attached to a main context all sending to the `Sender`
/// will fail.
///
/// The returned `Sender` behaves the same as `std::sync::mpsc::Sender`.
#[deprecated = "Use an async channel, from async-channel for example, on the main context using spawn_future_local() instead"]
pub fn channel<T>(priority: Priority) -> (Sender<T>, Receiver<T>) {
let channel = Channel::new(None);
let receiver = Receiver(Some(channel.clone()), priority);
let sender = Sender::new(&channel);
(sender, receiver)
}
// rustdoc-stripper-ignore-next
/// Creates a synchronous channel for a main context with a given bound on the capacity of the
/// channel.
///
/// The `Receiver` has to be attached to a main context at a later time, together with a
/// closure that will be called for every item sent to a `SyncSender`.
///
/// The `SyncSender` can be cloned and both the `SyncSender` and `Receiver` can be sent to different
/// threads as long as the item type implements the `Send` trait.
///
/// When the last `SyncSender` is dropped the channel is removed from the main context. If the
/// `Receiver` is dropped and not attached to a main context all sending to the `SyncSender`
/// will fail.
///
/// The returned `SyncSender` behaves the same as `std::sync::mpsc::SyncSender`.
#[deprecated = "Use an async channel, from async-channel for example, on the main context using spawn_future_local() instead"]
pub fn sync_channel<T>(priority: Priority, bound: usize) -> (SyncSender<T>, Receiver<T>) {
let channel = Channel::new(Some(bound));
let receiver = Receiver(Some(channel.clone()), priority);
let sender = SyncSender::new(&channel);
(sender, receiver)
}
}
#[cfg(test)]
#[allow(deprecated)]
mod tests {
use std::{
cell::RefCell,
rc::Rc,
sync::atomic::{AtomicBool, Ordering},
thread, time,
};
use super::*;
use crate::MainLoop;
#[test]
fn test_channel() {
let c = MainContext::new();
let l = MainLoop::new(Some(&c), false);
let _guard = c.acquire().unwrap();
let (sender, receiver) = MainContext::channel(Priority::default());
let sum = Rc::new(RefCell::new(0));
let sum_clone = sum.clone();
let l_clone = l.clone();
receiver.attach(Some(&c), move |item| {
*sum_clone.borrow_mut() += item;
if *sum_clone.borrow() == 6 {
l_clone.quit();
ControlFlow::Break
} else {
ControlFlow::Continue
}
});
sender.send(1).unwrap();
sender.send(2).unwrap();
sender.send(3).unwrap();
l.run();
assert_eq!(*sum.borrow(), 6);
}
#[test]
fn test_drop_sender() {
let c = MainContext::new();
let l = MainLoop::new(Some(&c), false);
let _guard = c.acquire().unwrap();
let (sender, receiver) = MainContext::channel::<i32>(Priority::default());
struct Helper(MainLoop);
impl Drop for Helper {
fn drop(&mut self) {
self.0.quit();
}
}
let helper = Helper(l.clone());
receiver.attach(Some(&c), move |_| {
let _helper = &helper;
ControlFlow::Continue
});
drop(sender);
l.run();
}
#[test]
fn test_drop_receiver() {
let (sender, receiver) = MainContext::channel::<i32>(Priority::default());
drop(receiver);
assert_eq!(sender.send(1), Err(mpsc::SendError(1)));
}
#[test]
fn test_remove_receiver() {
let c = MainContext::new();
let _guard = c.acquire().unwrap();
let (sender, receiver) = MainContext::channel::<i32>(Priority::default());
let source_id = receiver.attach(Some(&c), move |_| ControlFlow::Continue);
let source = c.find_source_by_id(&source_id).unwrap();
source.destroy();
assert_eq!(sender.send(1), Err(mpsc::SendError(1)));
}
#[test]
fn test_remove_receiver_and_drop_source() {
let c = MainContext::new();
let _guard = c.acquire().unwrap();
let (sender, receiver) = MainContext::channel::<i32>(Priority::default());
struct Helper(Arc<AtomicBool>);
impl Drop for Helper {
fn drop(&mut self) {
self.0.store(true, Ordering::Relaxed);
}
}
let dropped = Arc::new(AtomicBool::new(false));
let helper = Helper(dropped.clone());
let source_id = receiver.attach(Some(&c), move |_| {
let _helper = &helper;
ControlFlow::Continue
});
let source = c.find_source_by_id(&source_id).unwrap();
source.destroy();
// This should drop the closure
drop(source);
assert!(dropped.load(Ordering::Relaxed));
assert_eq!(sender.send(1), Err(mpsc::SendError(1)));
}
#[test]
fn test_sync_channel() {
let c = MainContext::new();
let l = MainLoop::new(Some(&c), false);
let _guard = c.acquire().unwrap();
let (sender, receiver) = MainContext::sync_channel(Priority::default(), 2);
let sum = Rc::new(RefCell::new(0));
let sum_clone = sum.clone();
let l_clone = l.clone();
receiver.attach(Some(&c), move |item| {
*sum_clone.borrow_mut() += item;
if *sum_clone.borrow() == 6 {
l_clone.quit();
ControlFlow::Break
} else {
ControlFlow::Continue
}
});
let (wait_sender, wait_receiver) = mpsc::channel();
let thread = thread::spawn(move || {
// The first two must succeed
sender.try_send(1).unwrap();
sender.try_send(2).unwrap();
// This fill up the channel
assert!(sender.try_send(3).is_err());
wait_sender.send(()).unwrap();
// This will block
sender.send(3).unwrap();
});
// Wait until the channel is full, and then another
// 50ms to make sure the sender is blocked now and
// can wake up properly once an item was consumed
assert!(wait_receiver.recv().is_ok());
thread::sleep(time::Duration::from_millis(50));
l.run();
thread.join().unwrap();
assert_eq!(*sum.borrow(), 6);
}
#[test]
fn test_sync_channel_drop_wakeup() {
let c = MainContext::new();
let l = MainLoop::new(Some(&c), false);
let _guard = c.acquire().unwrap();
let (sender, receiver) = MainContext::sync_channel(Priority::default(), 3);
let sum = Rc::new(RefCell::new(0));
let sum_clone = sum.clone();
let l_clone = l.clone();
receiver.attach(Some(&c), move |item| {
*sum_clone.borrow_mut() += item;
if *sum_clone.borrow() == 6 {
l_clone.quit();
ControlFlow::Break
} else {
ControlFlow::Continue
}
});
let (wait_sender, wait_receiver) = mpsc::channel();
let thread = thread::spawn(move || {
// The first three must succeed
sender.try_send(1).unwrap();
sender.try_send(2).unwrap();
sender.try_send(3).unwrap();
wait_sender.send(()).unwrap();
for i in 4.. {
// This will block at some point until the
// receiver is removed from the main context
if sender.send(i).is_err() {
break;
}
}
});
// Wait until the channel is full, and then another
// 50ms to make sure the sender is blocked now and
// can wake up properly once an item was consumed
assert!(wait_receiver.recv().is_ok());
thread::sleep(time::Duration::from_millis(50));
l.run();
thread.join().unwrap();
assert_eq!(*sum.borrow(), 6);
}
#[test]
fn test_sync_channel_drop_receiver_wakeup() {
let c = MainContext::new();
let _guard = c.acquire().unwrap();
let (sender, receiver) = MainContext::sync_channel(Priority::default(), 2);
let (wait_sender, wait_receiver) = mpsc::channel();
let thread = thread::spawn(move || {
// The first two must succeed
sender.try_send(1).unwrap();
sender.try_send(2).unwrap();
wait_sender.send(()).unwrap();
// This will block and then error out because the receiver is destroyed
assert!(sender.send(3).is_err());
});
// Wait until the channel is full, and then another
// 50ms to make sure the sender is blocked now and
// can wake up properly once an item was consumed
assert!(wait_receiver.recv().is_ok());
thread::sleep(time::Duration::from_millis(50));
drop(receiver);
thread.join().unwrap();
}
#[test]
fn test_sync_channel_rendezvous() {
let c = MainContext::new();
let l = MainLoop::new(Some(&c), false);
let _guard = c.acquire().unwrap();
let (sender, receiver) = MainContext::sync_channel(Priority::default(), 0);
let (wait_sender, wait_receiver) = mpsc::channel();
let thread = thread::spawn(move || {
wait_sender.send(()).unwrap();
sender.send(1).unwrap();
wait_sender.send(()).unwrap();
sender.send(2).unwrap();
wait_sender.send(()).unwrap();
sender.send(3).unwrap();
wait_sender.send(()).unwrap();
});
// Wait until the thread is started, then wait another 50ms and
// during that time it must not have proceeded yet to send the
// second item because we did not yet receive the first item.
assert!(wait_receiver.recv().is_ok());
assert_eq!(
wait_receiver.recv_timeout(time::Duration::from_millis(50)),
Err(mpsc::RecvTimeoutError::Timeout)
);
let sum = Rc::new(RefCell::new(0));
let sum_clone = sum.clone();
let l_clone = l.clone();
receiver.attach(Some(&c), move |item| {
// We consumed one item so there should be one item on
// the other receiver now.
assert!(wait_receiver.recv().is_ok());
*sum_clone.borrow_mut() += item;
if *sum_clone.borrow() == 6 {
// But as we didn't consume the next one yet, there must be no
// other item available yet
assert_eq!(
wait_receiver.recv_timeout(time::Duration::from_millis(50)),
Err(mpsc::RecvTimeoutError::Disconnected)
);
l_clone.quit();
ControlFlow::Break
} else {
// But as we didn't consume the next one yet, there must be no
// other item available yet
assert_eq!(
wait_receiver.recv_timeout(time::Duration::from_millis(50)),
Err(mpsc::RecvTimeoutError::Timeout)
);
ControlFlow::Continue
}
});
l.run();
thread.join().unwrap();
assert_eq!(*sum.borrow(), 6);
}
}