Skip to content

Commit fff4e60

Browse files
AdmissionPolicy (#51)
📝 Description Rename ControllerAdmission to AdmissionPolicy Resolve: #48
1 parent eb55714 commit fff4e60

5 files changed

Lines changed: 16 additions & 16 deletions

File tree

src/controller/admission.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
1616
/// Policy controlling how new submissions are handled when a slot is busy.
1717
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
18-
pub enum ControllerAdmission {
18+
pub enum AdmissionPolicy {
1919
/// Skip task if already running.
2020
///
2121
/// Use when:

src/controller/core.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ use crate::{
1313
};
1414

1515
use super::{
16-
admission::ControllerAdmission,
16+
admission::AdmissionPolicy,
1717
config::ControllerConfig,
1818
error::ControllerError,
1919
slot::{SlotState, SlotStatus},
@@ -154,7 +154,7 @@ impl Controller {
154154
.with_reason(format!("admission={:?} status=running", admission)),
155155
);
156156
}
157-
(SlotStatus::Running { .. }, ControllerAdmission::Replace) => {
157+
(SlotStatus::Running { .. }, AdmissionPolicy::Replace) => {
158158
Self::replace_head_or_push(&mut slot, task_spec);
159159
slot.status = SlotStatus::Terminating {
160160
cancelled_at: Instant::now(),
@@ -177,7 +177,7 @@ impl Controller {
177177
.with_reason(format!("admission=Replace depth={}", slot.queue.len())),
178178
);
179179
}
180-
(SlotStatus::Running { .. }, ControllerAdmission::Queue) => {
180+
(SlotStatus::Running { .. }, AdmissionPolicy::Queue) => {
181181
if self.reject_if_full(&slot_name, slot.queue.len()) {
182182
return;
183183
}
@@ -188,7 +188,7 @@ impl Controller {
188188
.with_reason(format!("admission=Queue depth={}", slot.queue.len())),
189189
);
190190
}
191-
(SlotStatus::Terminating { .. }, ControllerAdmission::Replace) => {
191+
(SlotStatus::Terminating { .. }, AdmissionPolicy::Replace) => {
192192
Self::replace_head_or_push(&mut slot, task_spec);
193193
self.bus.publish(
194194
Event::new(EventKind::ControllerSubmitted)
@@ -199,7 +199,7 @@ impl Controller {
199199
)),
200200
);
201201
}
202-
(SlotStatus::Terminating { .. }, ControllerAdmission::Queue) => {
202+
(SlotStatus::Terminating { .. }, AdmissionPolicy::Queue) => {
203203
if self.reject_if_full(&slot_name, slot.queue.len()) {
204204
return;
205205
}
@@ -213,7 +213,7 @@ impl Controller {
213213
)),
214214
);
215215
}
216-
(SlotStatus::Running { .. }, ControllerAdmission::DropIfRunning) => {}
216+
(SlotStatus::Running { .. }, AdmissionPolicy::DropIfRunning) => {}
217217
_ => {
218218
if self.reject_if_full(&slot_name, slot.queue.len()) {
219219
return;

src/controller/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
//!
102102
//! - Configure via `Supervisor::builder(..).with_controller(ControllerConfig)`.
103103
//! - Submit via `sup.submit(ControllerSpec::{queue, replace, drop_if_running}(...))`.
104-
//! - Policies: [`ControllerAdmission`] = `Queue | Replace | DropIfRunning`.
104+
//! - Policies: [`AdmissionPolicy`] = `Queue | Replace | DropIfRunning`.
105105
//! - Controller emits `ControllerSubmitted`, `ControllerRejected`, and
106106
//! `ControllerSlotTransition` (feature `"controller"`); readable with `"logging"`’s `LogWriter`.
107107
//!
@@ -117,7 +117,7 @@ mod error;
117117
mod slot;
118118
mod spec;
119119

120-
pub use admission::ControllerAdmission;
120+
pub use admission::AdmissionPolicy;
121121
pub use config::ControllerConfig;
122122
pub use core::Controller;
123123
pub use error::ControllerError;

src/controller/spec.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use super::admission::ControllerAdmission;
1+
use super::admission::AdmissionPolicy;
22
use crate::TaskSpec;
33

44
/// Request to submit a task to the controller.
@@ -7,7 +7,7 @@ use crate::TaskSpec;
77
#[derive(Clone)]
88
pub struct ControllerSpec {
99
/// Admission policy.
10-
pub admission: ControllerAdmission,
10+
pub admission: AdmissionPolicy,
1111

1212
/// Task specification to run.
1313
pub task_spec: TaskSpec,
@@ -19,7 +19,7 @@ impl ControllerSpec {
1919
/// ## Parameters
2020
/// - `admission`: How to handle concurrent submissions
2121
/// - `task_spec`: The task to execute
22-
pub fn new(admission: ControllerAdmission, task_spec: TaskSpec) -> Self {
22+
pub fn new(admission: AdmissionPolicy, task_spec: TaskSpec) -> Self {
2323
Self {
2424
admission,
2525
task_spec,
@@ -34,16 +34,16 @@ impl ControllerSpec {
3434
/// Convenience: Queue admission.
3535
#[inline]
3636
pub fn queue(task_spec: TaskSpec) -> Self {
37-
Self::new(ControllerAdmission::Queue, task_spec)
37+
Self::new(AdmissionPolicy::Queue, task_spec)
3838
}
3939

4040
#[inline]
4141
pub fn replace(task_spec: TaskSpec) -> Self {
42-
Self::new(ControllerAdmission::Replace, task_spec)
42+
Self::new(AdmissionPolicy::Replace, task_spec)
4343
}
4444

4545
#[inline]
4646
pub fn drop_if_running(task_spec: TaskSpec) -> Self {
47-
Self::new(ControllerAdmission::DropIfRunning, task_spec)
47+
Self::new(AdmissionPolicy::DropIfRunning, task_spec)
4848
}
4949
}

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ pub use tasks::{Task, TaskFn, TaskRef, TaskSpec};
169169
#[cfg(feature = "controller")]
170170
mod controller;
171171
#[cfg(feature = "controller")]
172-
pub use controller::{ControllerAdmission, ControllerConfig, ControllerError, ControllerSpec};
172+
pub use controller::{AdmissionPolicy, ControllerConfig, ControllerError, ControllerSpec};
173173

174174
// Optional: expose a simple built-in logger subscriber (demo/reference).
175175
// Enable with: `--features logging`

0 commit comments

Comments
 (0)