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
//! A state distribution channel.  The internal state can be borrowed or cloned, but receivers do not observe every value.
//!  
//! When the channel is created, the receiver will immediately observe `T::default()`.  Cloned receivers will immediately observe the latest stored value.
//!
//! Senders can mutably borrow the contained value (which notifies receivers on release).  Receivers can immutably borrow the contained value.

use super::SendSyncMessage;
use std::{
    fmt,
    ops::{Deref, DerefMut},
    sync::atomic::{AtomicUsize, Ordering},
};

use parking_lot::{RwLock, RwLockReadGuard, RwLockWriteGuard};
use static_assertions::{assert_impl_all, assert_not_impl_all};

use crate::{
    sink::{PollSend, Sink},
    stream::{PollRecv, Stream},
    sync::{shared, ReceiverShared, SenderShared},
};

/// Constructs a new watch channel pair, filled with `T::default()`.
pub fn channel<T: Clone + Default>() -> (Sender<T>, Receiver<T>) {
    channel_with(T::default())
}

/// Constructs a new watch channel pair, filled with the provided value
pub fn channel_with<T: Clone>(value: T) -> (Sender<T>, Receiver<T>) {
    #[cfg(feature = "debug")]
    log::error!("Creating watch channel");

    let (tx_shared, rx_shared) = shared(StateExtension::new(value));
    let sender = Sender { shared: tx_shared };

    let receiver = Receiver {
        shared: rx_shared,
        generation: AtomicUsize::new(0),
    };

    (sender, receiver)
}

/// Constructs a pair of channel endpoints that store Option<T>
///
/// This is helpful if T does not implement Default, and you don't have an initial value.
pub fn channel_with_option<T: Clone>() -> (Sender<Option<T>>, Receiver<Option<T>>) {
    channel::<Option<T>>()
}

/// The sender half of a watch channel.  The stored value can be updated with the postage::Sink trait.
pub struct Sender<T> {
    pub(in crate::channels::watch) shared: SenderShared<StateExtension<T>>,
}

assert_impl_all!(Sender<SendSyncMessage>: Send, Sync, fmt::Debug);
assert_not_impl_all!(Sender<SendSyncMessage>: Clone);

impl<T> Sink for Sender<T> {
    type Item = T;

    fn poll_send(
        self: std::pin::Pin<&mut Self>,
        _cx: &mut crate::Context<'_>,
        value: Self::Item,
    ) -> PollSend<Self::Item> {
        if self.shared.is_closed() {
            return PollSend::Rejected(value);
        }

        self.shared.extension().push(value);
        self.shared.notify_receivers();

        PollSend::Ready
    }
}

#[allow(clippy::needless_lifetimes)]
impl<T> Sender<T> {
    /// Mutably borrows the contained value, blocking the channel while the borrow is held.
    ///
    /// After the borrow is released, receivers will be notified of a new value.
    pub fn borrow_mut<'s>(&'s mut self) -> RefMut<'s, T> {
        let extension = self.shared.extension();
        let lock = extension.value.write();

        RefMut {
            lock,
            shared: self.shared.clone(),
        }
    }

    /// Creates a new Receiver that listens to this channel.
    pub fn subscribe(&mut self) -> Receiver<T> {
        Receiver {
            shared: self.shared.clone_receiver(),
            generation: AtomicUsize::new(0),
        }
    }

    /// Immutably borrows the contained value, blocking the channel while the borrow is held.
    pub fn borrow<'s>(&'s mut self) -> Ref<'s, T> {
        let extension = self.shared.extension();
        let lock = extension.value.read();

        Ref { lock }
    }
}

impl<T> fmt::Debug for Sender<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Sender").finish()
    }
}

#[cfg(feature = "futures-traits")]
mod impl_futures {
    use std::task::Poll;

    use crate::sink::SendError;

    impl<T> futures::sink::Sink<T> for super::Sender<T> {
        type Error = SendError<T>;

        fn poll_ready(
            self: std::pin::Pin<&mut Self>,
            _cx: &mut std::task::Context<'_>,
        ) -> Poll<Result<(), Self::Error>> {
            Poll::Ready(Ok(()))
        }

