rzmq 0.5.0

A high performance, fully asynchronous, safe pure-Rust implementation of ZeroMQ (ØMQ) messaging patterns, with optional io_uring acceleration on Linux.
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
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
use crate::error::ZmqError;
use crate::message::{Msg, MsgFlags};
use crate::runtime::{Command, MailboxSender};
use crate::socket::connection_iface::ISocketConnection;
use crate::socket::core::{CoreState, SocketCore};
use crate::socket::patterns::incoming_orchestrator::IncomingMessageOrchestrator;
use crate::socket::patterns::LoadBalancer;
use crate::socket::ISocket;
use crate::{delegate_to_core, Blob};

use async_trait::async_trait;
use parking_lot::{RwLock, RwLockReadGuard};
use std::collections::HashMap;
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::{Mutex as TokioMutex, Notify};
use tokio::time::timeout as tokio_timeout;

#[derive(Debug, Clone, PartialEq, Eq)]
enum ReqState {
  ReadyToSend,
  ExpectingReply { target_endpoint_uri: String },
}

#[derive(Debug)]
pub(crate) struct ReqSocket {
  core: Arc<SocketCore>,
  load_balancer: LoadBalancer,
  incoming_orchestrator: IncomingMessageOrchestrator<Vec<Msg>>,
  state: TokioMutex<ReqState>,
  reply_available_notifier: Arc<Notify>,
  pipe_read_to_endpoint_uri: RwLock<HashMap<usize, String>>,
}

impl ReqSocket {
  pub fn new(core: Arc<SocketCore>) -> Self {
    let orchestrator = IncomingMessageOrchestrator::new(core.handle, 1);
    Self {
      core,
      load_balancer: LoadBalancer::new(),
      incoming_orchestrator: orchestrator,
      state: TokioMutex::new(ReqState::ReadyToSend),
      reply_available_notifier: Arc::new(Notify::new()),
      pipe_read_to_endpoint_uri: RwLock::new(HashMap::new()),
    }
  }

  fn core_state_read(&self) -> RwLockReadGuard<'_, CoreState> {
    self.core.core_state.read()
  }

  fn process_incoming_zmtp_message_for_req(
    &self,
    pipe_read_id: usize,
    mut raw_zmtp_message: Vec<Msg>,
  ) -> Result<Vec<Msg>, ZmqError> {
    if !raw_zmtp_message.is_empty() && raw_zmtp_message[0].size() == 0 {
      tracing::trace!(
        handle = self.core.handle,
        pipe_id = pipe_read_id,
        "REQ: Stripped empty ZMTP delimiter from incoming reply."
      );
      raw_zmtp_message.remove(0);
    } else {
      tracing::warn!(
        handle = self.core.handle,
        pipe_id = pipe_read_id,
        "REQ: Incoming ZMTP reply from pipe did not start with an empty delimiter as expected from REP."
      );
    }
    Ok(raw_zmtp_message)
  }
}

#[async_trait]
impl ISocket for ReqSocket {
  fn core(&self) -> &Arc<SocketCore> {
    &self.core
  }
  fn mailbox(&self) -> MailboxSender {
    self.core.command_sender()
  }
  async fn bind(&self, endpoint: &str) -> Result<(), ZmqError> {
    delegate_to_core!(self, UserBind, endpoint: endpoint.to_string())
  }
  async fn connect(&self, endpoint: &str) -> Result<(), ZmqError> {
    delegate_to_core!(self, UserConnect, endpoint: endpoint.to_string())
  }
  async fn disconnect(&self, endpoint: &str) -> Result<(), ZmqError> {
    delegate_to_core!(self, UserDisconnect, endpoint: endpoint.to_string())
  }
  async fn unbind(&self, endpoint: &str) -> Result<(), ZmqError> {
    delegate_to_core!(self, UserUnbind, endpoint: endpoint.to_string())
  }
  async fn set_option(&self, option: i32, value: &[u8]) -> Result<(), ZmqError> {
    delegate_to_core!(self, UserSetOpt, option: option, value: value.to_vec())
  }
  async fn get_option(&self, option: i32) -> Result<Vec<u8>, ZmqError> {
    delegate_to_core!(self, UserGetOpt, option: option)
  }
  async fn close(&self) -> Result<(), ZmqError> {
    delegate_to_core!(self, UserClose,)
  }

