xan-actor 10.1.0

Akka actor
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
48
49
50
51
52
53
54
55
56
57

//! Cross-process delivery layer (`multi-node` feature).
//!
//! Adds:
//! - structural [`Address`] routing (`name` + `node`) so calls automatically
//!   pick local vs. cross-node delivery,
//! - per-node xanq `Anycast` request/response [`Topic`]s with envelope
//!   matching by `req_id`,
//! - an inventory-based decoder registry populated by the
//!   `register_for_inter_node!` macro,
//! - [`NodeFilter`] / [`BroadcastResult`] for fan-out across selected peers.
//!
//! Requires a xanq broker; pass `broker_addr = Some(...)` to
//! `ActorSystem::new`. The [`InterNodeRuntime`] is built and the consumer
//! tasks are spawned automatically.

pub mod address;
pub mod decoder;
pub mod dispatcher;
pub mod envelope;

pub use address::{Address, BroadcastResult, NodeFilter};
pub use decoder::{
    ActorTypeFn, DecodeMessageFn, EncodeResultFn, InterNodeDecoder, decode_codec,
    decode_message_for, encode_codec, encode_result_for, type_name_of,
};
pub use dispatcher::{DEFAULT_BROKER_CONNECT_TIMEOUT, InterNodeRuntime};
pub use envelope::{InterNodeMessage, InterNodeResponse, ResponseOutcome, Topic, TopicKind};

/// Register an `Actor`'s message and result types so that this node can
/// participate in inter-node delivery for `$actor`.
///
/// Call once per actor type at module level.
///
/// ```ignore
/// xan_actor::register_for_inter_node!(MyActor);
/// ```
#[macro_export]
macro_rules! register_for_inter_node {
    ($actor:ty) => {
        $crate::inter_node::__private_inventory::submit! {
            $crate::inter_node::InterNodeDecoder {
                actor_type: $crate::inter_node::type_name_of::<$actor>,
                decode_message: $crate::inter_node::decode_codec::<
                    <$actor as $crate::actor::Actor>::Message,
                >,
                encode_result: $crate::inter_node::encode_codec::<
                    <$actor as $crate::actor::Actor>::Result,
                >,
            }
        }
    };
}

#[doc(hidden)]
pub mod __private_inventory {
    pub use inventory::submit;
}