Skip to main content

bornera_core/admission/
permit.rs

1//! Affine capacity permits returned before protocol frame preparation.
2
3use core::fmt;
4use std::{cell::RefCell, rc::Rc};
5
6use calandria::Deadline;
7
8use crate::{AdmissionClass, CompletionMode, ConnectionEpoch, EffectId, MatchKey, OperationId};
9
10use super::{Reservation, ReservationLedger};
11
12/// An atomic reservation that rolls back all capacity when dropped.
13pub struct OperationPermit {
14    pub(crate) ledger: Rc<RefCell<ReservationLedger>>,
15    pub(crate) epoch: ConnectionEpoch,
16    pub(crate) operation: OperationId,
17    pub(crate) effect: EffectId,
18    pub(crate) deadline: Deadline,
19    pub(crate) class: AdmissionClass,
20    pub(crate) completion: CompletionMode,
21    pub(crate) reservation: Reservation,
22    pub(crate) active: bool,
23}
24
25impl OperationPermit {
26    /// Returns the reserved operation identity.
27    pub const fn operation_id(&self) -> OperationId {
28        self.operation
29    }
30
31    /// Returns the protocol-visible match key reserved for encoding.
32    pub const fn match_key(&self) -> MatchKey {
33        self.reservation.match_key
34    }
35
36    /// Returns the original absolute deadline.
37    pub const fn deadline(&self) -> Deadline {
38        self.deadline
39    }
40
41    pub(crate) fn commit(&mut self, actual: calandria::RetainedBytes) {
42        self.ledger.borrow_mut().commit(self.reservation, actual);
43        self.reservation.write_retained_bytes = actual;
44        self.active = false;
45    }
46}
47
48impl fmt::Debug for OperationPermit {
49    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
50        formatter
51            .debug_struct("OperationPermit")
52            .field("epoch", &self.epoch)
53            .field("operation", &self.operation)
54            .field("effect", &self.effect)
55            .field("deadline", &self.deadline)
56            .field("class", &self.class)
57            .field("completion", &self.completion)
58            .field("match_key", &self.reservation.match_key)
59            .field("active", &self.active)
60            .finish_non_exhaustive()
61    }
62}
63
64impl Drop for OperationPermit {
65    fn drop(&mut self) {
66        if self.active {
67            self.ledger.borrow_mut().rollback_permit(self.reservation);
68            self.active = false;
69        }
70    }
71}