  async fn send(&self, mut msg: Msg) -> Result<(), ZmqError> {
    if !self.core.is_running().await {
      return Err(ZmqError::InvalidState("Socket is closing".into()));
    }

    if msg.is_more() {
      msg.set_flags(msg.flags() & !MsgFlags::MORE);
      tracing::trace!(
        handle = self.core.handle,
        "REQ send: Cleared MORE flag from user-provided message."
      );
    }

    let target_endpoint_uri_for_state_update: String;
    {
      let current_state_guard = self.state.lock().await;
      if !matches!(*current_state_guard, ReqState::ReadyToSend) {
        return Err(ZmqError::InvalidState(
          "REQ socket must call recv() before sending again",
        ));
      }
      let timeout_opt: Option<Duration> = { self.core.core_state.read().options.sndtimeo };

      target_endpoint_uri_for_state_update = loop {
        if let Some(uri) = self.load_balancer.get_next_connection_uri() {
          let exists = { self.core.core_state.read().endpoints.contains_key(&uri) };
          if exists {
            break uri;
          } else {
            self.load_balancer.remove_connection(&uri);
          }
        } else {
          if !self.core.is_running().await {
            return Err(ZmqError::InvalidState(
              "Socket terminated while waiting for peer".into(),
            ));
          }
          match timeout_opt {
            Some(duration) if duration.is_zero() => return Err(ZmqError::ResourceLimitReached),
            None => self.load_balancer.wait_for_connection().await,
            Some(duration) => match tokio_timeout(duration, self.load_balancer.wait_for_connection()).await {
              Ok(()) => {}
              Err(_) => return Err(ZmqError::Timeout),
            },
          }
        }
      };
    }

    let conn_iface: Arc<dyn ISocketConnection> = {
      let core_s_read = self.core_state_read();
      match core_s_read.endpoints.get(&target_endpoint_uri_for_state_update) {
        Some(ep_info) => ep_info.connection_iface.clone(),
        None => {
          self
            .load_balancer
            .remove_connection(&target_endpoint_uri_for_state_update);
          return Err(ZmqError::HostUnreachable(format!(
            "REQ: Peer at {} disappeared before send",
            target_endpoint_uri_for_state_update
          )));
        }
      }
    };

    let mut empty_delimiter = Msg::new();
    empty_delimiter.set_flags(MsgFlags::MORE);
    let zmtp_frames_to_send = vec![empty_delimiter, msg];
    let send_result = conn_iface.send_multipart(zmtp_frames_to_send).await;

    match send_result {
      Ok(()) => {
        let mut current_state_guard = self.state.lock().await;
        *current_state_guard = ReqState::ExpectingReply {
          target_endpoint_uri: target_endpoint_uri_for_state_update.clone(),
        };
        self.incoming_orchestrator.reset_recv_message_buffer().await;
        Ok(())
      }
      Err(ZmqError::ConnectionClosed) => { // Renamed variable 'e' to avoid conflict if used later
        self
          .load_balancer
          .remove_connection(&target_endpoint_uri_for_state_update);
        Err(ZmqError::HostUnreachable(format!(
          "REQ: Connection to {} closed during send",
          target_endpoint_uri_for_state_update
        )))
      }
      Err(e) => Err(e),
    }
  }

