mpstthree 0.1.17

A library implementing Multiparty Session Types for 2 or more participants
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
41
42
43
44
45
46
47

//! This module contains the macros
//! for creating cancellation functions for any number
//! of participants.
//!
//! *This module is available only if MultiCrusty is built with
//! the `"macros_multiple"` feature.*

/// Creates a function that will cancel a session and send a `Cancel` signal to the broadcasting
/// role.
///
/// # Arguments
///
/// * The name of the new function type
/// * The name of the role that will send the `Cancel` signal
/// * The *MeshedChannels* type that will be used
/// * The number of participants (all together)
/// * The message that will be displayed
///
/// *This macro is available only if MultiCrusty is built with
/// the `"macros_multiple"` feature.*
#[macro_export]
#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
macro_rules! send_cancel {
    ($func_name:ident, $name:ident, $meshedchannels_name:ident, $n_sessions:literal, $msg:expr) => {
        mpst_seq_proc::send_cancel!($func_name, $name, $meshedchannels_name, $n_sessions, $msg);
    };
}

/// Indefinitely loops to check all sessions if there
/// is a `Cancel` signal and broadcast if it present.
/// Will also close correctly if a `Stop` signal
/// is received.
///
/// # Arguments
///
/// * The session that will be used
/// * The number of participants (all together)
///
/// *This macro is available only if MultiCrusty is built with
/// the `"macros_multiple"` feature.*
#[macro_export]
#[cfg_attr(doc_cfg, doc(cfg(feature = "macros_multiple")))]
macro_rules! broadcast_cancel {
    ($session:expr, $n_sessions:literal) => {
        mpst_seq_proc::broadcast_cancel!($session, $n_sessions);
    };
}