open-net 0.3.2

A cross-platform async networking library with WebSocket clients and network status monitoring.
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
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
//! The single state and completion authority shared by writer and receipts.
use crate::common::log::log_def::LogType;
use crate::error::{ErrorKind, NetError};
use crate::module::ws_client::native_pending::{DeferredTermination, NativePending};
use crate::module::ws_client::native_task_observer::TaskEventReservation;
use crate::module::ws_client::write::priority_write_queue::PriorityWriteQueue;
use crate::ws::cancellation::CancelHookGuard;
use crate::ws::{
    CancellationGroup, ClientId, ConnectionId, DeliveryEvidence, MessageLane, OperationId,
    OperationPhase, OperationSnapshot, RequestId, SendOptions, SessionId, TaskEndCause, TaskEvent,
    TaskSource, TaskSuccess, TerminationOutcome, WriteOutcome,
};
use crate::Result;
use std::sync::{Arc, Mutex, MutexGuard, Weak};
use std::time::Instant;
use tokio_util::sync::CancellationToken;

struct Observation {
    source: TaskSource,
    reservation: TaskEventReservation,
}

#[derive(Clone)]
struct PendingIdentity {
    table: Weak<NativePending>,
    id: RequestId,
    token: u64,
}

struct OperationState {
    snapshot: OperationSnapshot,
    connection: Option<ConnectionId>,
    response_deadline: Option<Instant>,
    observation: Option<Observation>,
    queue: Weak<PriorityWriteQueue>,
    pending: Option<PendingIdentity>,
    retirement: Option<CancellationToken>,
    hook: Option<CancelHookGuard>,
    data_in_flight: bool,
}

pub(crate) struct OperationControl {
    client_id: ClientId,
    session_id: SessionId,
    id: OperationId,
    lane: MessageLane,
    tracked: bool,
    deadline: Option<Instant>,
    group: Option<CancellationGroup>,
    state: Mutex<OperationState>,
    cancelled: CancellationToken,
    written: CancellationToken,
}

/// This value owns every side effect selected while a caller may hold a table lock.
/// Dispatch it after releasing all caller locks, on successful and failed decisions.
#[must_use]
#[derive(Default)]
pub(crate) struct OperationPublication {
    task: Option<(TaskEventReservation, TaskEvent)>,
    cancelled: Option<CancellationToken>,
    written: Option<CancellationToken>,
    retirement: Option<CancellationToken>,
    queue: Option<(Weak<PriorityWriteQueue>, CancellationToken, NetError)>,
    hook: Option<CancelHookGuard>,
    retired_error: Option<NetError>,
}

impl OperationPublication {
    pub(crate) fn dispatch(self) {
        let Self {
            task,
            cancelled,
            written,
            retirement,
            queue,
            hook,
            retired_error,
        } = self;
        // Queue ownership and its capacity retire before waking terminal waiters.
        if let Some((queue, token, error)) = queue {
            if let Some(queue) = queue.upgrade() {
                queue.cancel_queued_with_error(&token, error);
            }
        }
        drop((hook, retired_error));
        if let Some(token) = retirement {
            token.cancel();
        }
        if let Some(token) = cancelled {
            token.cancel();
        }
        if let Some((reservation, event)) = task {
            if let Err(error) = reservation.publish(event) {
                crate::log_e!(LogType::WSC; "operation_task_delivery", "error", format!("{error:?}"));
            }
        }
        if let Some(token) = written {
            token.cancel();
        }
    }
}

impl OperationControl {
    pub(crate) fn new(
        client_id: ClientId,
        session_id: SessionId,
        id: OperationId,
        options: &SendOptions,
        tracked: bool,
        source: TaskSource,
        reservation: TaskEventReservation,
    ) -> Arc<Self> {
        Arc::new(Self {
            client_id,
            session_id,
            id,
            lane: options.lane,
            tracked,
            deadline: options.deadline,
            group: options.cancellation.clone(),
            state: Mutex::new(OperationState {
                snapshot: OperationSnapshot {
                    phase: OperationPhase::WaitingForCapacity,
                    delivery: DeliveryEvidence::NotStarted,
                    result: None,
                },
                connection: None,
                response_deadline: None,
                observation: Some(Observation {
                    source,
                    reservation,
                }),
                queue: Weak::new(),
                pending: None,
                retirement: None,
                hook: None,
                data_in_flight: false,
            }),
            cancelled: CancellationToken::new(),
            written: CancellationToken::new(),
        })
    }

