summaryrefslogtreecommitdiff
path: root/opendc-stdlib/src/main/kotlin/nl/atlarge/opendc/scheduler/Scheduler.kt
blob: 8c96341a9e335d415e65d22048b073f0167d38bd (plain)
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
/*
 * MIT License
 *
 * Copyright (c) 2017 atlarge-research
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package nl.atlarge.opendc.scheduler

import nl.atlarge.opendc.kernel.Context
import nl.atlarge.opendc.topology.Entity
import nl.atlarge.opendc.topology.machine.Machine
import nl.atlarge.opendc.workload.Task

/**
 * A task scheduler that is coupled to an [Entity] in the topology of the cloud network.
 *
 * @author Fabian Mastenbroek (f.s.mastenbroek@student.tudelft.nl)
 */
interface Scheduler {
	/**
	 * (Re)schedule the tasks submitted to the scheduler over the specified set of machines.
	 *
	 * This method should be invoked at some interval to allow the scheduler to reschedule existing tasks and schedule
	 * new tasks.
	 */
	suspend fun <E: Entity<*>> Context<E>.schedule()

	/**
	 * Submit a [Task] to this scheduler.
	 *
	 * @param task The task to submit to the scheduler.
	 */
	fun submit(task: Task)

	/**
	 * Register a [Machine] to this scheduler.
	 *
	 * @param machine The machine to register.
	 */
	fun register(machine: Machine)

	/**
	 * Deregister a [Machine] from this scheduler.
	 *
	 * @param machine The machine to deregister.
	 */
	fun deregister(machine: Machine)
}