summaryrefslogtreecommitdiff
path: root/src/main
diff options
context:
space:
mode:
Diffstat (limited to 'src/main')
-rw-r--r--src/main/kotlin/OutMessage.kt (renamed from src/main/kotlin/Message.kt)8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/main/kotlin/Message.kt b/src/main/kotlin/OutMessage.kt
index 5007c26..dcb3705 100644
--- a/src/main/kotlin/Message.kt
+++ b/src/main/kotlin/OutMessage.kt
@@ -2,11 +2,11 @@ import java.math.BigInteger
import kotlin.math.pow
/**
- * A 9P message with the given type, tag, and fields. The message size is calculated automatically.
+ * An outgoing 9P message with the given type, tag, and fields. The message size is calculated automatically.
*
* Important note: the field names in [fieldValuesInt] and [fieldValuesStr] (i.e. the keys of their maps) must be
- * mutually exclusive and the union of these two maps' keys must result in a subset of (or a set equal to)
- * [fieldNames]. Calling [write] when these conditions are not met throws an exception.
+ * mutually exclusive and the union of these two maps' keys must result in a subset of (or a set equal to) [fieldNames].
+ * Calling [write] when these conditions are not met throws an exception.
*
* @param type The 9P message type.
* @param tag The tag given to the message.
@@ -14,7 +14,7 @@ import kotlin.math.pow
* @param fieldValuesInt A map of each field name into its value. This map only stores integer values.
* @param fieldValuesStr A map of each field name into its value. This map only stores string values.
*/
-class Message(val type: NinePMessageType, val tag: UShort, val fieldNames: List<String>, val fieldValuesInt: Map<String, BigInteger>, val fieldValuesStr: Map<String, String>, val maxSize: UInt) {
+class OutMessage(val type: NinePMessageType, val tag: UShort, val fieldNames: List<String>, val fieldValuesInt: Map<String, BigInteger>, val fieldValuesStr: Map<String, String>, val maxSize: UInt) {
/**
* Intersection between [fieldNames] and [fieldValuesInt]. In other words: the amount of integer fields that are
* going to be used when writing the message.