hyperion-framework 0.5.0

A lightweight component-based TCP framework for building service-oriented Rust applications with CLI control, async messaging, and lifecycle management.
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
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

// -------------------------------------------------------------------------------------------------
// Hyperion Framework
// https://github.com/robert-hannah/hyperion-framework
//
// A lightweight component-based TCP framework for building service-oriented Rust applications with
// CLI control, async messaging, and lifecycle management.
//
// Copyright 2025 Robert Hannah
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// -------------------------------------------------------------------------------------------------

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, PartialEq)]
pub enum HeartbeatMode {
    Sender,
    Receiver,
    Disabled,
}

#[derive(Debug, Clone)]
pub struct HeartbeatSenderConfig {
    pub interval_ms: u64,
    pub response_timeout_ms: u64,
    pub targets: Vec<String>,
}

#[derive(Debug, Clone)]
pub struct HeartbeatReceiverConfig {
    /// How long to wait without receiving a request before triggering the timeout handler.
    pub timeout_ms: u64,
}

#[derive(Debug, Clone)]
pub struct HeartbeatConfig {
    pub mode: HeartbeatMode,
    pub sender: Option<HeartbeatSenderConfig>,
    pub receiver: Option<HeartbeatReceiverConfig>,
}

impl HeartbeatConfig {
    pub fn sender(interval_ms: u64, response_timeout_ms: u64, targets: Vec<String>) -> Self {
        Self {
            mode: HeartbeatMode::Sender,
            sender: Some(HeartbeatSenderConfig {
                interval_ms,
                response_timeout_ms,
                targets,
            }),
            receiver: None,
        }
    }

    pub fn receiver(timeout_ms: u64) -> Self {
        Self {
            mode: HeartbeatMode::Receiver,
            sender: None,
            receiver: Some(HeartbeatReceiverConfig { timeout_ms }),
        }
    }

    pub fn disabled() -> Self {
        Self {
            mode: HeartbeatMode::Disabled,
            sender: None,
            receiver: None,
        }
    }
}

/// Deserializable form of heartbeat configuration as it appears in a component's
/// `configuration.xml` under the `<container>` section.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HeartbeatXml {
    pub mode: String,
    #[serde(default)]
    pub interval_ms: Option<u64>,
    #[serde(default)]
    pub response_timeout_ms: Option<u64>,
    #[serde(default)]
    pub targets: Option<HeartbeatTargets>,
    #[serde(default)]
    pub timeout_ms: Option<u64>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HeartbeatTargets {
    #[serde(rename = "target")]
    pub targets: Vec<String>,
}

impl HeartbeatXml {
    pub fn to_config(&self) -> Option<HeartbeatConfig> {
        match self.mode.as_str() {
            "sender" => {
                let interval_ms = self.interval_ms.unwrap_or_else(|| {
                    panic!("Heartbeat mode is 'sender' but interval_ms is missing")
                });
                let response_timeout_ms = self.response_timeout_ms.unwrap_or_else(|| {
                    panic!("Heartbeat mode is 'sender' but response_timeout_ms is missing")
                });
                let targets = self
                    .targets
                    .as_ref()
                    .map(|t| t.targets.clone())
                    .unwrap_or_default();
                Some(HeartbeatConfig::sender(
                    interval_ms,
                    response_timeout_ms,
                    targets,
                ))
            }
            "receiver" => {
                let timeout_ms = self.timeout_ms.unwrap_or_else(|| {
                    panic!("Heartbeat mode is 'receiver' but timeout_ms is missing")
                });
                Some(HeartbeatConfig::receiver(timeout_ms))
            }
            "disabled" => None,
            unknown => panic!(
                "Unknown heartbeat mode: '{unknown}'. Expected 'sender', 'receiver', or 'disabled'"
            ),
        }
    }
}