-
Notifications
You must be signed in to change notification settings - Fork 159
/
lib.rs
executable file
·1636 lines (1483 loc) · 51 KB
/
lib.rs
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2020-2022 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! A Rust asynchronous client for the NATS.io ecosystem.
//!
//! To access the repository, you can clone it by running:
//!
//! ```bash
//! git clone https://github.com/nats-io/nats.rs
//! ````
//! NATS.io is a simple, secure, and high-performance open-source messaging
//! system designed for cloud-native applications, IoT messaging, and microservices
//! architectures.
//!
//! **Note**: The synchronous NATS API is deprecated and no longer actively maintained. If you need to use the deprecated synchronous API, you can refer to:
//! <https://crates.io/crates/nats>
//!
//! For more information on NATS.io visit: <https://nats.io>
//!
//! ## Examples
//!
//! Below, you can find some basic examples on how to use this library.
//!
//! For more details, please refer to the specific methods and structures documentation.
//!
//! ### Complete example
//!
//! Connect to the NATS server, publish messages and subscribe to receive messages.
//!
//! ```no_run
//! use bytes::Bytes;
//! use futures::StreamExt;
//!
//! #[tokio::main]
//! async fn main() -> Result<(), async_nats::Error> {
//! // Connect to the NATS server
//! let client = async_nats::connect("demo.nats.io").await?;
//!
//! // Subscribe to the "messages" subject
//! let mut subscriber = client.subscribe("messages").await?;
//!
//! // Publish messages to the "messages" subject
//! for _ in 0..10 {
//! client.publish("messages", "data".into()).await?;
//! }
//!
//! // Receive and process messages
//! while let Some(message) = subscriber.next().await {
//! println!("Received message {:?}", message);
//! }
//!
//! Ok(())
//! }
//! ```
//!
//! ### Publish
//!
//! Connect to the NATS server and publish messages to a subject.
//!
//! ```
//! # use bytes::Bytes;
//! # use std::error::Error;
//! # use std::time::Instant;
//! # #[tokio::main]
//! # async fn main() -> Result<(), async_nats::Error> {
//! // Connect to the NATS server
//! let client = async_nats::connect("demo.nats.io").await?;
//!
//! // Prepare the subject and data
//! let subject = "foo";
//! let data = Bytes::from("bar");
//!
//! // Publish messages to the NATS server
//! for _ in 0..10 {
//! client.publish(subject, data.clone()).await?;
//! }
//!
//! // Flush internal buffer before exiting to make sure all messages are sent
//! client.flush().await?;
//!
//! # Ok(())
//! # }
//! ```
//!
//! ### Subscribe
//!
//! Connect to the NATS server, subscribe to a subject and receive messages.
//!
//! ```no_run
//! # use bytes::Bytes;
//! # use futures::StreamExt;
//! # use std::error::Error;
//! # use std::time::Instant;
//! # #[tokio::main]
//! # async fn main() -> Result<(), async_nats::Error> {
//! // Connect to the NATS server
//! let client = async_nats::connect("demo.nats.io").await?;
//!
//! // Subscribe to the "foo" subject
//! let mut subscriber = client.subscribe("foo").await.unwrap();
//!
//! // Receive and process messages
//! while let Some(message) = subscriber.next().await {
//! println!("Received message {:?}", message);
//! }
//! # Ok(())
//! # }
//! ```
//!
//! ### JetStream
//!
//! To access JetStream API, create a JetStream [jetstream::Context].
//!
//! ```no_run
//! # #[tokio::main]
//! # async fn main() -> Result<(), async_nats::Error> {
//! // Connect to the NATS server
//! let client = async_nats::connect("demo.nats.io").await?;
//! // Create a JetStream context.
//! let jetstream = async_nats::jetstream::new(client);
//!
//! // Publish JetStream messages, manage streams, consumers, etc.
//! jetstream.publish("foo", "bar".into()).await?;
//! # Ok(())
//! # }
//! ```
//!
//! ### Key-value Store
//!
//! Key-value [Store][jetstream::kv::Store] is accessed through [jetstream::Context].
//!
//! ```no_run
//! # #[tokio::main]
//! # async fn main() -> Result<(), async_nats::Error> {
//! // Connect to the NATS server
//! let client = async_nats::connect("demo.nats.io").await?;
//! // Create a JetStream context.
//! let jetstream = async_nats::jetstream::new(client);
//! // Access an existing key-value.
//! let kv = jetstream.get_key_value("store").await?;
//! # Ok(())
//! # }
//! ```
//! ### Object Store store
//!
//! Object [Store][jetstream::object_store::ObjectStore] is accessed through [jetstream::Context].
//!
//! ```no_run
//! # #[tokio::main]
//! # async fn main() -> Result<(), async_nats::Error> {
//! // Connect to the NATS server
//! let client = async_nats::connect("demo.nats.io").await?;
//! // Create a JetStream context.
//! let jetstream = async_nats::jetstream::new(client);
//! // Access an existing key-value.
//! let kv = jetstream.get_object_store("store").await?;
//! # Ok(())
//! # }
//! ```
//! ### Service API
//!
//! [Service API][service::Service] is accessible through [Client] after importing its trait.
//!
//! ```no_run
//! # #[tokio::main]
//! # async fn main() -> Result<(), async_nats::Error> {
//! use async_nats::service::ServiceExt;
//! // Connect to the NATS server
//! let client = async_nats::connect("demo.nats.io").await?;
//! let mut service = client
//! .service_builder()
//! .description("some service")
//! .stats_handler(|endpoint, stats| serde_json::json!({ "endpoint": endpoint }))
//! .start("products", "1.0.0")
//! .await?;
//! # Ok(())
//! # }
//! ```
#![deny(unreachable_pub)]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::private_intra_doc_links)]
#![deny(rustdoc::invalid_codeblock_attributes)]
#![deny(rustdoc::invalid_rust_codeblocks)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
use thiserror::Error;
use futures::stream::Stream;
use tokio::io::AsyncWriteExt;
use tokio::sync::oneshot;
use tracing::{debug, error};
use core::fmt;
use std::collections::HashMap;
use std::fmt::Display;
use std::future::Future;
use std::iter;
use std::mem;
use std::net::SocketAddr;
use std::option;
use std::pin::Pin;
use std::slice;
use std::str::{self, FromStr};
use std::sync::atomic::AtomicUsize;
use std::sync::Arc;
use std::task::{Context, Poll};
use tokio::io::ErrorKind;
use tokio::time::{interval, Duration, Interval, MissedTickBehavior};
use url::{Host, Url};
use bytes::Bytes;
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};
use tokio::io;
use tokio::sync::mpsc;
use tokio::task;
pub type Error = Box<dyn std::error::Error + Send + Sync + 'static>;
const VERSION: &str = env!("CARGO_PKG_VERSION");
const LANG: &str = "rust";
const MAX_PENDING_PINGS: usize = 2;
const MULTIPLEXER_SID: u64 = 0;
/// A re-export of the `rustls` crate used in this crate,
/// for use in cases where manual client configurations
/// must be provided using `Options::tls_client_config`.
pub use tokio_rustls::rustls;
use connection::{Connection, State};
use connector::{Connector, ConnectorOptions};
pub use header::{HeaderMap, HeaderName, HeaderValue};
pub use subject::Subject;
mod auth;
pub(crate) mod auth_utils;
pub mod client;
pub mod connection;
mod connector;
mod options;
pub use auth::Auth;
pub use client::{Client, PublishError, Request, RequestError, RequestErrorKind, SubscribeError};
pub use options::{AuthError, ConnectOptions};
mod crypto;
pub mod error;
pub mod header;
pub mod jetstream;
pub mod message;
#[cfg(feature = "service")]
pub mod service;
pub mod status;
pub mod subject;
mod tls;
pub use message::Message;
pub use status::StatusCode;
/// Information sent by the server back to this client
/// during initial connection, and possibly again later.
#[derive(Debug, Deserialize, Default, Clone, Eq, PartialEq)]
pub struct ServerInfo {
/// The unique identifier of the NATS server.
#[serde(default)]
pub server_id: String,
/// Generated Server Name.
#[serde(default)]
pub server_name: String,
/// The host specified in the cluster parameter/options.
#[serde(default)]
pub host: String,
/// The port number specified in the cluster parameter/options.
#[serde(default)]
pub port: u16,
/// The version of the NATS server.
#[serde(default)]
pub version: String,
/// If this is set, then the server should try to authenticate upon
/// connect.
#[serde(default)]
pub auth_required: bool,
/// If this is set, then the server must authenticate using TLS.
#[serde(default)]
pub tls_required: bool,
/// Maximum payload size that the server will accept.
#[serde(default)]
pub max_payload: usize,
/// The protocol version in use.
#[serde(default)]
pub proto: i8,
/// The server-assigned client ID. This may change during reconnection.
#[serde(default)]
pub client_id: u64,
/// The version of golang the NATS server was built with.
#[serde(default)]
pub go: String,
/// The nonce used for nkeys.
#[serde(default)]
pub nonce: String,
/// A list of server urls that a client can connect to.
#[serde(default)]
pub connect_urls: Vec<String>,
/// The client IP as known by the server.
#[serde(default)]
pub client_ip: String,
/// Whether the server supports headers.
#[serde(default)]
pub headers: bool,
/// Whether server goes into lame duck mode.
#[serde(default, rename = "ldm")]
pub lame_duck_mode: bool,
}
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) enum ServerOp {
Ok,
Info(Box<ServerInfo>),
Ping,
Pong,
Error(ServerError),
Message {
sid: u64,
subject: Subject,
reply: Option<Subject>,
payload: Bytes,
headers: Option<HeaderMap>,
status: Option<StatusCode>,
description: Option<String>,
length: usize,
},
}
#[derive(Debug)]
pub(crate) enum Command {
Publish {
subject: Subject,
payload: Bytes,
respond: Option<Subject>,
headers: Option<HeaderMap>,
},
Request {
subject: Subject,
payload: Bytes,
respond: Subject,
headers: Option<HeaderMap>,
sender: oneshot::Sender<Message>,
},
Subscribe {
sid: u64,
subject: Subject,
queue_group: Option<String>,
sender: mpsc::Sender<Message>,
},
Unsubscribe {
sid: u64,
max: Option<u64>,
},
Flush {
observer: oneshot::Sender<()>,
},
Reconnect,
}
/// `ClientOp` represents all actions of `Client`.
#[derive(Debug)]
pub(crate) enum ClientOp {
Publish {
subject: Subject,
payload: Bytes,
respond: Option<Subject>,
headers: Option<HeaderMap>,
},
Subscribe {
sid: u64,
subject: Subject,
queue_group: Option<String>,
},
Unsubscribe {
sid: u64,
max: Option<u64>,
},
Ping,
Pong,
Connect(ConnectInfo),
}
#[derive(Debug)]
struct Subscription {
subject: Subject,
sender: mpsc::Sender<Message>,
queue_group: Option<String>,
delivered: u64,
max: Option<u64>,
}
#[derive(Debug)]
struct Multiplexer {
subject: Subject,
prefix: Subject,
senders: HashMap<String, oneshot::Sender<Message>>,
}
/// A connection handler which facilitates communication from channels to a single shared connection.
pub(crate) struct ConnectionHandler {
connection: Connection,
connector: Connector,
subscriptions: HashMap<u64, Subscription>,
multiplexer: Option<Multiplexer>,
pending_pings: usize,
info_sender: tokio::sync::watch::Sender<ServerInfo>,
ping_interval: Interval,
should_reconnect: bool,
flush_observers: Vec<oneshot::Sender<()>>,
}
impl ConnectionHandler {
pub(crate) fn new(
connection: Connection,
connector: Connector,
info_sender: tokio::sync::watch::Sender<ServerInfo>,
ping_period: Duration,
) -> ConnectionHandler {
let mut ping_interval = interval(ping_period);
ping_interval.set_missed_tick_behavior(MissedTickBehavior::Delay);
ConnectionHandler {
connection,
connector,
subscriptions: HashMap::new(),
multiplexer: None,
pending_pings: 0,
info_sender,
ping_interval,
should_reconnect: false,
flush_observers: Vec::new(),
}
}
pub(crate) async fn process<'a>(&'a mut self, receiver: &'a mut mpsc::Receiver<Command>) {
struct ProcessFut<'a> {
handler: &'a mut ConnectionHandler,
receiver: &'a mut mpsc::Receiver<Command>,
recv_buf: &'a mut Vec<Command>,
}
enum ExitReason {
Disconnected(Option<io::Error>),
ReconnectRequested,
Closed,
}
impl<'a> ProcessFut<'a> {
const RECV_CHUNK_SIZE: usize = 16;
#[cold]
fn ping(&mut self) -> Poll<ExitReason> {
self.handler.pending_pings += 1;
if self.handler.pending_pings > MAX_PENDING_PINGS {
debug!(
"pending pings {}, max pings {}. disconnecting",
self.handler.pending_pings, MAX_PENDING_PINGS
);
Poll::Ready(ExitReason::Disconnected(None))
} else {
self.handler.connection.enqueue_write_op(&ClientOp::Ping);
Poll::Pending
}
}
}
impl<'a> Future for ProcessFut<'a> {
type Output = ExitReason;
/// Drives the connection forward.
///
/// Returns one of the following:
///
/// * `Poll::Pending` means that the connection
/// is blocked on all fronts or there are
/// no commands to send or receive
/// * `Poll::Ready(ExitReason::Disconnected(_))` means
/// that an I/O operation failed and the connection
/// is considered dead.
/// * `Poll::Ready(ExitReason::Closed)` means that
/// [`Self::receiver`] was closed, so there's nothing
/// more for us to do than to exit the client.
fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
// We need to be sure the waker is registered, therefore we need to poll until we
// get a `Poll::Pending`. With a sane interval delay, this means that the loop
// breaks at the second iteration.
while self.handler.ping_interval.poll_tick(cx).is_ready() {
if let Poll::Ready(exit) = self.ping() {
return Poll::Ready(exit);
}
}
loop {
match self.handler.connection.poll_read_op(cx) {
Poll::Pending => break,
Poll::Ready(Ok(Some(server_op))) => {
self.handler.handle_server_op(server_op);
}
Poll::Ready(Ok(None)) => {
return Poll::Ready(ExitReason::Disconnected(None))
}
Poll::Ready(Err(err)) => {
return Poll::Ready(ExitReason::Disconnected(Some(err)))
}
}
}
// WARNING: after the following loop `handle_command`,
// or other functions which call `enqueue_write_op`,
// cannot be called anymore. Runtime wakeups won't
// trigger a call to `poll_write`
let mut made_progress = true;
loop {
while !self.handler.connection.is_write_buf_full() {
debug_assert!(self.recv_buf.is_empty());
let Self {
recv_buf,
handler,
receiver,
} = &mut *self;
match receiver.poll_recv_many(cx, recv_buf, Self::RECV_CHUNK_SIZE) {
Poll::Pending => break,
Poll::Ready(1..) => {
made_progress = true;
for cmd in recv_buf.drain(..) {
handler.handle_command(cmd);
}
}
// TODO: replace `_` with `0` after bumping MSRV to 1.75
Poll::Ready(_) => return Poll::Ready(ExitReason::Closed),
}
}
// The first round will poll both from
// the `receiver` and the writer, giving
// them both a chance to make progress
// and register `Waker`s.
//
// If writing is `Poll::Pending` we exit.
//
// If writing is completed we can repeat the entire
// cycle as long as the `receiver` doesn't end-up
// `Poll::Pending` immediately.
if !mem::take(&mut made_progress) {
break;
}
match self.handler.connection.poll_write(cx) {
Poll::Pending => {
// Write buffer couldn't be fully emptied
break;
}
Poll::Ready(Ok(())) => {
// Write buffer is empty
continue;
}
Poll::Ready(Err(err)) => {
return Poll::Ready(ExitReason::Disconnected(Some(err)))
}
}
}
if let (ShouldFlush::Yes, _) | (ShouldFlush::No, false) = (
self.handler.connection.should_flush(),
self.handler.flush_observers.is_empty(),
) {
match self.handler.connection.poll_flush(cx) {
Poll::Pending => {}
Poll::Ready(Ok(())) => {
for observer in self.handler.flush_observers.drain(..) {
let _ = observer.send(());
}
}
Poll::Ready(Err(err)) => {
return Poll::Ready(ExitReason::Disconnected(Some(err)))
}
}
}
if mem::take(&mut self.handler.should_reconnect) {
return Poll::Ready(ExitReason::ReconnectRequested);
}
Poll::Pending
}
}
let mut recv_buf = Vec::with_capacity(ProcessFut::RECV_CHUNK_SIZE);
loop {
let process = ProcessFut {
handler: self,
receiver,
recv_buf: &mut recv_buf,
};
match process.await {
ExitReason::Disconnected(err) => {
debug!(?err, "disconnected");
if self.handle_disconnect().await.is_err() {
break;
};
debug!("reconnected");
}
ExitReason::Closed => break,
ExitReason::ReconnectRequested => {
debug!("reconnect requested");
// Should be ok to ingore error, as that means we are not in connected state.
self.connection.stream.shutdown().await.ok();
if self.handle_disconnect().await.is_err() {
break;
};
}
}
}
}
fn handle_server_op(&mut self, server_op: ServerOp) {
self.ping_interval.reset();
match server_op {
ServerOp::Ping => {
self.connection.enqueue_write_op(&ClientOp::Pong);
}
ServerOp::Pong => {
debug!("received PONG");
self.pending_pings = self.pending_pings.saturating_sub(1);
}
ServerOp::Error(error) => {
self.connector
.events_tx
.try_send(Event::ServerError(error))
.ok();
}
ServerOp::Message {
sid,
subject,
reply,
payload,
headers,
status,
description,
length,
} => {
if let Some(subscription) = self.subscriptions.get_mut(&sid) {
let message: Message = Message {
subject,
reply,
payload,
headers,
status,
description,
length,
};
// if the channel for subscription was dropped, remove the
// subscription from the map and unsubscribe.
match subscription.sender.try_send(message) {
Ok(_) => {
subscription.delivered += 1;
// if this `Subscription` has set `max` value, check if it
// was reached. If yes, remove the `Subscription` and in
// the result, `drop` the `sender` channel.
if let Some(max) = subscription.max {
if subscription.delivered.ge(&max) {
self.subscriptions.remove(&sid);
}
}
}
Err(mpsc::error::TrySendError::Full(_)) => {
self.connector
.events_tx
.try_send(Event::SlowConsumer(sid))
.ok();
}
Err(mpsc::error::TrySendError::Closed(_)) => {
self.subscriptions.remove(&sid);
self.connection
.enqueue_write_op(&ClientOp::Unsubscribe { sid, max: None });
}
}
} else if sid == MULTIPLEXER_SID {
if let Some(multiplexer) = self.multiplexer.as_mut() {
let maybe_token =
subject.strip_prefix(multiplexer.prefix.as_ref()).to_owned();
if let Some(token) = maybe_token {
if let Some(sender) = multiplexer.senders.remove(token) {
let message = Message {
subject,
reply,
payload,
headers,
status,
description,
length,
};
let _ = sender.send(message);
}
}
}
}
}
// TODO: we should probably update advertised server list here too.
ServerOp::Info(info) => {
if info.lame_duck_mode {
self.connector.events_tx.try_send(Event::LameDuckMode).ok();
}
}
_ => {
// TODO: don't ignore.
}
}
}
fn handle_command(&mut self, command: Command) {
self.ping_interval.reset();
match command {
Command::Unsubscribe { sid, max } => {
if let Some(subscription) = self.subscriptions.get_mut(&sid) {
subscription.max = max;
match subscription.max {
Some(n) => {
if subscription.delivered >= n {
self.subscriptions.remove(&sid);
}
}
None => {
self.subscriptions.remove(&sid);
}
}
self.connection
.enqueue_write_op(&ClientOp::Unsubscribe { sid, max });
}
}
Command::Flush { observer } => {
self.flush_observers.push(observer);
}
Command::Subscribe {
sid,
subject,
queue_group,
sender,
} => {
let subscription = Subscription {
sender,
delivered: 0,
max: None,
subject: subject.to_owned(),
queue_group: queue_group.to_owned(),
};
self.subscriptions.insert(sid, subscription);
self.connection.enqueue_write_op(&ClientOp::Subscribe {
sid,
subject,
queue_group,
});
}
Command::Request {
subject,
payload,
respond,
headers,
sender,
} => {
let (prefix, token) = respond.rsplit_once('.').expect("malformed request subject");
let multiplexer = if let Some(multiplexer) = self.multiplexer.as_mut() {
multiplexer
} else {
let prefix = Subject::from(format!("{}.{}.", prefix, nuid::next()));
let subject = Subject::from(format!("{}*", prefix));
self.connection.enqueue_write_op(&ClientOp::Subscribe {
sid: MULTIPLEXER_SID,
subject: subject.clone(),
queue_group: None,
});
self.multiplexer.insert(Multiplexer {
subject,
prefix,
senders: HashMap::new(),
})
};
multiplexer.senders.insert(token.to_owned(), sender);
let pub_op = ClientOp::Publish {
subject,
payload,
respond: Some(format!("{}{}", multiplexer.prefix, token).into()),
headers,
};
self.connection.enqueue_write_op(&pub_op);
}
Command::Publish {
subject,
payload,
respond,
headers,
} => {
self.connection.enqueue_write_op(&ClientOp::Publish {
subject,
payload,
respond,
headers,
});
}
Command::Reconnect => {
self.should_reconnect = true;
}
}
}
async fn handle_disconnect(&mut self) -> Result<(), ConnectError> {
self.pending_pings = 0;
self.connector.events_tx.try_send(Event::Disconnected).ok();
self.connector.state_tx.send(State::Disconnected).ok();
self.handle_reconnect().await
}
async fn handle_reconnect(&mut self) -> Result<(), ConnectError> {
let (info, connection) = self.connector.connect().await?;
self.connection = connection;
let _ = self.info_sender.send(info);
self.subscriptions
.retain(|_, subscription| !subscription.sender.is_closed());
for (sid, subscription) in &self.subscriptions {
self.connection.enqueue_write_op(&ClientOp::Subscribe {
sid: *sid,
subject: subscription.subject.to_owned(),
queue_group: subscription.queue_group.to_owned(),
});
}
if let Some(multiplexer) = &self.multiplexer {
self.connection.enqueue_write_op(&ClientOp::Subscribe {
sid: MULTIPLEXER_SID,
subject: multiplexer.subject.to_owned(),
queue_group: None,
});
}
Ok(())
}
}
/// Connects to NATS with specified options.
///
/// It is generally advised to use [ConnectOptions] instead, as it provides a builder for whole
/// configuration.
///
/// # Examples
/// ```
/// # #[tokio::main]
/// # async fn main() -> Result<(), async_nats::Error> {
/// let mut nc =
/// async_nats::connect_with_options("demo.nats.io", async_nats::ConnectOptions::new()).await?;
/// nc.publish("test", "data".into()).await?;
/// # Ok(())
/// # }
/// ```
pub async fn connect_with_options<A: ToServerAddrs>(
addrs: A,
options: ConnectOptions,
) -> Result<Client, ConnectError> {
let ping_period = options.ping_interval;
let (events_tx, mut events_rx) = mpsc::channel(128);
let (state_tx, state_rx) = tokio::sync::watch::channel(State::Pending);
// We're setting it to the default server payload size.
let max_payload = Arc::new(AtomicUsize::new(1024 * 1024));
let mut connector = Connector::new(
addrs,
ConnectorOptions {
tls_required: options.tls_required,
certificates: options.certificates,
client_key: options.client_key,
client_cert: options.client_cert,
tls_client_config: options.tls_client_config,
tls_first: options.tls_first,
auth: options.auth,
no_echo: options.no_echo,
connection_timeout: options.connection_timeout,
name: options.name,
ignore_discovered_servers: options.ignore_discovered_servers,
retain_servers_order: options.retain_servers_order,
read_buffer_capacity: options.read_buffer_capacity,
reconnect_delay_callback: options.reconnect_delay_callback,
auth_callback: options.auth_callback,
max_reconnects: options.max_reconnects,
},
events_tx,
state_tx,
max_payload.clone(),
)
.map_err(|err| ConnectError::with_source(ConnectErrorKind::ServerParse, err))?;
let mut info: ServerInfo = Default::default();
let mut connection = None;
if !options.retry_on_initial_connect {
debug!("retry on initial connect failure is disabled");
let (info_ok, connection_ok) = connector.try_connect().await?;
connection = Some(connection_ok);
info = info_ok;
}
let (info_sender, info_watcher) = tokio::sync::watch::channel(info.clone());
let (sender, mut receiver) = mpsc::channel(options.sender_capacity);
let client = Client::new(
info_watcher,
state_rx,
sender,
options.subscription_capacity,
options.inbox_prefix,
options.request_timeout,
max_payload,
);
task::spawn(async move {
while let Some(event) = events_rx.recv().await {
tracing::info!("event: {}", event);
if let Some(event_callback) = &options.event_callback {
event_callback.call(event).await;
}
}
});
task::spawn(async move {
if connection.is_none() && options.retry_on_initial_connect {
let (info, connection_ok) = match connector.connect().await {
Ok((info, connection)) => (info, connection),
Err(err) => {
error!("connection closed: {}", err);
return;
}
};
info_sender.send(info).ok();
connection = Some(connection_ok);
}
let connection = connection.unwrap();
let mut connection_handler =
ConnectionHandler::new(connection, connector, info_sender, ping_period);
connection_handler.process(&mut receiver).await
});
Ok(client)
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Event {
Connected,
Disconnected,
LameDuckMode,
SlowConsumer(u64),
ServerError(ServerError),
ClientError(ClientError),
}
impl fmt::Display for Event {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Event::Connected => write!(f, "connected"),
Event::Disconnected => write!(f, "disconnected"),
Event::LameDuckMode => write!(f, "lame duck mode detected"),
Event::SlowConsumer(sid) => write!(f, "slow consumers for subscription {sid}"),