-
Notifications
You must be signed in to change notification settings - Fork 0
/
gemqtt.gleam
280 lines (249 loc) · 6.46 KB
/
gemqtt.gleam
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
import gleam/dict.{type Dict}
import gleam/dynamic.{type Dynamic}
import gleam/erlang/atom.{type Atom}
import gleam/erlang/charlist
import gleam/erlang/process
import gleam/option.{type Option}
/// Errors that can occur when working with MQTT connections.
///
pub type Error {
AlreadyStarted(process.Pid)
BadProperty(Option(Atom))
Noproc
// Network errors; https://www.erlang.org/doc/man/inet#type-posix
Closed
Timeout
Eaddrinuse
Eaddrnotavail
Eafnosupport
Ealready
Econnaborted
Econnrefused
Econnreset
Edestaddrreq
Ehostdown
Ehostunreach
Einprogress
Eisconn
Emsgsize
Enetdown
Enetunreach
Enopkg
Enoprotoopt
Enotconn
Enotty
Enotsock
Eproto
Eprotonosupport
Eprototype
Esocktnosupport
Etimedout
Ewouldblock
Exbadport
Exbadseq
Nxdomain
// TLS errors; https://www.erlang.org/doc/man/ssl#type-reason
AccessDenied
BadCertificate
BadCertificateHashValue
BadCertificateStatusResponse
BadRecordMac
CertificateExpired
CertificateRevoked
CertificateUnknown
CertificateUnobtainable
CloseNotify
DecodeError
DecryptError
ExportRestriction
HandshakeFailure
IllegalParameter
InappropriateFallback
InsufficientSecurity
InternalError
NoApplicationProtocol
NoRenegotiation
ProtocolVersion
RecordOverflow
UnexpectedMessage
UnknownCa
UnknownPskIdentity
UnrecognizedName
UnsupportedCertificate
UnsupportedExtension
UserCanceled
}
pub opaque type Options {
Options(
options: Dict(Atom, Dynamic),
tls_options: Dict(Atom, Dynamic),
properties: Properties,
)
}
pub type Properties {
Properties(Dict(Atom, Dynamic))
}
/// MQTT Quality of Service level, controlling how many times a message
/// may be delivered.
///
pub type Qos {
AtMostOnce
AtLeastOnce
ExactlyOnce
}
// TODO Missing options
// TcpOpts
// WsPath
// BridgeMode
// ProtoVer
// Keepalive
// MaxInflight
// RetryInterval
// WillTopic
// WillPayload
// WillRetain
// WillQos
// WillProps
// AckTimeout
// ForcePing
pub fn new(host: String) -> Options {
let host_value =
host
|> charlist.from_string
|> dynamic.from
let opts =
dict.new()
|> dict.insert(atom.create_from_string("host"), host_value)
Options(
options: opts,
tls_options: dict.new(),
properties: Properties(dict.new()),
)
}
pub fn set_auth(opts: Options, username: String, password: String) -> Options {
opts
|> set_option(atom.create_from_string("username"), username)
|> set_option(atom.create_from_string("password"), password)
}
pub fn set_auto_ack(opts: Options, ack: Bool) -> Options {
set_option(opts, atom.create_from_string("auto_ack"), ack)
}
pub fn set_clean_start(opts: Options, clean: Bool) -> Options {
set_option(opts, atom.create_from_string("clean_start"), clean)
}
pub fn set_client_id(opts: Options, id: String) -> Options {
set_option(opts, atom.create_from_string("clientid"), id)
}
pub fn set_connect_timeout(opts: Options, seconds timeout: Int) -> Options {
set_option(opts, atom.create_from_string("connect_timeout"), timeout)
}
/// Sets the Erlang server name for the client process.
pub fn set_name(opts: Options, name: String) -> Options {
set_option(
opts,
atom.create_from_string("name"),
atom.create_from_string(name),
)
}
pub fn set_owner(opts: Options, pid: process.Pid) -> Options {
set_option(opts, atom.create_from_string("owner"), pid)
}
pub fn set_port(opts: Options, port: Int) -> Options {
set_option(opts, atom.create_from_string("port"), port)
}
pub fn set_tls_enabled(opts: Options, tls: Bool) -> Options {
set_option(opts, atom.create_from_string("ssl"), tls)
}
pub fn set_tls_opt(opts: Options, name: String, value: Dynamic) -> Options {
Options(
..opts,
tls_options: dict.insert(
opts.tls_options,
atom.create_from_string(name),
dynamic.from(value),
),
)
}
fn set_option(opts: Options, name: atom.Atom, value: t) -> Options {
Options(..opts, options: dict.insert(opts.options, name, dynamic.from(value)))
}
/// Sets an MQTT CONNECT packet property. Please note that properties are
/// validated when `start_link` is called; if _emqtt_ detects errors it will
/// cause your process to fail rather than return an Error.
///
/// Available connect properties:
///
/// - `Session-Expiry-Interval`: Four byte integer
/// - `Receive-Maximum`: Two byte integer
/// - `Maximum-Packet-Size`: Four byte integer
/// - `Topic-Alias-Maximum`: Two byte integer
/// - `Request-Response-Information`: Byte
/// - `Request-Problem-Information`: Byte
/// - `User-Property`: UTF-8 string pair
/// - `Authentication-Method`: UTF-8 encoded string
/// - `Authentication-Data`: Binary data
///
/// Example usage:
///
/// ```
/// gemqtt.new("localhost")
/// |> gemqtt.set_property("Maximum-Packet-Size", 300)
/// |> gemqtt.set_property("User-Property", #("prop-name", "prop-value"))
/// ```
///
pub fn set_property(opts: Options, name: String, value: t) -> Options {
let Properties(props) = opts.properties
Options(
..opts,
properties: Properties(dict.insert(
props,
atom.create_from_string(name),
dynamic.from(value),
)),
)
}
/// Client holds the process running the MQTT connection, and is required to
/// publish and subsribe to messages.
///
pub opaque type Client {
Client(process.Pid)
}
/// Returns the Erlang Pid of the provided Client.
///
pub fn pid_of(client: Client) -> process.Pid {
let Client(pid) = client
pid
}
/// Configure a client process and link it to ours. Does not attempt to
/// connect to the MQTT server.
///
pub fn start_link(opts: Options) -> Result(Client, Error) {
let Options(
options: options,
tls_options: tls_options,
properties: Properties(properties),
) = opts
let options =
options
|> dict.insert(
atom.create_from_string("properties"),
dynamic.from(properties),
)
|> dict.insert(
atom.create_from_string("ssl_opts"),
dynamic.from(dict.to_list(tls_options)),
)
start_link_(options)
}
@external(erlang, "emqtt_ffi", "start_link")
fn start_link_(opts: Dict(Atom, Dynamic)) -> Result(Client, Error)
/// Connect to the configured MQTT server.
///
@external(erlang, "emqtt_ffi", "connect")
pub fn connect(client: Client) -> Result(Nil, Error)
@external(erlang, "emqtt_ffi", "disconnect")
pub fn disconnect(client: Client) -> Result(Nil, Error)
@external(erlang, "emqtt_ffi", "stop")
pub fn stop(client: Client) -> Result(Nil, Error)
@external(erlang, "emqtt_ffi", "subscriptions")
pub fn subscriptions(client: Client) -> List(#(String, Dict(Atom, Dynamic)))