summaryrefslogtreecommitdiff
path: root/lib/src/main/kotlin/ProtocolInitData.kt
diff options
context:
space:
mode:
Diffstat (limited to 'lib/src/main/kotlin/ProtocolInitData.kt')
-rw-r--r--lib/src/main/kotlin/ProtocolInitData.kt19
1 files changed, 19 insertions, 0 deletions
diff --git a/lib/src/main/kotlin/ProtocolInitData.kt b/lib/src/main/kotlin/ProtocolInitData.kt
new file mode 100644
index 0000000..351b289
--- /dev/null
+++ b/lib/src/main/kotlin/ProtocolInitData.kt
@@ -0,0 +1,19 @@
+/**
+ * Data for initializing the 9P protocol using [ProtocolTranslator.version], [ProtocolTranslator.auth], and
+ * [ProtocolTranslator.attach].
+ *
+ * @param msize A value for the `msize` field in the `version` message.
+ * @param version A value for the `version` field in the `version` message.
+ * @param uname A value for the `uname` field in the `auth` and `attach` messages.
+ * @param aname A value for the `aname` field in the `auth` and `attach` messages.
+ * @param rootFid A value for the root `fid` in the `attach` message.
+ * @param auth An [Authenticator] implementation used for authenticating the user.
+ */
+data class ProtocolInitData(
+ val msize: UInt,
+ val version: String,
+ val uname: String,
+ val aname: String,
+ val rootFid: UInt,
+ val auth: Authenticator
+) \ No newline at end of file