        fn start_send(self: std::pin::Pin<&mut Self>, item: T) -> Result<(), Self::Error> {
            if self.shared.is_closed() {
                return Err(SendError(item));
            }

            self.shared.extension().push(item);
            self.shared.notify_receivers();

            Ok(())
        }

        fn poll_flush(
            self: std::pin::Pin<&mut Self>,
            _cx: &mut std::task::Context<'_>,
        ) -> Poll<Result<(), Self::Error>> {
            Poll::Ready(Ok(()))
        }

        fn poll_close(
            self: std::pin::Pin<&mut Self>,
            _cx: &mut std::task::Context<'_>,
        ) -> Poll<Result<(), Self::Error>> {
            Poll::Ready(Ok(()))
        }
    }
}

/// The receiver half of a watch channel.  Can recieve state updates with the postage::Sink trait.
///
/// The reciever will be woken when new values arive, but is not guaranteed to recieve every message.
pub struct Receiver<T> {
    pub(in crate::channels::watch) shared: ReceiverShared<StateExtension<T>>,
    pub(in crate::channels::watch) generation: AtomicUsize,
}

assert_impl_all!(Receiver<SendSyncMessage>: Clone, Send, Sync, fmt::Debug);

impl<T> Stream for Receiver<T>
where
    T: Clone,
{
    type Item = T;

    fn poll_recv(
        self: std::pin::Pin<&mut Self>,
        cx: &mut crate::Context<'_>,
    ) -> PollRecv<Self::Item> {
        loop {
            let guard = self.shared.send_guard();

            match self.try_recv_internal() {
                TryRecv::Pending => {
                    if self.shared.is_closed() {
                        return PollRecv::Closed;
                    }

                    self.shared.subscribe_send(cx);

                    if guard.is_expired() {
                        continue;
                    }

                    return PollRecv::Pending;
                }
                TryRecv::Ready(v) => return PollRecv::Ready(v),
            }
        }
    }
}

impl<T> Receiver<T>
where
    T: Clone,
{
    fn try_recv_internal(&self) -> TryRecv<T> {
        let state = self.shared.extension();
        if self.generation.load(std::sync::atomic::Ordering::SeqCst)
            > state.generation(Ordering::SeqCst)
        {
            return TryRecv::Pending;
        }

        let borrow = self.shared.extension().value.read();
        let stored_generation = self.shared.extension().generation(Ordering::SeqCst);
        self.generation
            .store(stored_generation + 1, Ordering::Release);
        TryRecv::Ready(borrow.clone())
    }
}

enum TryRecv<T> {
    Pending,
    Ready(T),
}

impl<T> Clone for Receiver<T> {
    fn clone(&self) -> Self {
        Self {
            shared: self.shared.clone(),
            generation: AtomicUsize::new(0),
        }
    }
}

impl<T> fmt::Debug for Receiver<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Receiver").finish()
    }
}

/// A mutable reference to the value contained in the channel.
/// Receivers are notified when the borrow is released.
pub struct RefMut<'t, T> {
    lock: RwLockWriteGuard<'t, T>,
    shared: SenderShared<StateExtension<T>>,
}

impl<'t, T> DerefMut for RefMut<'t, T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut *self.lock
    }
}

impl<'t, T> Deref for RefMut<'t, T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &*self.lock
    }
}

impl<'t, T> Drop for RefMut<'t, T> {
    fn drop(&mut self) {
        self.shared.extension().increment();
        self.shared.notify_receivers();
    }
}

/// An immutable reference to the value contained in the channel.
pub struct Ref<'t, T> {
    lock: RwLockReadGuard<'t, T>,
}

impl<'t, T> Deref for Ref<'t, T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &*self.lock
    }
}

impl<T> Receiver<T> {
    /// Borrows the value in the channel, blocking the channel while the value is held.
    pub fn borrow(&self) -> Ref<'_, T> {
        let lock = self.shared.extension().value.read();
        Ref { lock }
    }
}

struct StateExtension<T> {
    generation: AtomicUsize,
    value: RwLock<T>,
}

