Macros to make working with FutureSDR a bit nicer.
Avoid boilerplate when setting up the flowgraph. This macro simplifies adding blocks to the flowgraph and connecting them.
Assume you have created a flowgraph fg and several blocks (src, shift, ...) and need to add the block to the flowgraph and connect them. Using the connect! macro, this can be done with:
rust
connect!(fg,
src.out > shift.in;
shift > resamp1 > demod;
demod > resamp2 > snk;
);
It generates the following code:
``rust
// Add all the blocks to theFlowgraph`...
let src = fg.addblock(src);
let shift = fg.addblock(shift);
let resamp1 = fg.addblock(resamp1);
let demod = fg.addblock(demod);
let resamp2 = fg.addblock(resamp2);
let snk = fg.addblock(snk);
// ... and connect the ports appropriately fg.connectstream(src, "out", shift, "in")?; fg.connectstream(shift, "out", resamp1, "in")?; fg.connectstream(resamp1, "out", demod, "in")?; fg.connectstream(demod, "out", resamp2, "in")?; fg.connect_stream(resamp2, "out", snk, "in")?; ```
Connections endpoints are defined by block.port_name. Standard names (i.e.,
out/in) can be omitted. When ports have different name than standard in
and out, one can use following notation.
Stream connections are indicated as >, while message connections are indicated as |.
It is possible to add blocks that have no connections by just putting them on a line separately.
rust
connect!(fg, dummy);
Port names with spaces have to be quoted.
ignore
connect!(fg,
src."out port" > snk
);
Avoid boilerplate when creating message handlers.
Assume a block with a message handler that refers to a block function
Self::my_handler.
ignore
pub fn new() -> Block {
Block::new(
BlockMetaBuilder::new("MyBlock").build(),
StreamIoBuilder::new().build(),
MessageIoBuilder::new()
.add_input("handler", Self::my_handler)
.build(),
Self,
)
}
The underlying machinery of the handler implementation is rather involved.
With the message_handler macro, it can be simplified to:
```ignore
async fn my_handler(
&mut self,
_mio: &mut MessageIo