Skip to main content

kafka_client_engine/consumer/assigned_host/
claim.rs

1//! One-shot transfer of the sole assigned-consumer application capability.
2
3use std::sync::{Arc, Mutex};
4
5use super::{
6    handle::AssignedConsumerHandle, shard::AssignedConsumerPort, state::AssignedConsumerShardState,
7};
8
9/// Immediate failure to claim the engine's unique assigned consumer.
10#[derive(Clone, Copy, Debug, Eq, PartialEq)]
11pub enum AssignedConsumerClaimError {
12    /// Another clone of the same engine already claimed the consumer.
13    AlreadyClaimed,
14    /// The internal claim lock was poisoned before ownership could transfer.
15    Poisoned,
16}
17
18impl std::fmt::Display for AssignedConsumerClaimError {
19    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
20        match self {
21            Self::AlreadyClaimed => formatter.write_str("assigned consumer was already claimed"),
22            Self::Poisoned => formatter.write_str("assigned-consumer claim lock was poisoned"),
23        }
24    }
25}
26
27impl std::error::Error for AssignedConsumerClaimError {}
28
29/// Clone-shared slot whose port can cross the application boundary once.
30pub(crate) struct AssignedConsumerClaimSlot {
31    port: Mutex<Option<AssignedConsumerPort>>,
32}
33
34impl AssignedConsumerClaimSlot {
35    pub(crate) fn create_for_engine(
36        port: AssignedConsumerPort,
37    ) -> (Self, AssignedConsumerAdmissionCloser) {
38        let closer = AssignedConsumerAdmissionCloser {
39            shared: Arc::clone(&port.shared),
40        };
41        (
42            Self {
43                port: Mutex::new(Some(port)),
44            },
45            closer,
46        )
47    }
48
49    pub(crate) fn claim(
50        &self,
51        lifetime: Arc<dyn Send + Sync>,
52    ) -> Result<AssignedConsumerHandle, AssignedConsumerClaimError> {
53        let mut port = self
54            .port
55            .lock()
56            .map_err(|_poisoned| AssignedConsumerClaimError::Poisoned)?;
57        let port = port
58            .take()
59            .ok_or(AssignedConsumerClaimError::AlreadyClaimed)?;
60        Ok(AssignedConsumerHandle::new(port, lifetime))
61    }
62}
63
64/// Shutdown-only admission fence retained after the application port transfers.
65pub(crate) struct AssignedConsumerAdmissionCloser {
66    shared: Arc<AssignedConsumerShardState>,
67}
68
69impl AssignedConsumerAdmissionCloser {
70    pub(crate) fn close(&self) -> Result<(), super::AssignedConsumerShardLockError> {
71        self.shared.close_assigned_admission()
72    }
73}