drasi-core 0.4.2

Drasi Core
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

// Copyright 2024 The Drasi 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.

use async_trait::async_trait;

use crate::models::{ElementReference, ElementTimestamp};

use super::IndexError;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PushType {
    Always,
    IfNotExists,
    Overwrite,
}

#[derive(Debug, Clone, Hash, PartialEq, Eq)]
pub struct FutureElementRef {
    pub element_ref: ElementReference,
    pub original_time: ElementTimestamp,
    pub due_time: ElementTimestamp,
    pub group_signature: u64,
}

#[async_trait]
pub trait FutureQueue: Send + Sync {
    async fn push(
        &self,
        push_type: PushType,
        position_in_query: usize,
        group_signature: u64,
        element_ref: &ElementReference,
        original_time: ElementTimestamp,
        due_time: ElementTimestamp,
    ) -> Result<bool, IndexError>;

    async fn remove(
        &self,
        position_in_query: usize,
        group_signature: u64,
    ) -> Result<(), IndexError>;

    async fn pop(&self) -> Result<Option<FutureElementRef>, IndexError>;

    async fn peek_due_time(&self) -> Result<Option<ElementTimestamp>, IndexError>;

    async fn clear(&self) -> Result<(), IndexError>;
}

#[async_trait]
pub trait FutureQueueConsumer: Send + Sync {
    /// Called when the polling loop determines items are due.
    /// The consumer is responsible for calling `ContinuousQuery::process_due_futures()`
    /// internally, which atomically pops and processes within a session.
    async fn on_items_due(&self) -> Result<(), Box<dyn std::error::Error + Send + Sync>>;

    /// Called when `on_items_due` returns an error.
    async fn on_error(&self, error: Box<dyn std::error::Error + Send + Sync>);

    /// Returns the current time in milliseconds since epoch.
    /// Retained so tests can override the clock via `AutoFutureQueueConsumer::with_now_override()`.
    fn now(&self) -> u64;
}