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 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
use crate::countedindex::Index; use crate::multiqueue::{ futures_multiqueue, FutInnerRecv, FutInnerSend, FutInnerUniRecv, InnerRecv, InnerSend, MultiQueue, MPMC, }; use crate::wait::Wait; use std::sync::mpsc::{RecvError, SendError, TryRecvError, TrySendError}; extern crate futures; use self::futures::{Async, Poll, Sink, StartSend, Stream}; /// This class is the sending half of the mpmc ```MultiQueue```. It supports both /// single and multi consumer modes with competitive performance in each case. /// It only supports nonblocking writes (the futures sender being an exception) /// as well as being the conduit for adding new writers. /// /// # Examples /// /// ``` /// use std::thread; /// /// let (send, recv) = multiqueue2::mpmc_queue(4); /// /// let mut handles = vec![]; /// /// for i in 0..2 { // or n /// let consumer = recv.clone(); /// handles.push(thread::spawn(move || { /// for val in consumer { /// println!("Consumer {} got {}", i, val); /// } /// })); /// } /// /// // Take notice that I drop the reader - this removes it from /// // the queue, meaning that the readers in the new threads /// // won't get starved by the lack of progress from recv /// recv.unsubscribe(); /// /// for i in 0..10 { /// // Don't do this busy loop in real stuff unless you're really sure /// loop { /// if send.try_send(i).is_ok() { /// break; /// } /// } /// } /// drop(send); /// /// for t in handles { /// t.join(); /// } /// // prints along the lines of /// // Consumer 1 got 2 /// // Consumer 0 got 0 /// // Consumer 0 got 1 /// // etc /// ``` #[derive(Clone)] pub struct MPMCSender<T> { sender: InnerSend<MPMC<T>, T>, } /// This is the receiving end of a standard mpmc view of the queue /// It functions similarly to the ```BroadcastReceiver``` execpt there /// is only ever one stream. As a result, the type doesn't need to be clone #[derive(Debug)] pub struct MPMCReceiver<T> { receiver: InnerRecv<MPMC<T>, T>, } impl<T> Clone for MPMCReceiver<T> { fn clone(&self) -> Self { MPMCReceiver { receiver: self.receiver.clone(), } } } /// This is the receiving end of a standard mpmc view of the queue /// for when it's statically know that there is only one receiver. /// It functions similarly to the ```BroadcastUniReceiver``` execpt there /// is only ever one stream. As a result, the type doesn't need to be clone or sync pub struct MPMCUniReceiver<T> { receiver: InnerRecv<MPMC<T>, T>, } /// This is the futures-compatible version of ```MPMCSender``` /// It implements Sink pub struct MPMCFutSender<T> { sender: FutInnerSend<MPMC<T>, T>, } /// This is the futures-compatible version of ```MPMCReceiver``` /// It implements Stream pub struct MPMCFutReceiver<T> { receiver: FutInnerRecv<MPMC<T>, T>, } /// This is the futures-compatible version of ```MPMCUniReceiver``` /// It implements ```Stream``` and behaves like the iterator would. /// To use a different function must transform itself into a different /// UniRecveiver use ```transform_operation``` pub struct MPMCFutUniReceiver<R, F: FnMut(&T) -> R, T> { receiver: FutInnerUniRecv<MPMC<T>, R, F, T>, } impl<T> MPMCSender<T> { /// Tries to send a value into the queue /// If there is no space, returns ```Err(TrySendError::Full(val))``` /// If there are no readers, returns ```Err(TrySendError::Disconnected(val))``` pub fn try_send(&self, val: T) -> Result<(), TrySendError<T>> { self.sender.try_send(val) } /// Removes this writer from the queue pub fn unsubscribe(self) { self.sender.unsubscribe() } } impl<T> MPMCReceiver<T> { /// Tries to receive a value from the queue without blocking. /// /// # Examples: /// /// ``` /// use multiqueue2::mpmc_queue; /// let (w, r) = mpmc_queue(10); /// w.try_send(1).unwrap(); /// assert_eq!(1, r.try_recv().unwrap()); /// ``` /// /// ``` /// use multiqueue2::mpmc_queue; /// use std::thread; /// /// let (send, recv) = mpmc_queue(10); /// /// let handle = thread::spawn(move || { /// for _ in 0..10 { /// loop { /// match recv.try_recv() { /// Ok(val) => { /// println!("Got {}", val); /// break; /// }, /// Err(_) => (), /// } /// } /// } /// assert!(recv.try_recv().is_err()); // recv would block here /// }); /// /// for i in 0..10 { /// send.try_send(i).unwrap(); /// } /// /// // Drop the sender to close the queue /// drop(send); /// /// handle.join(); /// ``` #[inline(always)] pub fn try_recv(&self) -> Result<T, TryRecvError> { self.receiver.try_recv() } /// Receives a value from the queue, blocks until there is data. /// /// # Examples: /// /// ``` /// use multiqueue2::mpmc_queue; /// let (w, r) = mpmc_queue(10); /// w.try_send(1).unwrap(); /// assert_eq!(1, r.recv().unwrap()); /// ``` /// /// ``` /// use multiqueue2::mpmc_queue; /// use std::thread; /// /// let (send, recv) = mpmc_queue(10); /// /// let handle = thread::spawn(move || { /// // note the lack of dealing with failed reads. /// // unwrap 'ignores' the error where sender disconnects /// for _ in 0..10 { /// println!("Got {}", recv.recv().unwrap()); /// } /// assert!(recv.try_recv().is_err()); /// }); /// /// for i in 0..10 { /// send.try_send(i).unwrap(); /// } /// /// // Drop the sender to close the queue /// drop(send); /// /// handle.join(); /// ``` #[inline(always)] pub fn recv(&self) -> Result<T, RecvError> { self.receiver.recv() } /// Removes the given reader from the queue subscription lib /// Returns true if this is the last reader in a given broadcast unit /// /// # Examples /// /// ``` /// use multiqueue2::mpmc_queue; /// let (writer, reader) = mpmc_queue(2); /// writer.try_send(1).expect("This will succeed since queue is empty"); /// reader.try_recv().expect("This reader can read"); /// reader.unsubscribe(); /// // Fails since there's no readers left /// assert!(writer.try_send(1).is_err()); /// ``` pub fn unsubscribe(self) -> bool { self.receiver.unsubscribe() } /// If there is only one ```MPMCReceiver``` on the stream, converts the /// Receiver into a ```MPMCUniReceiver``` otherwise returns the ```MPMCReceiver```. /// /// # Example: /// /// ``` /// use multiqueue2::mpmc_queue; /// /// let (w, r) = mpmc_queue(10); /// w.try_send(1).unwrap(); /// let r2 = r.clone(); /// // Fails since there's two receivers on the stream /// assert!(r2.into_single().is_err()); /// let single_r = r.into_single().unwrap(); /// let val = match single_r.try_recv_view(|x| 2 * *x) { /// Ok(val) => val, /// Err(_) => panic!("Queue should have an element"), /// }; /// assert_eq!(2, val); /// ``` pub fn into_single(self) -> Result<MPMCUniReceiver<T>, MPMCReceiver<T>> { if self.receiver.is_single() { Ok(MPMCUniReceiver { receiver: self.receiver, }) } else { Err(self) } } /// Returns a non-owning iterator that iterates over the queue /// until it fails to receive an item, either through being empty /// or begin disconnected. This iterator will never block. /// /// # Examples: /// /// ``` /// use multiqueue2::mpmc_queue; /// let (w, r) = mpmc_queue(2); /// for _ in 0 .. 3 { /// w.try_send(1).unwrap(); /// w.try_send(2).unwrap(); /// for val in r.try_iter().zip(1..2) { /// assert_eq!(val.0, val.1); /// } /// } /// ``` pub fn try_iter(&self) -> MPMCRefIter<'_, T> { MPMCRefIter { recv: self } } } impl<T> MPMCUniReceiver<T> { /// Identical to ```MPMCReceiver::try_recv``` pub fn try_recv(&self) -> Result<T, TryRecvError> { self.receiver.try_recv() } /// Identical to ```MPMCReceiver::recv``` pub fn recv(&self) -> Result<T, RecvError> { self.receiver.recv() } /// Applies the passed function to the value in the queue without copying it out /// If there is no data in the queue or the writers have disconnected, /// returns an ```Err((F, TryRecvError))``` /// /// # Example /// ``` /// use multiqueue2::mpmc_queue; /// /// let (w, r) = mpmc_queue(10); /// let single_r = r.into_single().unwrap(); /// for i in 0..5 { /// w.try_send(i).unwrap(); /// } /// /// for i in 0..5 { /// let val = match single_r.try_recv_view(|x| 1 + *x) { /// Ok(val) => val, /// Err(_) => panic!("Queue shouldn't be disconncted or empty"), /// }; /// assert_eq!(i + 1, val); /// } /// assert!(single_r.try_recv_view(|x| *x).is_err()); /// drop(w); /// assert!(single_r.try_recv_view(|x| *x).is_err()); /// ``` #[inline(always)] pub fn try_recv_view<R, F: FnOnce(&T) -> R>(&self, op: F) -> Result<R, (F, TryRecvError)> { self.receiver.try_recv_view(op) } /// Applies the passed function to the value in the queue without copying it out /// If there is no data in the queue, blocks until an item is pushed into the queue /// or all writers disconnect /// /// # Example /// ``` /// use multiqueue2::mpmc_queue; /// /// let (w, r) = mpmc_queue(10); /// let single_r = r.into_single().unwrap(); /// for i in 0..5 { /// w.try_send(i).unwrap(); /// } /// /// for i in 0..5 { /// let val = match single_r.recv_view(|x| 1 + *x) { /// Ok(val) => val, /// Err(_) => panic!("Queue shouldn't be disconncted or empty"), /// }; /// assert_eq!(i + 1, val); /// } /// drop(w); /// assert!(single_r.recv_view(|x| *x).is_err()); /// ``` pub fn recv_view<R, F: FnOnce(&T) -> R>(&self, op: F) -> Result<R, (F, RecvError)> { self.receiver.recv_view(op) } /// Removes the given reader from the queue subscription lib /// Returns true if this is the last reader in a given broadcast unit /// /// # Examples /// /// ``` /// use multiqueue2::mpmc_queue; /// let (writer, reader) = mpmc_queue(2); /// writer.try_send(1).expect("This will succeed since queue is empty"); /// reader.try_recv().expect("This reader can read"); /// reader.unsubscribe(); /// // Fails since there's no readers left /// assert!(writer.try_send(1).is_err()); /// ``` pub fn unsubscribe(self) -> bool { self.receiver.unsubscribe() } /// Transforms the ```MPMCUniReceiver``` into a ```MPMCReceiver``` /// /// # Example /// /// ``` /// use multiqueue2::mpmc_queue; /// /// let (w, r) = mpmc_queue(10); /// w.try_send(1).unwrap(); /// let single_r = r.into_single().unwrap(); /// let normal_r = single_r.into_multi(); /// normal_r.clone(); /// ``` pub fn into_multi(self) -> MPMCReceiver<T> { MPMCReceiver { receiver: self.receiver, } } /// Returns a non-owning iterator that iterates over the queue /// until it fails to receive an item, either through being empty /// or begin disconnected. This iterator will never block. /// /// # Examples: /// /// ``` /// use multiqueue2::mpmc_queue; /// let (w, r) = mpmc_queue(2); /// let sr = r.into_single().unwrap(); /// w.try_send(1).unwrap(); /// w.try_send(2).unwrap(); /// w.unsubscribe(); /// for val in sr.iter_with(|x| 2 * *x).zip(1..2) { /// assert_eq!(val.0, val.1 * 2); /// } /// ``` pub fn iter_with<R, F: FnMut(&T) -> R>(self, op: F) -> MPMCUniIter<R, F, T> { MPMCUniIter { recv: self, op } } /// Returns a non-owning iterator that iterates over the queue /// until it fails to receive an item, either through being empty /// or begin disconnected. This iterator will never block. /// /// # Examples: /// /// ``` /// use multiqueue2::mpmc_queue; /// let (w, r) = mpmc_queue(2); /// let sr = r.into_single().unwrap(); /// for _ in 0 .. 3 { /// w.try_send(1).unwrap(); /// w.try_send(2).unwrap(); /// for val in sr.try_iter_with(|x| 2 * *x).zip(1..2) { /// assert_eq!(val.0, val.1*2); /// } /// } /// ``` pub fn try_iter_with<R, F: FnMut(&T) -> R>(&self, op: F) -> MPMCUniRefIter<R, F, T> { MPMCUniRefIter { recv: self, op } } } impl<T> MPMCFutSender<T> { /// Equivalent to ```MPMCSender::try_send``` #[inline(always)] pub fn try_send(&self, val: T) -> Result<(), TrySendError<T>> { self.sender.try_send(val) } /// Equivalent to ```MPMCSender::unsubscribe``` pub fn unsubscribe(self) { self.sender.unsubscribe() } } impl<T> MPMCFutReceiver<T> { /// Equivalent to ```MPMCReceiver::try_recv``` #[inline(always)] pub fn try_recv(&self) -> Result<T, TryRecvError> { self.receiver.try_recv() } /// Equivalent to ```MPMCReceiver::recv``` #[inline(always)] pub fn recv(&self) -> Result<T, RecvError> { self.receiver.recv() } /// Identical to ```MPMCReceiver::unsubscribe``` pub fn unsubscribe(self) -> bool { self.receiver.unsubscribe() } /// Analog of ```MPMCReceiver::into_single``` /// Since the ```FutUniReceiver``` acts more like an iterator, /// this takes the operation to be applied to each value pub fn into_single<R, F: FnMut(&T) -> R>( self, op: F, ) -> Result<MPMCFutUniReceiver<R, F, T>, (F, MPMCFutReceiver<T>)> { match self.receiver.into_single(op) { Ok(sreceiver) => Ok(MPMCFutUniReceiver { receiver: sreceiver, }), Err((o, receiver)) => Err((o, MPMCFutReceiver { receiver })), } } } impl<R, F: FnMut(&T) -> R, T> MPMCFutUniReceiver<R, F, T> { /// Equivalent to ```MPMCReceiver::try_recv``` using the held operation #[inline(always)] pub fn try_recv(&mut self) -> Result<R, TryRecvError> { self.receiver.try_recv() } /// Equivalent to ```MPMCReceiver::recv``` using the held operation #[inline(always)] pub fn recv(&mut self) -> Result<R, RecvError> { self.receiver.recv() } /// Adds a stream with the specified method pub fn add_stream_with<RQ, FQ: FnMut(&T) -> RQ>( &self, op: FQ, ) -> MPMCFutUniReceiver<RQ, FQ, T> { MPMCFutUniReceiver { receiver: self.receiver.add_stream_with(op), } } /// Returns a new receiver on the same stream using a different method pub fn transform_operation<RQ, FQ: FnMut(&T) -> RQ>( self, op: FQ, ) -> MPMCFutUniReceiver<RQ, FQ, T> { MPMCFutUniReceiver { receiver: self.receiver.add_stream_with(op), } } /// Identical to ```MPMCReceiver::unsubscribe``` pub fn unsubscribe(self) -> bool { self.receiver.unsubscribe() } /// Transforms this back into ```MPMCFutReceiver```, returning the new receiver pub fn into_multi(self) -> MPMCFutReceiver<T> { MPMCFutReceiver { receiver: self.receiver.into_multi(), } } } impl<T> Clone for MPMCFutSender<T> { fn clone(&self) -> Self { MPMCFutSender { sender: self.sender.clone(), } } } impl<T> Sink for &MPMCFutSender<T> { type SinkItem = T; type SinkError = SendError<T>; #[inline(always)] fn start_send(&mut self, msg: T) -> StartSend<T, SendError<T>> { (&self.sender).start_send(msg) } #[inline(always)] fn poll_complete(&mut self) -> Poll<(), SendError<T>> { Ok(Async::Ready(())) } } impl<T> Sink for MPMCFutSender<T> { type SinkItem = T; type SinkError = SendError<T>; #[inline(always)] fn start_send(&mut self, msg: T) -> StartSend<T, SendError<T>> { (&*self).start_send(msg) } #[inline(always)] fn poll_complete(&mut self) -> Poll<(), SendError<T>> { (&*self).poll_complete() } } impl<T> Clone for MPMCFutReceiver<T> { fn clone(&self) -> Self { MPMCFutReceiver { receiver: self.receiver.clone(), } } } impl<T> Stream for &MPMCFutReceiver<T> { type Item = T; type Error = (); #[inline(always)] fn poll(&mut self) -> Poll<Option<T>, ()> { (&self.receiver).poll() } } impl<T> Stream for MPMCFutReceiver<T> { type Item = T; type Error = (); #[inline(always)] fn poll(&mut self) -> Poll<Option<T>, ()> { (&*self).poll() } } impl<R, F: FnMut(&T) -> R, T> Stream for MPMCFutUniReceiver<R, F, T> { type Item = R; type Error = (); #[inline(always)] fn poll(&mut self) -> Poll<Option<R>, ()> { self.receiver.poll() } } pub struct MPMCIter<T> { recv: MPMCReceiver<T>, } impl<T> Iterator for MPMCIter<T> { type Item = T; #[inline(always)] fn next(&mut self) -> Option<T> { match self.recv.recv() { Ok(val) => Some(val), Err(_) => None, } } } impl<T> IntoIterator for MPMCReceiver<T> { type Item = T; type IntoIter = MPMCIter<T>; fn into_iter(self) -> MPMCIter<T> { MPMCIter { recv: self } } } pub struct MPSCIter<T> { recv: MPMCUniReceiver<T>, } impl<T> Iterator for MPSCIter<T> { type Item = T; #[inline(always)] fn next(&mut self) -> Option<T> { match self.recv.recv() { Ok(val) => Some(val), Err(_) => None, } } } impl<T> IntoIterator for MPMCUniReceiver<T> { type Item = T; type IntoIter = MPSCIter<T>; fn into_iter(self) -> MPSCIter<T> { MPSCIter { recv: self } } } pub struct MPMCRefIter<'a, T: 'a> { recv: &'a MPMCReceiver<T>, } impl<'a, T> Iterator for MPMCRefIter<'a, T> { type Item = T; #[inline(always)] fn next(&mut self) -> Option<T> { match self.recv.try_recv() { Ok(val) => Some(val), Err(_) => None, } } } impl<'a, T: 'a> IntoIterator for &'a MPMCReceiver<T> { type Item = T; type IntoIter = MPMCRefIter<'a, T>; fn into_iter(self) -> MPMCRefIter<'a, T> { MPMCRefIter { recv: self } } } pub struct MPSCRefIter<'a, T: 'a> { recv: &'a MPMCUniReceiver<T>, } impl<'a, T> Iterator for MPSCRefIter<'a, T> { type Item = T; #[inline(always)] fn next(&mut self) -> Option<T> { match self.recv.try_recv() { Ok(val) => Some(val), Err(_) => None, } } } impl<'a, T: 'a> IntoIterator for &'a MPMCUniReceiver<T> { type Item = T; type IntoIter = MPSCRefIter<'a, T>; fn into_iter(self) -> MPSCRefIter<'a, T> { MPSCRefIter { recv: self } } } pub struct MPMCUniIter<R, F: FnMut(&T) -> R, T> { recv: MPMCUniReceiver<T>, op: F, } impl<R, F: FnMut(&T) -> R, T> Iterator for MPMCUniIter<R, F, T> { type Item = R; #[inline(always)] fn next(&mut self) -> Option<R> { let opref = &mut self.op; match self.recv.recv_view(|v| opref(v)) { Ok(val) => Some(val), Err(_) => None, } } } pub struct MPMCUniRefIter<'a, R, F: FnMut(&T) -> R, T: 'a> { recv: &'a MPMCUniReceiver<T>, op: F, } impl<'a, R, F: FnMut(&T) -> R, T: 'a> Iterator for MPMCUniRefIter<'a, R, F, T> { type Item = R; #[inline(always)] fn next(&mut self) -> Option<R> { let opref = &mut self.op; match self.recv.try_recv_view(|v| opref(v)) { Ok(val) => Some(val), Err(_) => None, } } } /// Creates a (```MPMCSender```, ```MPMCReceiver```) pair with a capacity that's /// the next power of two >= the given capacity /// /// # Example /// ``` /// use multiqueue2::mpmc_queue; /// let (w, r) = mpmc_queue(10); /// w.try_send(10).unwrap(); /// assert_eq!(10, r.try_recv().unwrap()); /// ``` pub fn mpmc_queue<T>(capacity: Index) -> (MPMCSender<T>, MPMCReceiver<T>) { let (send, recv) = MultiQueue::<MPMC<T>, T>::create_tx_rx(capacity); (MPMCSender { sender: send }, MPMCReceiver { receiver: recv }) } pub fn mpmc_queue_with<T, W: Wait + 'static>( capacity: Index, w: W, ) -> (MPMCSender<T>, MPMCReceiver<T>) { let (send, recv) = MultiQueue::<MPMC<T>, T>::create_tx_rx_with(capacity, w); (MPMCSender { sender: send }, MPMCReceiver { receiver: recv }) } /// Futures variant of ```mpmc_queue``` - datastructures implement /// Sink + Stream at a minor (~30 ns) performance cost to ```BlockingWait``` pub fn mpmc_fut_queue<T>(capacity: Index) -> (MPMCFutSender<T>, MPMCFutReceiver<T>) { let (isend, irecv) = futures_multiqueue::<MPMC<T>, T>(capacity); ( MPMCFutSender { sender: isend }, MPMCFutReceiver { receiver: irecv }, ) } unsafe impl<T: Send> Send for MPMCSender<T> {} unsafe impl<T: Send> Send for MPMCReceiver<T> {} unsafe impl<T: Send> Send for MPMCUniReceiver<T> {} #[cfg(test)] mod test { use super::mpmc_queue; extern crate crossbeam; use self::crossbeam::scope; use std::sync::atomic::{AtomicUsize, Ordering}; use std::sync::mpsc::TryRecvError; use std::sync::{Arc, Barrier}; use std::thread::yield_now; #[test] fn build_queue() { let _ = mpmc_queue::<usize>(10); } #[test] fn push_pop_test() { let (writer, reader) = mpmc_queue(1); for _ in 0..100 { assert!(reader.try_recv().is_err()); writer.try_send(1 as usize).expect("Push should succeed"); assert!(writer.try_send(1).is_err()); assert_eq!(1, reader.try_recv().unwrap()); } } fn mpsc(senders: usize, receivers: usize) { let (writer, reader) = mpmc_queue(4); let sreader = reader.into_single().unwrap(); let myb = Barrier::new(receivers + senders); let bref = &myb; let num_loop = 100000; scope(|scope| { for q in 0..senders { let cur_writer = writer.clone(); scope.spawn(move |_| { bref.wait(); 'outer: for i in 0..num_loop { for _ in 0..100000000 { if cur_writer.try_send((q, i)).is_ok() { continue 'outer; } yield_now(); } assert!(false, "Writer could not write"); } }); } writer.unsubscribe(); scope.spawn(move |_| { let mut myv = Vec::new(); for _ in 0..senders { myv.push(0); } bref.wait(); for _ in 0..num_loop * senders { loop { if let Ok(val) = sreader.try_recv_view(|x| *x) { assert_eq!(myv[val.0], val.1); myv[val.0] += 1; break; } yield_now(); } } for val in myv { if val != num_loop { panic!("Wrong number of values obtained for this"); } } assert!(sreader.try_recv().is_err()); }); }) .unwrap(); } #[test] fn test_spsc() { mpsc(1, 1); } #[test] fn test_mpsc() { mpsc(2, 1); } fn mpmc(senders: usize, receivers: usize) { let (writer, reader) = mpmc_queue(10); let myb = Barrier::new(receivers + senders); let bref = &myb; let num_loop = 1000000; let counter = AtomicUsize::new(0); let cref = &counter; scope(|scope| { for _ in 0..senders { let cur_writer = writer.clone(); scope.spawn(move |_| { bref.wait(); 'outer: for _ in 0..num_loop { for _ in 0..100000000 { if cur_writer.try_send(1).is_ok() { continue 'outer; } yield_now(); } assert!(false, "Writer could not write"); } }); } writer.unsubscribe(); for _ in 0..receivers { let this_reader = reader.clone(); scope.spawn(move |_| { bref.wait(); loop { match this_reader.try_recv() { Ok(_) => { cref.fetch_add(1, Ordering::Relaxed); } Err(TryRecvError::Disconnected) => break, _ => yield_now(), } } }); } reader.unsubscribe(); }) .unwrap(); assert_eq!(senders * num_loop, counter.load(Ordering::SeqCst)); } #[test] fn test_spmc() { mpmc(1, 2); } #[test] fn test_mpmc() { mpmc(2, 2); } #[test] fn test_baddrop() { // This ensures that a bogus arc isn't dropped from the queue let (writer, reader) = mpmc_queue(1); for _ in 0..10 { writer.try_send(Arc::new(10)).unwrap(); reader.recv().unwrap(); } } struct Dropper<'a> { aref: &'a AtomicUsize, } impl<'a> Dropper<'a> { pub fn new(a: &AtomicUsize) -> Dropper { a.fetch_add(1, Ordering::Relaxed); Dropper { aref: a } } } impl<'a> Drop for Dropper<'a> { fn drop(&mut self) { self.aref.fetch_sub(1, Ordering::Relaxed); } } impl<'a> Clone for Dropper<'a> { fn clone(&self) -> Dropper<'a> { self.aref.fetch_add(1, Ordering::Relaxed); Dropper { aref: self.aref } } } #[test] fn test_gooddrop() { // This counts the # of drops and creations let count = AtomicUsize::new(0); { let (writer, reader) = mpmc_queue(1); for _ in 0..10 { writer.try_send(Dropper::new(&count)).unwrap(); reader.recv().unwrap(); } } assert_eq!(count.load(Ordering::Relaxed), 0); } #[test] fn test_iterator_comp() { let (writer, reader) = mpmc_queue::<usize>(10); drop(writer); for _ in reader {} } #[test] fn test_single_leave_multi() { let (writer, reader) = mpmc_queue::<usize>(10); let reader2 = reader.clone(); writer.try_send(1).unwrap(); writer.try_send(1).unwrap(); assert_eq!(reader2.recv().unwrap(), 1); drop(reader2); let reader_s = reader.into_single().unwrap(); assert!(reader_s.recv_view(|x| *x).is_ok()); } #[test] fn test_recv_clone_item_noclone() { struct NoClone; let (_, _reader) = mpmc_queue::<NoClone>(10); // reader.clone(); } }