    pub(crate) fn id(&self) -> OperationId {
        self.id
    }
    pub(crate) fn session_id(&self) -> SessionId {
        self.session_id
    }
    pub(crate) fn has_request_registration(&self) -> bool {
        self.lock().pending.is_some()
    }
    pub(crate) fn cancel_token(&self) -> CancellationToken {
        self.cancelled.clone()
    }
    pub(crate) fn cancel_domain(&self) -> Option<&CancellationGroup> {
        self.group.as_ref()
    }
    pub(crate) fn absolute_deadline(&self) -> Option<Instant> {
        self.deadline
    }
    pub(crate) fn deadline(&self) -> Option<Instant> {
        earliest(self.deadline, self.lock().response_deadline)
    }
    pub(crate) fn set_response_deadline(&self, deadline: Option<Instant>) {
        self.lock().response_deadline = deadline;
    }
    pub(crate) fn bind_request(
        &self,
        table: Weak<NativePending>,
        id: RequestId,
        token: u64,
    ) -> Result<()> {
        let mut state = self.state.lock().map_err(NetError::from_poison)?;
        self.check_active(&state)?;
        if state.pending.is_some() {
            return Err(NetError::from(ErrorKind::Internal));
        }
        state.pending = Some(PendingIdentity { table, id, token });
        Ok(())
    }
    pub(crate) fn bind_queue(&self, queue: Weak<PriorityWriteQueue>) {
        self.lock().queue = queue;
    }
    pub(crate) fn bind_cancellation(self: &Arc<Self>) -> Result<()> {
        if let Some(group) = &self.group {
            let weak = Arc::downgrade(self);
            let hook = group.inner.bind_cancel_hook(Arc::new(move || {
                if let Some(control) = weak.upgrade() {
                    if let Err(error) = control.cancel() {
                        crate::log_e!(LogType::WSC; "operation_cancel", "error", format!("{error:?}"));
                    }
                }
            }))?;
            let mut state = self.lock();
            let retired = if state.snapshot.result.is_none() {
                state.hook.replace(hook)
            } else {
                Some(hook)
            };
            drop(state);
            drop(retired);
        }
        Ok(())
    }
    pub(crate) fn snapshot(&self) -> Result<OperationSnapshot> {
        Ok(self
            .state
            .lock()
            .map_err(NetError::from_poison)?
            .snapshot
            .clone())
    }
    pub(crate) fn is_finished(&self) -> bool {
        self.lock().snapshot.result.is_some()
    }
    pub(crate) fn response_confirmed(&self) -> bool {
        self.lock().snapshot.delivery == DeliveryEvidence::ResponseConfirmed
    }
    pub(crate) fn selected_error(&self) -> Option<NetError> {
        self.lock()
            .snapshot
            .result
            .as_ref()
            .and_then(|result| result.as_ref().err().cloned())
    }
    pub(crate) fn prepare(&self) -> Result<()> {
        let mut state = self.state.lock().map_err(NetError::from_poison)?;
        self.check_active(&state)?;
        if state.snapshot.phase != OperationPhase::WaitingForCapacity {
            return Err(NetError::from(ErrorKind::Internal));
        }
        state.snapshot.phase = OperationPhase::Prepared;
        Ok(())
    }
    pub(crate) fn enqueue(&self) -> Result<()> {
        let mut state = self.state.lock().map_err(NetError::from_poison)?;
        self.check_active(&state)?;
        if !matches!(
            state.snapshot.phase,
            OperationPhase::Prepared | OperationPhase::WaitingForCapacity
        ) {
            return Err(NetError::from(ErrorKind::InvalidInput));
        }
        state.snapshot.phase = OperationPhase::Queued;
        Ok(())
    }
    pub(crate) fn mark_writing(&self, connection: ConnectionId) -> bool {
        let mut state = self.lock();
        if self.check_active(&state).is_err() || state.snapshot.phase != OperationPhase::Queued {
            return false;
        }
        state.snapshot.phase = OperationPhase::Writing;
        state.connection = Some(connection);
        true
    }
    pub(crate) fn start_data_write(&self, continuation: bool) -> Result<bool> {
        // Response expiry belongs to the pending table: an already dispatched
        // Manual response may still own its one bounded claim grace. Refresh it
        // before taking the cancellation gate or operation lock.
        let pending = {
            let state = self.lock();
            if state.snapshot.result.is_none()
                && state
                    .response_deadline
                    .is_some_and(|deadline| Instant::now() >= deadline)
            {
                state.pending.clone()
            } else {
                None
            }
        };
        if let Some(identity) = pending {
            let table = identity
                .table
                .upgrade()
                .ok_or_else(|| NetError::from(ErrorKind::EngineDropped))?;
            table.refresh_response_deadline(&identity.id, identity.token)?;
        }
        let domain = match self
            .group
            .as_ref()
            .map(|group| group.inner.lock_if_active())
            .transpose()
        {
            Ok(guard) => guard,
            Err(_) => return Ok(false),
        };
        let mut state = self.lock();
        // A successful early response settles the request, not the framing of
        // its current wire message. Finish continuation frames without reopening
        // the terminal result; writer and connection deadlines remain in force.
        let confirmed_continuation = continuation
            && state.snapshot.delivery == DeliveryEvidence::ResponseConfirmed
            && matches!(
                state.snapshot.result,
                Some(Ok(TaskSuccess::ResponseReceived))
            );
        let active = confirmed_continuation
            || (self.check_active_until(&state, self.deadline).is_ok()
                && state.snapshot.phase == OperationPhase::Writing);
        if active {
            state.data_in_flight = true;
            if state.snapshot.delivery == DeliveryEvidence::NotStarted {
                state.snapshot.delivery = DeliveryEvidence::Unknown;
            }
        }
        drop(state);
        drop(domain);
        Ok(active)
    }
    pub(crate) fn data_write_started(&self) -> bool {
        self.lock().data_in_flight
    }
    pub(crate) fn has_in_flight_data(&self) -> bool {
        let state = self.lock();
        state.data_in_flight
            && state.snapshot.delivery != DeliveryEvidence::ResponseConfirmed
            && state.snapshot.delivery != DeliveryEvidence::Written
    }
    pub(crate) fn bind_write_retirement(&self, retirement: CancellationToken) {
        let mut state = self.lock();
        let cancelled =
            state.data_in_flight && state.snapshot.result.as_ref().is_some_and(Result::is_err);
        let previous = state.retirement.replace(retirement.clone());
        drop(state);
        drop(previous);
        if cancelled {
            retirement.cancel();
        }
    }
    pub(crate) fn retire_write(&self) {
        let token = self.lock().retirement.clone();
        if let Some(token) = token {
            token.cancel();
        }
    }
    pub(crate) fn requeue(&self) -> bool {
        let mut state = self.lock();
        if self.check_active(&state).is_err() || state.snapshot.phase != OperationPhase::Writing {
            return false;
        }
        state.snapshot.phase = OperationPhase::Queued;
        state.data_in_flight = false;
        let retired = state.retirement.take();
        drop(state);
        drop(retired);
        true
    }
    pub(crate) fn select_written(&self) -> (bool, OperationPublication) {
        let _domain_guard = match self
            .group
            .as_ref()
            .map(|group| group.inner.lock_if_active())
            .transpose()
        {
            Ok(guard) => guard,
            Err(error) => return (false, self.select_failure(error, TaskEndCause::Cancelled).1),
        };
        let mut publication = OperationPublication::default();
        let mut state = self.lock();
        if state.snapshot.result.is_some() {
            return (
                state.snapshot.delivery == DeliveryEvidence::ResponseConfirmed,
                publication,
            );
        }
        if let Err(error) = self.check_active(&state) {
            drop(state);
            return (false, self.select_failure(error, TaskEndCause::Expired).1);
        }
        state.snapshot.delivery = DeliveryEvidence::Written;
        state.data_in_flight = false;
        publication.written = Some(self.written.clone());
        if self.tracked {
            state.snapshot.phase = OperationPhase::AwaitingResponse;
        } else {
            self.finish_locked(
                &mut state,
                Ok(TaskSuccess::Written),
                TaskEndCause::Completed,
                &mut publication,
            );
        }
        (true, publication)
    }
    pub(crate) fn select_response(&self) -> (bool, OperationPublication) {
        let _domain_guard = match self
            .group
            .as_ref()
            .map(|group| group.inner.lock_if_active())
            .transpose()
        {
            Ok(guard) => guard,
            Err(error) => return (false, self.select_failure(error, TaskEndCause::Cancelled).1),
        };
        let mut publication = OperationPublication::default();
        let mut state = self.lock();
        if state.snapshot.result.is_some() {
            return (false, publication);
        }
        if let Err(error) = self.check_active(&state) {
            drop(state);
            return (false, self.select_failure(error, TaskEndCause::Expired).1);
        }
        state.snapshot.delivery = DeliveryEvidence::ResponseConfirmed;
        state.data_in_flight = false;
        publication.written = Some(self.written.clone());
        self.finish_locked(
            &mut state,
            Ok(TaskSuccess::ResponseReceived),
            TaskEndCause::Completed,
            &mut publication,
        );
        (true, publication)
    }
    pub(crate) fn select_failure(
        &self,
        error: NetError,
        cause: TaskEndCause,
    ) -> (TerminationOutcome, OperationPublication) {
        let publication = OperationPublication {
            retired_error: Some(error.clone()),
            ..Default::default()
        };
        let mut state = self.lock();
        self.select_failure_locked(&mut state, error, cause, publication)
    }

