futuresdr 0.7.0

An Experimental Async SDR Runtime for Heterogeneous Architectures.
Documentation 
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

use std::pin::Pin;
use std::task;
use std::task::Poll;

use crate::runtime::Error;
use crate::runtime::Result;
use crate::runtime::TerminatedFlowgraph;
use crate::runtime::channel::oneshot;

/// Completion future for a started [`Flowgraph`](crate::runtime::Flowgraph).
///
/// A `FlowgraphTask` can be awaited to retrieve the terminated flowgraph after
/// runtime execution completes. The runtime supervisor runs independently, so
/// dropping this completion handle leaves the flowgraph running in the background.
/// Keep and await this task when shutdown ordering or the final flowgraph state
/// matters.
pub struct FlowgraphTask {
    completion: oneshot::Receiver<Result<TerminatedFlowgraph, Error>>,
}

impl FlowgraphTask {
    pub(crate) fn new(completion: oneshot::Receiver<Result<TerminatedFlowgraph, Error>>) -> Self {
        Self { completion }
    }
}

impl std::future::Future for FlowgraphTask {
    type Output = Result<TerminatedFlowgraph, Error>;

    fn poll(mut self: Pin<&mut Self>, cx: &mut task::Context<'_>) -> Poll<Self::Output> {
        match Pin::new(&mut self.completion).poll(cx) {
            Poll::Pending => Poll::Pending,
            Poll::Ready(output) => Poll::Ready(output.unwrap_or_else(|_| {
                Err(Error::RuntimeError(
                    "flowgraph supervisor canceled".to_string(),
                ))
            })),
        }
    }
}