  async fn recv(&self) -> Result<Msg, ZmqError> {
    if !self.core.is_running().await {
        // Initial check, more checks inside select if notifier fires
        return Err(ZmqError::InvalidState("Socket is closing".into()));
    }

    let rcvtimeo_opt: Option<Duration> = { self.core.core_state.read().options.rcvtimeo };

    { // Scope for state_guard
        let op_state_guard = self.state.lock().await;
        if !matches!(*op_state_guard, ReqState::ExpectingReply { .. }) {
            return Err(ZmqError::InvalidState("REQ socket must call send() before receiving"));
        }
    } // Lock released

    let notifier = self.reply_available_notifier.clone();
    
    // Define transform_fn for the main orchestrator call
    let transform_fn_main = |q_item: Vec<Msg>| q_item;
    let orchestrator_fut = self.incoming_orchestrator
        .recv_message(rcvtimeo_opt, transform_fn_main);

    let received_msg_result: Result<Msg, ZmqError>;

    tokio::select! {
        biased; // Prioritize notifier branch

        _ = notifier.notified() => {
            if !self.core.is_running().await {
                tracing::debug!("REQ recv: Notifier signaled, core not running. Exiting due to close.");
                received_msg_result = Err(ZmqError::ConnectionClosed);
            } else {
                // Core is running. Notification might be for message arrival or state change.
                // Poll orchestrator with zero timeout to check for an immediate message.
                let transform_fn_poll = |q_item: Vec<Msg>| q_item;
                match self.incoming_orchestrator.recv_message(Some(Duration::ZERO), transform_fn_poll).await {
                    Ok(msg) => {
                        received_msg_result = Ok(msg);
                    }
                    Err(ZmqError::Timeout) => {
                        // No immediate message. Check if state was reset (e.g., by pipe_detached).
                        let state_guard = self.state.lock().await;
                        if matches!(*state_guard, ReqState::ReadyToSend) {
                            tracing::warn!("REQ recv: Notifier signaled, no immediate message. State is ReadyToSend (likely peer disconnect or request aborted).");
                            received_msg_result = Err(ZmqError::ConnectionClosed); // Or a more specific error
                        } else {
                            tracing::error!("REQ recv: Notifier signaled, no immediate message, but still ExpectingReply. Treating as interruption.");
                            received_msg_result = Err(ZmqError::Internal("Receive operation interrupted by notification without immediate data.".into()));
                        }
                    }
                    Err(e) => { // Other error from orchestrator (e.g., QueueClosed)
                        received_msg_result = Err(e);
                    }
                }
            }
        }

        res = orchestrator_fut => {
            received_msg_result = res;
        }
    }

    // State update logic
    if let Ok(ref msg) = received_msg_result {
        if !msg.is_more() { // Last part of the logical message
            let mut state_guard = self.state.lock().await;
            // Only transition if still ExpectingReply; could have been changed by another path.
            if matches!(*state_guard, ReqState::ExpectingReply { .. }) {
                *state_guard = ReqState::ReadyToSend;
                self.reply_available_notifier.notify_waiters();
            }
        }
    } else if received_msg_result.is_err() {
        // On any error (Timeout, ContextTerminated, ConnectionClosed from notifier branch, QueueClosed from orchestrator, etc.)
        // reset state to allow a new request.
        let mut state_guard = self.state.lock().await;
        if matches!(*state_guard, ReqState::ExpectingReply { .. }) {
            *state_guard = ReqState::ReadyToSend;
            self.reply_available_notifier.notify_waiters();
        }
    }
    
    received_msg_result
  }

  async fn send_multipart(&self, _frames: Vec<Msg>) -> Result<(), ZmqError> {
    tracing::warn!(
      handle = self.core.handle,
      "REQ socket: send_multipart() called. REQ sockets should use send() for single-part requests."
    );
    Err(ZmqError::UnsupportedFeature(
      "REQ sockets use send() for single-part requests. Use DEALER for general multipart messaging.".into(),
    ))
  }