    fn select_failure_locked(
        &self,
        state: &mut OperationState,
        error: NetError,
        cause: TaskEndCause,
        mut publication: OperationPublication,
    ) -> (TerminationOutcome, OperationPublication) {
        if state.snapshot.result.is_some() {
            return (TerminationOutcome::AlreadyFinished, publication);
        }
        let outcome = match state.snapshot.delivery {
            DeliveryEvidence::NotStarted => TerminationOutcome::TerminatedBeforeWrite,
            DeliveryEvidence::Unknown => TerminationOutcome::DeliveryUnknown,
            DeliveryEvidence::Written | DeliveryEvidence::ResponseConfirmed => {
                TerminationOutcome::TerminatedAfterWrite
            }
        };
        let mut context = error.context().clone();
        context.client_id = Some(self.client_id);
        context.session_id = Some(self.session_id);
        context.connection_id = state.connection.or(context.connection_id);
        if let Some(identity) = &state.pending {
            context.request_id = Some(identity.id.clone());
        }
        if context.stage.is_none() {
            context.stage = Some(match state.snapshot.phase {
                OperationPhase::WaitingForCapacity => crate::error::ErrorStage::Admission,
                OperationPhase::Prepared | OperationPhase::Queued => {
                    crate::error::ErrorStage::Queue
                }
                OperationPhase::Writing => crate::error::ErrorStage::Write,
                OperationPhase::AwaitingResponse => crate::error::ErrorStage::Response,
                OperationPhase::Finished => crate::error::ErrorStage::Dispatch,
            });
        }
        let error = error.with_context(context);
        let error = if state.snapshot.delivery == DeliveryEvidence::Unknown
            && error.kind() != ErrorKind::DeliveryUnknown
        {
            let context = error.context().clone();
            NetError::with_source(ErrorKind::DeliveryUnknown, error).with_context(context)
        } else {
            error
        };
        if state.data_in_flight {
            publication.retirement = state.retirement.clone();
        }
        publication.cancelled = Some(self.cancelled.clone());
        publication.queue = Some((state.queue.clone(), self.cancelled.clone(), error.clone()));
        publication.written = Some(self.written.clone());
        self.finish_locked(state, Err(error), cause, &mut publication);
        (outcome, publication)
    }
    fn finish_locked(
        &self,
        state: &mut OperationState,
        result: Result<TaskSuccess>,
        cause: TaskEndCause,
        publication: &mut OperationPublication,
    ) {
        let phase = state.snapshot.phase;
        state.snapshot.result = Some(result.clone());
        state.snapshot.phase = OperationPhase::Finished;
        if let Some(observation) = state.observation.take() {
            publication.task = Some((
                observation.reservation,
                TaskEvent {
                    client_id: self.client_id,
                    session_id: self.session_id,
                    operation_id: self.id,
                    connection_id: state.connection,
                    source: observation.source,
                    lane: self.lane,
                    phase,
                    delivery: state.snapshot.delivery,
                    cause,
                    result,
                },
            ));
        }
        publication.hook = state.hook.take();
    }
    pub(crate) fn cancel(&self) -> Result<TerminationOutcome> {
        self.terminate(
            NetError::from(ErrorKind::Cancelled),
            TaskEndCause::Cancelled,
        )
    }
    pub(crate) fn expire(&self) -> Result<TerminationOutcome> {
        self.terminate(NetError::from(ErrorKind::TimedOut), TaskEndCause::Expired)
    }
    /// Choose a queue retirement while Q is held, without executing side effects.
    /// Release C before acquiring P; a last strong pending owner travels out of Q.
    pub(crate) fn prepare_termination(
        &self,
        error: NetError,
        cause: TaskEndCause,
    ) -> DeferredTermination {
        let mut state = self.lock();
        if let Some(identity) = state.pending.clone() {
            drop(state);
            if let Some(table) = identity.table.upgrade() {
                let mut deferred = table.prepare_termination(
                    &identity.id,
                    identity.token,
                    error,
                    cause,
                    Some(self),
                );
                deferred.pending = Some(table);
                return deferred;
            }
            // Table Drop has begun. Only this original control is eligible, and
            // a previously selected response/cancellation remains the winner.
            let (_, publication) = self.select_failure(
                NetError::from(ErrorKind::EngineDropped),
                TaskEndCause::Shutdown,
            );
            return DeferredTermination {
                publication: Some(publication),
                retired_error: Some(error),
                ..Default::default()
            };
        }
        let publication = OperationPublication {
            retired_error: Some(error.clone()),
            ..Default::default()
        };
        let (outcome, publication) =
            self.select_failure_locked(&mut state, error, cause, publication);
        DeferredTermination {
            outcome: Some(outcome),
            publication: Some(publication),
            ..Default::default()
        }
    }