impl<T> StateExtension<T> {
    pub fn new(value: T) -> Self {
        Self {
            generation: AtomicUsize::new(0),
            value: RwLock::new(value),
        }
    }

    pub fn push(&self, value: T) {
        let mut lock = self.value.write();
        *lock = value;

        self.generation.fetch_add(1, Ordering::SeqCst);
        drop(lock);
    }

    pub fn increment(&self) {
        self.generation.fetch_add(1, Ordering::SeqCst);
    }

    pub fn generation(&self, ordering: Ordering) -> usize {
        self.generation.load(ordering)
    }
}

#[cfg(test)]
mod tests {
    use std::{pin::Pin, task::Context};

    use super::channel;
    use crate::{
        sink::{PollSend, Sink},
        stream::{PollRecv, Stream},
        test::{noop_context, panic_context},
    };
    use futures_test::task::new_count_waker;

    #[derive(Clone, Debug, PartialEq, Eq)]
    struct State(usize);

    impl Default for State {
        fn default() -> Self {
            State(0)
        }
    }

    #[test]
    fn send_accepted() {
        let mut cx = noop_context();
        let (mut tx, _rx) = channel();

        assert_eq!(
            PollSend::Ready,
            Pin::new(&mut tx).poll_send(&mut cx, State(1))
        );
        assert_eq!(
            PollSend::Ready,
            Pin::new(&mut tx).poll_send(&mut cx, State(2))
        );
    }

    #[test]
    fn send_recv() {
        let mut cx = noop_context();
        let (mut tx, mut rx) = channel();

        assert_eq!(
            PollSend::Ready,
            Pin::new(&mut tx).poll_send(&mut cx, State(1))
        );

        assert_eq!(
            PollRecv::Ready(State(1)),
            Pin::new(&mut rx).poll_recv(&mut cx)
        );
        assert_eq!(PollRecv::Pending, Pin::new(&mut rx).poll_recv(&mut cx));
    }

    #[test]
    fn recv_default() {
        let mut cx = panic_context();
        let (_tx, mut rx) = channel();

        assert_eq!(
            PollRecv::Ready(State(0)),
            Pin::new(&mut rx).poll_recv(&mut cx)
        );
        assert_eq!(
            PollRecv::Pending,
            Pin::new(&mut rx).poll_recv(&mut noop_context())
        );
    }

    #[test]
    fn borrow_default() {
        let (_tx, rx) = channel();

        assert_eq!(&State(0), &*rx.borrow());
    }

    #[test]
    fn borrow_sent() {
        let mut cx = panic_context();
        let (mut tx, rx) = channel();

        assert_eq!(
            PollSend::Ready,
            Pin::new(&mut tx).poll_send(&mut cx, State(1))
        );

        assert_eq!(&State(1), &*rx.borrow());
    }

    #[test]
    fn borrow_mut_notifies() {
        let mut cx = noop_context();
        let (mut tx, mut rx) = channel();

        assert_eq!(
            PollRecv::Ready(State(0)),
            Pin::new(&mut rx).poll_recv(&mut cx)
        );

        let (w1, w1_count) = new_count_waker();
        let w1_context = Context::from_waker(&w1);
        assert_eq!(
            PollRecv::Pending,
            Pin::new(&mut rx).poll_recv(&mut w1_context.into())
        );

        *tx.borrow_mut() = State(1);
        assert_eq!(1, w1_count.get());
        assert_eq!(&State(1), &*rx.borrow());

        assert_eq!(
            PollRecv::Ready(State(1)),
            Pin::new(&mut rx).poll_recv(&mut cx)
        );
    }

    #[test]
    fn sender_disconnect() {
        let mut cx = noop_context();
        let (mut tx, mut rx) = channel();
        let mut rx2 = rx.clone();

        assert_eq!(
            PollSend::Ready,
            Pin::new(&mut tx).poll_send(&mut cx, State(1))
        );

        drop(tx);

        assert_eq!(
            PollRecv::Ready(State(1)),
            Pin::new(&mut rx).poll_recv(&mut cx)
        );

        assert_eq!(PollRecv::Closed, Pin::new(&mut rx).poll_recv(&mut cx));

        assert_eq!(
            PollRecv::Ready(State(1)),
            Pin::new(&mut rx2).poll_recv(&mut cx)
        );

        assert_eq!(PollRecv::Closed, Pin::new(&mut rx2).poll_recv(&mut cx));
    }