  async fn recv_multipart(&self) -> Result<Vec<Msg>, ZmqError> {
    if !self.core.is_running().await {
        return Err(ZmqError::InvalidState("Socket is closing".into()));
    }

    let rcvtimeo_opt: Option<Duration> = { self.core.core_state.read().options.rcvtimeo };

    { // Scope for state_guard
        let op_state_guard = self.state.lock().await;
        if !matches!(*op_state_guard, ReqState::ExpectingReply { .. }) {
            return Err(ZmqError::InvalidState(
                "REQ socket must call send() before receiving reply",
            ));
        }
    } // Lock released

    let notifier = self.reply_available_notifier.clone();

    // Define transform_fn for the main orchestrator call
    let transform_fn_main = |q_item: Vec<Msg>| q_item;
    let orchestrator_fut = self.incoming_orchestrator
        .recv_logical_message(rcvtimeo_opt, transform_fn_main);
    
    let received_msgs_result: Result<Vec<Msg>, ZmqError>;

    tokio::select! {
        biased; // Prioritize notifier branch

        _ = notifier.notified() => {
            if !self.core.is_running().await {
                tracing::debug!("REQ recv_multipart: Notifier signaled, core not running. Exiting due to close.");
                received_msgs_result = Err(ZmqError::ConnectionClosed);
            } else {
                // Core is running. Poll orchestrator.
                let transform_fn_poll = |q_item: Vec<Msg>| q_item;
                match self.incoming_orchestrator.recv_logical_message(Some(Duration::ZERO), transform_fn_poll).await {
                    Ok(msgs) => {
                        received_msgs_result = Ok(msgs);
                    }
                    Err(ZmqError::Timeout) => {
                        let state_guard = self.state.lock().await;
                        if matches!(*state_guard, ReqState::ReadyToSend) {
                            tracing::warn!("REQ recv_multipart: Notifier signaled, no immediate message. State is ReadyToSend (likely peer disconnect or request aborted).");
                            received_msgs_result = Err(ZmqError::ConnectionClosed);
                        } else {
                            tracing::error!("REQ recv_multipart: Notifier signaled, no immediate message, but still ExpectingReply. Treating as interruption.");
                            received_msgs_result = Err(ZmqError::Internal("Receive multipart operation interrupted by notification without immediate data.".into()));
                        }
                    }
                    Err(e) => {
                        received_msgs_result = Err(e);
                    }
                }
            }
        }

        res = orchestrator_fut => {
            received_msgs_result = res;
        }
    }

    // After receiving the full logical message (or erroring), transition state.
    { // Scope for state_guard before returning result
        let mut state_guard = self.state.lock().await;
        *state_guard = ReqState::ReadyToSend;
        // Notify waiters, as the state has changed, potentially unblocking other operations or just signaling completion.
        self.reply_available_notifier.notify_waiters(); 
    }

    received_msgs_result
  }

  async fn set_pattern_option(&self, option: i32, _value: &[u8]) -> Result<(), ZmqError> {
    Err(ZmqError::UnsupportedOption(option))
  }
  async fn get_pattern_option(&self, option: i32) -> Result<Vec<u8>, ZmqError> {
    Err(ZmqError::UnsupportedOption(option))
  }

  async fn process_command(&self, command: Command) -> Result<bool, ZmqError> {
    
    match command {
      Command::Stop => {
        self.reply_available_notifier.notify_waiters();
      }
      _ => return Ok(false),
    }
    
    Ok(true)
  }

