minint/
messages.rs

1use std::collections::BTreeMap;
2
3use serde::{Deserialize, Serialize};
4
5#[derive(Serialize)]
6#[serde(rename_all = "lowercase", tag = "method", content = "params")]
7pub enum ClientMsg {
8    /// Publish Request Message
9    ///
10    /// Sent from a client to the server to indicate the client wants to start publishing values at the given topic. The server shall respond with a Topic Announcement Message ([Announce]), even if the topic was previously announced. The client can start publishing data values via MessagePack messages immediately after sending this message, but the messages will be ignored by the server if the publisher data type does not match the topic data type.
11    Publish {
12        /// Publish name
13        ///
14        /// The topic name being published
15        name: String,
16        /// Publisher UID
17        ///
18        /// A client-generated unique identifier for this publisher. Use the same UID later to unpublish. This is also the identifier that the client will use in MessagePack messages for this topic.
19        pubuid: i32,
20        /// Type of data
21        ///
22        /// The requested data type (as a string).
23        ///
24        /// If the topic is newly created (e.g. there are no other publishers) this sets the value type. If the topic was previously published, this is ignored. The [Announce] message contains the actual topic value type that the client shall use when publishing values.
25        ///
26        /// Implementations should indicate an error if the user tries to publish an incompatible type to that already set for the topic.
27        r#type: String,
28        /// Properties
29        ///
30        /// Initial topic properties.
31        ///
32        /// If the topic is newly created (e.g. there are no other publishers) this sets the topic properties. If the topic was previously published, this is ignored. The [Announce] message contains the actual topic properties. Clients can use the [SetProperties] message to change properties after topic creation.
33        properties: Option<PublishProps>,
34    },
35    /// Publish Release Message
36    ///
37    /// Sent from a client to the server to indicate the client wants to stop publishing values for the given topic and publisher. The client should stop publishing data value updates via binary MessagePack messages for this publisher prior to sending this message.
38    ///
39    /// When there are no remaining publishers for a non-persistent topic, the server shall delete the topic and send a Topic Removed Message ([Unannounce]) to all clients who have been sent a previous Topic Announcement Message ([Announce]) for the topic.
40    Unpublish {
41        /// Publisher UID
42        ///
43        /// The same unique identifier passed to the [Publish] message
44        pubuid: i32,
45    },
46
47    /// Set Properties Message
48    ///
49    /// Sent from a client to the server to change properties (see Properties) for a given topic. The server will send a corresponding Properties Update Message ([Properties]) to all subscribers to the topic (if the topic is published). This message shall be ignored by the server if the topic is not published.
50    ///
51    /// If a property is not included in the update map, its value is not changed. If a property is provided in the update map with a value of null, the property is deleted.
52    SetProperties {
53        /// Topic name
54        name: String,
55        /// Properties to update
56        update: BTreeMap<String, String>,
57    },
58
59    /// Subscribe Message
60    ///
61    /// Sent from a client to the server to indicate the client wants to subscribe to value changes for the specified topics / groups of topics. The server shall send MessagePack messages containing the current values for any existing cached topics upon receipt, and continue sending MessagePack messages for future value changes. If a topic does not yet exist, no message is sent until it is created (via a publish), at which point a Topic Announcement Message ([Announce]) will be sent and MessagePack messages will automatically follow as they are published.
62    ///
63    /// Subscriptions may overlap; only one MessagePack message is sent per value change regardless of the number of subscriptions. Sending a subscribe message with the same subscription UID as a previous subscribe message results in updating the subscription (replacing the array of identifiers and updating any specified options).
64    Subscribe {
65        topics: Vec<String>,
66        subuid: i32,
67        options: BTreeMap<String, String>,
68    },
69
70    /// Unsubscribe Message
71    ///
72    /// Sent from a client to the server to indicate the client wants to stop subscribing to messages for the given subscription.
73    Unsubscribe {
74        /// Subscription UID
75        ///
76        /// The same unique identifier passed to the [Subscribe] message
77        subuid: i32,
78    },
79}
80
81#[derive(Deserialize, Debug)]
82#[serde(rename_all = "lowercase", tag = "method", content = "params")]
83pub enum ServerMsg {
84    /// Topic Announcement Message
85    ///
86    /// The server shall send this message for each of the following conditions:
87    ///  - To all clients subscribed to a matching prefix when a topic is created
88    ///  - To a client in response to an Publish Request Message (publish) from that client
89    Announce {
90        /// Topic name
91        name: String,
92        /// Topic ID
93        ///
94        /// The identifier that the server will use in MessagePack messages for this topic
95        id: i32,
96        /// Data type
97        ///
98        /// The data type for the topic (as a string)
99        r#type: String,
100        /// Publisher UID
101        ///
102        /// If this message was sent in response to a publish message, the Publisher UID provided in that message. Otherwise absent.
103        pubuid: Option<i32>,
104        /// Properties
105        ///
106        /// Topic Properties
107        properties: BTreeMap<String, bool>,
108    },
109
110    /// Topic Removed Message
111    ///
112    /// The server shall send this message when a previously announced (via a Topic Announcement Message ([Announce]) topic is deleted.
113    Unannounce {
114        /// Topic name
115        name: String,
116        /// Topic ID
117        ///
118        /// The identifier that the server was using for value updates
119        id: i32,
120    },
121
122    /// Properties Update Message
123    ///
124    /// The server shall send this message when a previously announced (via a Topic Announcement Message ([Announce]) topic has its properties changed (via Set Properties Message ([SetProperties]).
125    Properties {
126        /// Topic name
127        name: String,
128        /// Acknowledgement
129        ///
130        /// True if this message is in response to a setproperties message from the same client. Otherwise absent.
131        ack: bool,
132    },
133}
134
135#[derive(Serialize)]
136pub struct PublishProps {
137    #[serde(skip_serializing_if = "Option::is_none")]
138    pub persistent: Option<bool>,
139    #[serde(skip_serializing_if = "Option::is_none")]
140    pub retained: Option<bool>,
141}
minint/messages.rs

minint/
messages.rs