    #[test]
    fn receiver_disconnect() {
        let mut cx = noop_context();
        let (mut tx, rx) = channel();

        drop(rx);

        assert_eq!(
            PollSend::Rejected(State(1)),
            Pin::new(&mut tx).poll_send(&mut cx, State(1))
        );
    }

    #[test]
    fn send_then_receiver_disconnect() {
        let mut cx = noop_context();
        let (mut tx, rx) = channel();

        assert_eq!(
            PollSend::Ready,
            Pin::new(&mut tx).poll_send(&mut cx, State(1))
        );

        drop(rx);

        assert_eq!(
            PollSend::Rejected(State(2)),
            Pin::new(&mut tx).poll_send(&mut cx, State(2))
        );
    }

    #[test]
    fn wake_receiver() {
        let mut cx = panic_context();
        let (mut tx, mut rx) = channel();

        let (w1, w1_count) = new_count_waker();
        let w1_context = Context::from_waker(&w1);

        assert_eq!(
            PollRecv::Ready(State(0)),
            Pin::new(&mut rx).poll_recv(&mut cx)
        );
        assert_eq!(
            PollRecv::Pending,
            Pin::new(&mut rx).poll_recv(&mut w1_context.into())
        );

        assert_eq!(0, w1_count.get());

        assert_eq!(
            PollSend::Ready,
            Pin::new(&mut tx).poll_send(&mut cx, State(1))
        );

        assert_eq!(1, w1_count.get());

        assert_eq!(
            PollSend::Ready,
            Pin::new(&mut tx).poll_send(&mut cx, State(2))
        );

        assert_eq!(1, w1_count.get());
    }

    #[test]
    fn wake_receiver_on_disconnect() {
        let (tx, mut rx) = channel::<State>();

        let (w1, w1_count) = new_count_waker();
        let w1_context = Context::from_waker(&w1);

        assert_eq!(
            PollRecv::Ready(State(0)),
            Pin::new(&mut rx).poll_recv(&mut panic_context())
        );
        assert_eq!(
            PollRecv::Pending,
            Pin::new(&mut rx).poll_recv(&mut w1_context.into())
        );

        assert_eq!(0, w1_count.get());

        drop(tx);

        assert_eq!(1, w1_count.get());
    }

    #[async_std::test]
    async fn subscribe_default() {
        let mut cx = panic_context();
        let (mut tx, _rx) = channel();
        let mut rx2 = tx.subscribe();

        assert_eq!(
            PollRecv::Ready(State(0)),
            Pin::new(&mut rx2).poll_recv(&mut cx)
        );
        assert_eq!(
            PollRecv::Pending,
            Pin::new(&mut rx2).poll_recv(&mut noop_context())
        );
    }

    #[async_std::test]
    async fn subscribe_both_receive_value() {
        let mut cx = panic_context();
        let (mut tx, mut rx) = channel();
        let mut rx2 = tx.subscribe();

        assert_eq!(
            PollRecv::Ready(State(0)),
            Pin::new(&mut rx).poll_recv(&mut cx)
        );
        assert_eq!(
            PollRecv::Pending,
            Pin::new(&mut rx).poll_recv(&mut noop_context())
        );

        assert_eq!(
            PollRecv::Ready(State(0)),
            Pin::new(&mut rx2).poll_recv(&mut cx)
        );
        assert_eq!(
            PollRecv::Pending,
            Pin::new(&mut rx2).poll_recv(&mut noop_context())
        );
    }
}

#[cfg(test)]
mod tokio_tests {
    use tokio::{spawn, time::timeout};

    use crate::{
        sink::Sink,
        stream::Stream,
        test::{Channel, Channels, Message, CHANNEL_TEST_RECEIVERS, TEST_TIMEOUT},
    };

