axum-cometd 0.5.0

Framework for CometD server creation
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
137
138
139
140
141
142
143

mod de;
#[cfg(test)]
mod test;

use crate::types::{ChannelId, ClientId};
use axum::Json;
use serde::{Deserialize, Serialize};
use serde_json::Value as JsonValue;
use serde_with::skip_serializing_none;
use std::fmt::Debug;

#[skip_serializing_none]
#[derive(Debug, Default, Serialize, Deserialize)]
pub(crate) struct Advice {
    pub(crate) interval: Option<u64>,
    #[serde(rename = "maxInterval")]
    pub(crate) max_interval: Option<u64>,
    #[serde(rename = "multiple-clients")]
    pub(crate) multiple_clients: Option<bool>,
    pub(crate) reconnect: Option<Reconnect>,
    pub(crate) timeout: Option<u64>,
    pub(crate) hosts: Option<Vec<String>>,
}

impl Advice {
    #[inline(always)]
    pub(crate) fn retry(timeout_ms: u64, interval_ms: u64) -> Self {
        Self {
            reconnect: Some(Reconnect::Retry),
            timeout: Some(timeout_ms),
            interval: Some(interval_ms),
            ..Default::default()
        }
    }

    #[inline(always)]
    pub(crate) fn handshake() -> Self {
        Self {
            reconnect: Some(Reconnect::Handshake),
            interval: Some(0),
            ..Default::default()
        }
    }
}

#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub(crate) enum Reconnect {
    Retry,
    Handshake,
    None,
}

#[skip_serializing_none]
#[derive(Debug, Default, Serialize, Deserialize)]
pub(crate) struct Message {
    pub(crate) advice: Option<Advice>,
    pub(crate) channel: Option<String>,
    #[serde(rename = "clientId")]
    pub(crate) client_id: Option<ClientId>,
    //#[serde(rename = "connectionType")]
    //pub(crate) connection_type: Option<String>,
    pub(crate) data: Option<JsonValue>,
    pub(crate) error: Option<String>,
    //pub(crate) ext: Option<JsonValue>,
    pub(crate) id: Option<String>,
    #[serde(rename = "minimumVersion")]
    pub(crate) minimum_version: Option<String>,
    //pub(crate) reestablish: Option<bool>,
    #[serde(default, deserialize_with = "de::deserialize_subscription")]
    pub(crate) subscription: Option<Vec<String>>,
    pub(crate) successful: Option<bool>,
    #[serde(rename = "supportedConnectionTypes")]
    pub(crate) supported_connection_types: Option<Vec<String>>,
    //pub(crate) timestamp: Option<String>,
    pub(crate) version: Option<String>,
}

#[derive(Debug, Clone)]
pub(crate) struct SubscriptionMessage {
    pub(crate) channel: ChannelId,
    pub(crate) msg: JsonValue,
}

impl Message {
    #[inline(always)]
    pub(crate) fn session_unknown(
        id: Option<String>,
        channel: Option<String>,
        advice: Option<Advice>,
    ) -> Self {
        Self {
            id,
            successful: Some(false),
            channel,
            error: Some("402::session_unknown".into()),
            advice,
            ..Default::default()
        }
    }

    #[inline(always)]
    pub(crate) fn wrong_minimum_version(
        id: Option<String>,
        minimum_version: Option<String>,
    ) -> Self {
        Self {
            id,
            successful: Some(false),
            minimum_version,
            error: Some("400::minimum_version_missing".into()),
            ..Default::default()
        }
    }

    #[inline(always)]
    pub(crate) fn subscription_missing(id: Option<String>) -> Self {
        Self {
            id,
            channel: Some("/meta/subscribe".into()),
            successful: Some(false),
            error: Some("403::subscription_missing".into()),
            ..Default::default()
        }
    }

    #[inline(always)]
    pub(crate) fn channel_missing(id: Option<String>) -> Self {
        Self {
            id,
            successful: Some(false),
            error: Some("400::channel_missing".into()),
            ..Default::default()
        }
    }
}

impl From<Message> for Json<[Message; 1]> {
    #[inline(always)]
    fn from(message: Message) -> Self {
        Json([message])
    }
}