summaryrefslogtreecommitdiff
path: root/opendc-omega/src/main/kotlin/nl/atlarge/opendc/kernel/omega/MessageContainer.kt
blob: 1554a9e6ceeb1d20f669e5867bbc4337abb78ec1 (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
67
68
/*
 * 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.kernel.omega

import nl.atlarge.opendc.kernel.messaging.Envelope
import nl.atlarge.opendc.kernel.messaging.Receipt
import nl.atlarge.opendc.kernel.time.Instant
import nl.atlarge.opendc.topology.Entity

/**
 * A wrapper around a message that has been scheduled for processing.
 *
 * @property message The message to wrap.
 * @property time The point in time to deliver the message.
 * @property sender The sender of the message.
 * @property destination The destination of the message.
 * @author Fabian Mastenbroek (f.s.mastenbroek@student.tudelft.nl)
 */
internal data class MessageContainer(override val message: Any,
									 val time: Instant,
									 override val sender: Entity<*>?,
									 override val destination: Entity<*>) : Envelope<Any>, Receipt {
	/**
	 * A flag to indicate the message has been canceled.
	 */
	override var canceled: Boolean = false

	/**
	 * A flag to indicate the message has been delivered.
	 */
	override var delivered: Boolean = false

	/**
	 * Cancel the message to prevent it from being received by an [Entity].
	 *
	 * @throws IllegalStateException if the message has already been delivered.
	 */
	override fun cancel() {
		if (delivered) {
			throw IllegalStateException("The message has already been delivered")
		}

		canceled = true
	}

}