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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
use futures::SinkExt;
use futures::StreamExt;
use tokio_util::codec::Framed;
use crate::bytes::MqttBytes;
use crate::client_identifier::ClientIdentifier;
use crate::codecs::MqttPacketCodec;
use crate::codecs::MqttPacketCodecError;
use crate::keep_alive::KeepAlive;
use crate::string::MqttString;
use crate::transport::MqttConnectTransport;
use crate::transport::MqttConnection;
pub enum CleanStart {
No,
Yes,
}
impl CleanStart {
pub fn as_bool(&self) -> bool {
match self {
CleanStart::No => false,
CleanStart::Yes => true,
}
}
}
#[derive(typed_builder::TypedBuilder)]
pub struct MqttWill {
#[builder(default = crate::packets::connect::ConnectWillProperties::new())]
properties: crate::packets::connect::ConnectWillProperties,
topic: MqttString,
payload: MqttBytes,
qos: mqtt_format::v5::fixed_header::QualityOfService,
retain: bool,
}
impl MqttWill {
pub fn get_properties_mut(&mut self) -> &mut crate::packets::connect::ConnectWillProperties {
&mut self.properties
}
}
impl MqttWill {
fn as_ref(&self) -> mqtt_format::v5::packets::connect::Will<'_> {
mqtt_format::v5::packets::connect::Will {
properties: self.properties.as_ref(),
topic: self.topic.as_ref(),
payload: self.payload.as_ref(),
will_qos: self.qos,
will_retain: self.retain,
}
}
}
#[derive(Debug, thiserror::Error)]
pub enum MqttClientConnectError {
#[error("An error occured while encoding or sending an MQTT Packet")]
Send(#[source] MqttPacketCodecError),
#[error("An error occured while decoding or receiving an MQTT Packet")]
Receive(#[source] MqttPacketCodecError),
#[error("The transport unexpectedly closed")]
TransportUnexpectedlyClosed,
#[error("The server sent a response with a protocol error: {reason}")]
ServerProtocolError { reason: &'static str },
}
pub struct MqttClientConnector {
transport: MqttConnectTransport,
client_identifier: ClientIdentifier,
clean_start: CleanStart,
keep_alive: KeepAlive,
properties: crate::packets::connect::ConnectProperties,
username: Option<MqttString>,
password: Option<MqttBytes>,
will: Option<MqttWill>,
}
impl MqttClientConnector {
pub fn new(
transport: MqttConnectTransport,
client_identifier: ClientIdentifier,
clean_start: CleanStart,
keep_alive: KeepAlive,
) -> MqttClientConnector {
MqttClientConnector {
transport,
client_identifier,
clean_start,
keep_alive,
properties: crate::packets::connect::ConnectProperties::new(),
username: None,
password: None,
will: None,
}
}
pub fn with_username(&mut self, username: MqttString) -> &mut Self {
self.username = Some(username);
self
}
pub fn with_password(&mut self, password: MqttBytes) -> &mut Self {
self.password = Some(password);
self
}
pub fn with_will(&mut self, will: MqttWill) -> &mut Self {
self.will = Some(will);
self
}
pub async fn connect(self) -> Result<MqttClient, MqttClientConnectError> {
type Mcce = MqttClientConnectError;
let mut conn =
tokio_util::codec::Framed::new(MqttConnection::from(self.transport), MqttPacketCodec);
let conn_packet = mqtt_format::v5::packets::connect::MConnect {
client_identifier: self.client_identifier.as_str(),
username: self.username.as_ref().map(AsRef::as_ref),
password: self.password.as_ref().map(AsRef::as_ref),
clean_start: self.clean_start.as_bool(),
will: self.will.as_ref().map(|w| w.as_ref()),
properties: self.properties.as_ref(),
keep_alive: self.keep_alive.as_u16(),
};
conn.send(mqtt_format::v5::packets::MqttPacket::Connect(conn_packet))
.await
.map_err(Mcce::Send)?;
let Some(maybe_connack) = conn.next().await else {
return Err(Mcce::TransportUnexpectedlyClosed);
};
let maybe_connack = match maybe_connack {
Ok(maybe_connack) => maybe_connack,
Err(e) => {
return Err(Mcce::Receive(e));
}
};
let connack = loop {
let can_use_auth = self.properties.authentication_data.is_some();
let auth = match maybe_connack.get() {
mqtt_format::v5::packets::MqttPacket::Connack(connack) => break connack,
mqtt_format::v5::packets::MqttPacket::Auth(auth) => {
if can_use_auth {
auth
} else {
// MQTT-4.12.0-6
return Err(Mcce::ServerProtocolError {
reason: "MQTT-4.12.0-6",
});
}
}
_ => {
return Err(MqttClientConnectError::ServerProtocolError {
reason: "MQTT-3.1.4-5",
});
}
};
// TODO: Use user-provided method to authenticate further
todo!()
};
// TODO: Timeout here if the server doesn't respond
if connack.reason_code == mqtt_format::v5::packets::connack::ConnackReasonCode::Success {
// TODO: Read properties, configure client
return Ok(MqttClient { conn });
}
// TODO: Do something with error code
todo!()
}
pub fn properties_mut(&mut self) -> &mut crate::packets::connect::ConnectProperties {
&mut self.properties
}
}
pub struct MqttClient {
conn: Framed<MqttConnection, MqttPacketCodec>,
}
impl MqttClient {}
|