    #[tokio::test]
    async fn simple() {
        let (mut tx, mut rx) = super::channel();

        tokio::task::spawn(async move {
            let mut iter = Message::new_iter(0);
            // skip state 0
            iter.next();
            for message in iter {
                tx.send(message).await.expect("send failed");
            }
        });

        timeout(TEST_TIMEOUT, async move {
            let mut channel = Channel::new(0).allow_skips();
            while let Some(message) = rx.recv().await {
                channel.assert_message(&message);
            }
        })
        .await
        .expect("test timeout");
    }

    #[tokio::test]
    async fn send_borrow_mut() {
        let (mut tx, mut rx) = super::channel();

        tokio::task::spawn(async move {
            let mut iter = Message::new_iter(0);
            // skip state 0
            iter.next();
            for message in iter {
                *tx.borrow_mut() = message;
            }
        });

        timeout(TEST_TIMEOUT, async move {
            let mut channel = Channel::new(0).allow_skips();
            while let Some(message) = rx.recv().await {
                channel.assert_message(&message);
            }
        })
        .await
        .expect("test timeout");
    }

    #[tokio::test]
    async fn multi_receiver() {
        let (mut tx, rx) = super::channel();

        tokio::task::spawn(async move {
            let mut iter = Message::new_iter(0);
            // skip state 0
            iter.next();
            for message in iter {
                tx.send(message).await.expect("send failed");
            }
        });

        let handles = (0..CHANNEL_TEST_RECEIVERS).map(move |_| {
            let mut rx2 = rx.clone();
            let mut channels = Channels::new(CHANNEL_TEST_RECEIVERS).allow_skips();

            spawn(async move {
                while let Some(message) = rx2.recv().await {
                    channels.assert_message(&message);
                }
            })
        });

        timeout(TEST_TIMEOUT, async move {
            for handle in handles {
                handle.await.expect("join failed");
            }
        })
        .await
        .expect("test timeout");
    }
}

#[cfg(test)]
mod async_std_tests {

    use async_std::{future::timeout, task::spawn};

    use crate::{
        sink::Sink,
        stream::Stream,
        test::{Channel, Channels, Message, CHANNEL_TEST_RECEIVERS, TEST_TIMEOUT},
    };

    #[async_std::test]
    async fn simple() {
        let (mut tx, mut rx) = super::channel();

        spawn(async move {
            let mut iter = Message::new_iter(0);
            // skip state 0
            iter.next();
            for message in iter {
                tx.send(message).await.expect("send failed");
            }
        });

        timeout(TEST_TIMEOUT, async move {
            let mut channel = Channel::new(0).allow_skips();
            while let Some(message) = rx.recv().await {
                channel.assert_message(&message);
            }
        })
        .await
        .expect("test timeout");
    }

    #[async_std::test]
    async fn send_borrow_mut() {
        let (mut tx, mut rx) = super::channel();

        spawn(async move {
            let mut iter = Message::new_iter(0);
            // skip state 0
            iter.next();
            for message in iter {
                *tx.borrow_mut() = message;
            }
        });

        timeout(TEST_TIMEOUT, async move {
            let mut channel = Channel::new(0).allow_skips();
            while let Some(message) = rx.recv().await {
                channel.assert_message(&message);
            }
        })
        .await
        .expect("test timeout");
    }

    #[tokio::test]
    async fn multi_receiver() {
        let (mut tx, rx) = super::channel();

        tokio::task::spawn(async move {
            let mut iter = Message::new_iter(0);
            // skip state 0
            iter.next();
            for message in iter {
                tx.send(message).await.expect("send failed");
            }
        });

        let handles = (0..CHANNEL_TEST_RECEIVERS).map(move |_| {
            let mut rx2 = rx.clone();
            let mut channels = Channels::new(CHANNEL_TEST_RECEIVERS).allow_skips();

            spawn(async move {
                while let Some(message) = rx2.recv().await {
                    channels.assert_message(&message);
                }
            })
        });

        timeout(TEST_TIMEOUT, async move {
            for handle in handles {
                handle.await;
            }
        })
        .await
        .expect("test timeout");
    }
}