  async fn handle_pipe_event(&self, pipe_read_id: usize, event: Command) -> Result<(), ZmqError> {
    match event {
      Command::PipeMessageReceived { msg, .. } => {
        let source_uri = { self.pipe_read_to_endpoint_uri.read().get(&pipe_read_id).cloned() };

        let source_uri = match source_uri {
          Some(s_uri) => s_uri,
          None => {
            tracing::warn!(
              handle = self.core.handle,
              pipe_id = pipe_read_id,
              "REQ received reply from unknown pipe (no URI mapping). Dropping frame."
            );
            return Ok(());
          }
        };

        let is_expected_reply = { // Removed notifier_clone_opt as it's not strictly needed here
          let op_state_guard = self.state.lock().await;
          match &*op_state_guard {
            ReqState::ExpectingReply { target_endpoint_uri } => *target_endpoint_uri == source_uri,
            ReqState::ReadyToSend => false,
          }
        };

        if !is_expected_reply {
          tracing::warn!(handle = self.core.handle, source_pipe_id = pipe_read_id, source_uri = %source_uri, "REQ received reply from unexpected peer or in wrong state. Dropping frame.");
          return Ok(());
        }

        if let Some(raw_zmtp_reply_vec) = self.incoming_orchestrator.accumulate_pipe_frame(pipe_read_id, msg)? {
          match self.process_incoming_zmtp_message_for_req(pipe_read_id, raw_zmtp_reply_vec) {
            Ok(reply_payload_parts) => {
              if self
                .incoming_orchestrator
                .queue_item(pipe_read_id, reply_payload_parts)
                .await
                .is_err()
              {
                tracing::error!(
                  handle = self.core.handle,
                  pipe_id = pipe_read_id,
                  "REQ: Failed to push reply to orchestrator queue."
                );
                // If queueing fails (e.g., orchestrator closed), transition state.
                let mut state_guard_err = self.state.lock().await;
                *state_guard_err = ReqState::ReadyToSend;
                self.reply_available_notifier.notify_waiters();
              } else {
                // Successfully queued item, notify any waiting recv/recv_multipart.
                self.reply_available_notifier.notify_one();
              }
            }
            Err(e) => {
              tracing::error!(
                handle = self.core.handle,
                pipe_id = pipe_read_id,
                "REQ: Error processing ZMTP reply: {}. Dropping.",
                e
              );
              // Consider if state should be reset here too. If processing fails, the reply is lost.
              // It might be safer to reset to ReadyToSend to allow a new request.
              let mut state_guard_err = self.state.lock().await;
              *state_guard_err = ReqState::ReadyToSend;
              self.reply_available_notifier.notify_waiters();
            }
          }
        }
      }
      _ => {}
    }
    Ok(())
  }

  async fn pipe_attached(&self, pipe_read_id: usize, _pipe_write_id: usize, _peer_identity: Option<&[u8]>) {
    let endpoint_uri_option = {
      self
        .core
        .core_state
        .read()
        .pipe_read_id_to_endpoint_uri
        .get(&pipe_read_id)
        .cloned()
    };
    if let Some(endpoint_uri) = endpoint_uri_option {
      tracing::debug!(handle = self.core.handle, pipe_read_id, uri = %endpoint_uri, "REQ attaching connection");
      self
        .pipe_read_to_endpoint_uri
        .write()
        .insert(pipe_read_id, endpoint_uri.clone());
      self.load_balancer.add_connection(endpoint_uri);
    } else {
      tracing::warn!(
        handle = self.core.handle,
        pipe_read_id,
        "REQ pipe_attached: Endpoint URI not found. Maps not updated."
      );
    }
  }

  async fn update_peer_identity(&self, pipe_read_id: usize, identity: Option<Blob>) {
    tracing::trace!(
      handle = self.core.handle,
      socket_type = "REQ",
      pipe_read_id,
      ?identity,
      "update_peer_identity called, REQ socket ignores it."
    );
  }

  async fn pipe_detached(&self, pipe_read_id: usize) {
    tracing::debug!(handle = self.core.handle, pipe_read_id, "REQ detaching pipe");
    let maybe_endpoint_uri = self.pipe_read_to_endpoint_uri.write().remove(&pipe_read_id);

    if let Some(detached_uri) = maybe_endpoint_uri {
      self.load_balancer.remove_connection(&detached_uri);
      let mut op_state_guard = self.state.lock().await;
      if let ReqState::ExpectingReply {
        ref target_endpoint_uri,
      } = *op_state_guard
      {
        if *target_endpoint_uri == detached_uri {
          tracing::warn!(handle = self.core.handle, pipe_id = pipe_read_id, uri = %detached_uri, "Target REP peer detached while REQ was expecting reply. Resetting state and notifying recv.");
          *op_state_guard = ReqState::ReadyToSend;
          // Notify any waiting recv/recv_multipart that the state has changed abortively.
          self.reply_available_notifier.notify_one(); 
        }
      }
    }
    self.incoming_orchestrator.clear_pipe_state(pipe_read_id).await;
  }
}