synd-api 0.4.0

syndicationd backend api
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

use synd_protocol::{
    CapabilitySet,
    session::{SessionId, SessionLease},
};

use super::{
    idle_shutdown::DaemonSessionsEffect,
    state::{SessionLeaseDeadline, SessionRenewChange, SessionRenewState, SessionSweepChange},
};

/// Inputs used to decide whether a session open request can be accepted.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) struct SessionOpenContext {
    required_capabilities: CapabilitySet,
    supported_capabilities: CapabilitySet,
}

impl SessionOpenContext {
    pub(super) fn new(
        required_capabilities: CapabilitySet,
        supported_capabilities: CapabilitySet,
    ) -> Self {
        Self {
            required_capabilities,
            supported_capabilities,
        }
    }
}

/// Branch selected for a session open request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) enum SessionOpenDecision {
    Accept {
        available_capabilities: CapabilitySet,
    },
    RejectMissingCapabilities {
        missing_capabilities: CapabilitySet,
    },
}

impl From<SessionOpenContext> for SessionOpenDecision {
    fn from(context: SessionOpenContext) -> Self {
        let missing_capabilities = context
            .required_capabilities
            .missing_from(&context.supported_capabilities);

        if missing_capabilities.is_empty() {
            Self::Accept {
                available_capabilities: context.supported_capabilities,
            }
        } else {
            Self::RejectMissingCapabilities {
                missing_capabilities,
            }
        }
    }
}

/// Inputs used to decide whether a session renew request can be accepted.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) struct SessionRenewContext {
    session_id: SessionId,
    lease: SessionLease,
    lease_deadline: SessionLeaseDeadline,
    renew: SessionRenewChange,
}

impl SessionRenewContext {
    pub(super) fn new(
        session_id: SessionId,
        lease: SessionLease,
        lease_deadline: SessionLeaseDeadline,
        renew: SessionRenewChange,
    ) -> Self {
        Self {
            session_id,
            lease,
            lease_deadline,
            renew,
        }
    }
}

/// Branch selected for a session renew request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) enum SessionRenewDecision {
    Accept {
        session_id: SessionId,
        lease: SessionLease,
        lease_deadline: SessionLeaseDeadline,
    },
    RejectExpiredSession {
        session_id: SessionId,
        effect: DaemonSessionsEffect,
    },
    RejectUnknownSession {
        session_id: SessionId,
    },
}

impl From<SessionRenewContext> for SessionRenewDecision {
    fn from(context: SessionRenewContext) -> Self {
        match context.renew.state {
            SessionRenewState::Renewed => Self::Accept {
                session_id: context.session_id,
                lease: context.lease,
                lease_deadline: context.lease_deadline,
            },
            SessionRenewState::Expired => Self::RejectExpiredSession {
                session_id: context.session_id,
                effect: context.renew.effect,
            },
            SessionRenewState::Unknown => Self::RejectUnknownSession {
                session_id: context.session_id,
            },
        }
    }
}

/// Inputs used to decide whether a session close request can be accepted.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) struct SessionCloseContext {
    session_id: SessionId,
    known_session: bool,
    effect: DaemonSessionsEffect,
}

impl SessionCloseContext {
    pub(super) fn new(
        session_id: SessionId,
        known_session: bool,
        effect: DaemonSessionsEffect,
    ) -> Self {
        Self {
            session_id,
            known_session,
            effect,
        }
    }
}

/// Branch selected for a session close request.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) enum SessionCloseDecision {
    Accept { effect: DaemonSessionsEffect },
    RejectUnknownSession { session_id: SessionId },
}

impl From<SessionCloseContext> for SessionCloseDecision {
    fn from(context: SessionCloseContext) -> Self {
        if context.known_session {
            Self::Accept {
                effect: context.effect,
            }
        } else {
            Self::RejectUnknownSession {
                session_id: context.session_id,
            }
        }
    }
}

/// Branch selected after a daemon session sweep.
#[derive(Debug, Clone, PartialEq, Eq)]
pub(super) enum SessionSweepDecision {
    NoExpiredSessions {
        active_sessions: usize,
    },
    ExpiredSessions {
        expired_sessions: Vec<SessionId>,
        active_sessions: usize,
        effect: DaemonSessionsEffect,
    },
}

impl From<SessionSweepChange> for SessionSweepDecision {
    fn from(change: SessionSweepChange) -> Self {
        if change.expired_sessions.is_empty() {
            Self::NoExpiredSessions {
                active_sessions: change.active_sessions,
            }
        } else {
            Self::ExpiredSessions {
                expired_sessions: change.expired_sessions,
                active_sessions: change.active_sessions,
                effect: change.effect,
            }
        }
    }
}