    pub(crate) fn terminate(
        &self,
        error: NetError,
        cause: TaskEndCause,
    ) -> Result<TerminationOutcome> {
        let mut state = self.lock();
        if let Some(identity) = state.pending.clone() {
            drop(state);
            if let Some(table) = identity.table.upgrade() {
                return table.terminate(&identity.id, identity.token, error, cause);
            }
            let (outcome, publication) = self.select_failure(error, cause);
            publication.dispatch();
            return Ok(outcome);
        }
        // Compete with request binding under the same lock: cancellation cannot
        // choose the message-only path and then leave a newly bound request live.
        let publication = OperationPublication {
            retired_error: Some(error.clone()),
            ..Default::default()
        };
        let (outcome, publication) =
            self.select_failure_locked(&mut state, error, cause, publication);
        drop(state);
        publication.dispatch();
        Ok(outcome)
    }
    pub(crate) async fn written(&self) -> Result<WriteOutcome> {
        self.written.cancelled().await;
        let state = self.state.lock().map_err(NetError::from_poison)?;
        match state.snapshot.delivery {
            DeliveryEvidence::ResponseConfirmed => Ok(WriteOutcome::ResponseConfirmed),
            DeliveryEvidence::Written => Ok(WriteOutcome::Written),
            _ => Err(state
                .snapshot
                .result
                .as_ref()
                .and_then(|result| result.as_ref().err())
                .cloned()
                .map_or_else(|| NetError::from(ErrorKind::Internal), |error| error)),
        }
    }
    fn check_active(&self, state: &OperationState) -> Result<()> {
        self.check_active_until(state, earliest(self.deadline, state.response_deadline))
    }
    fn check_active_until(&self, state: &OperationState, deadline: Option<Instant>) -> Result<()> {
        if let Some(result) = &state.snapshot.result {
            return Err(result
                .as_ref()
                .err()
                .cloned()
                .map_or_else(|| NetError::from(ErrorKind::Closed), |error| error));
        }
        if self
            .group
            .as_ref()
            .is_some_and(CancellationGroup::is_cancelled)
            || self.cancelled.is_cancelled()
        {
            return Err(NetError::from(ErrorKind::Cancelled));
        }
        if deadline.is_some_and(|deadline| Instant::now() >= deadline) {
            return Err(NetError::from(ErrorKind::TimedOut));
        }
        Ok(())
    }
    fn lock(&self) -> MutexGuard<'_, OperationState> {
        match self.state.lock() {
            Ok(state) => state,
            Err(poisoned) => {
                crate::log_e!(LogType::WSC; "operation_state", "error", "lock_poisoned_recovered");
                poisoned.into_inner()
            }
        }
    }
}

pub(crate) fn earliest(left: Option<Instant>, right: Option<Instant>) -> Option<Instant> {
    match (left, right) {
        (Some(left), Some(right)) => Some(left.min(right)),
        (left, right) => left.or(right),
    }
}