Skip to main content

protocol/
sockets.rs

1//! A server directory's socket file names: `<serverId>.sock` (the server's address clients connect to),
2//! `control-<serverId>.sock` (its coordinator's control socket) and `server-<serverId>-<nonce>.sock` (one
3//! generation's endpoint).
4
5use crate::message::is_server_id;
6
7const SUFFIX: &str = ".sock";
8const GENERATION_PREFIX: &str = "server-";
9/// The hex digits of a generation endpoint's nonce.
10pub const NONCE_LEN: usize = 12;
11/// The longest name a server directory holds: a generation endpoint's.
12pub const LONGEST_NAME: usize = GENERATION_PREFIX.len() + 36 + 1 + NONCE_LEN + SUFFIX.len();
13
14pub fn endpoint_name(server_id: &str) -> String {
15    format!("{server_id}{SUFFIX}")
16}
17
18pub fn control_name(server_id: &str) -> String {
19    format!("control-{server_id}{SUFFIX}")
20}
21
22pub fn generation_name(server_id: &str, nonce: &str) -> String {
23    format!("{GENERATION_PREFIX}{server_id}-{nonce}{SUFFIX}")
24}
25
26/// Whether `file_name` is a generation endpoint of `server_id`.
27pub fn is_generation_of(file_name: &str, server_id: &str) -> bool {
28    file_name
29        .strip_prefix(GENERATION_PREFIX)
30        .and_then(|rest| rest.strip_prefix(server_id))
31        .is_some_and(|rest| rest.starts_with('-') && rest.ends_with(SUFFIX))
32}
33
34/// The server ID an endpoint file name ([`endpoint_name`]) carries; None for any other name.
35pub fn server_id_of(file_name: &str) -> Option<&str> {
36    file_name.strip_suffix(SUFFIX).filter(|id| is_server_id(id))
37}
38
39#[cfg(test)]
40mod tests {
41    use super::*;
42
43    const ID: &str = "00000000-0000-4000-8000-000000000000";
44
45    #[test]
46    fn protocol_socket_names_round_trip() {
47        assert_eq!(server_id_of(&endpoint_name(ID)), Some(ID));
48        assert_eq!(server_id_of(&control_name(ID)), None);
49        assert_eq!(server_id_of("not-a-uuid.sock"), None);
50        let generation = generation_name(ID, "0123456789ab");
51        assert_eq!(generation.len(), LONGEST_NAME);
52        assert!(is_generation_of(&generation, ID));
53        assert!(!is_generation_of(&endpoint_name(ID), ID));
54        assert_eq!(server_id_of(&generation), None);
55    }
56}