summaryrefslogtreecommitdiff
path: root/src/main/kotlin/NinePConnection.kt
blob: 73ab5fa06d25d9652b0cb3b3a1ec06862ea279c3 (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
import java.io.IOException
import java.math.BigInteger

/**
 * This class represents a 9P connection. It provides a practical implementation with networking to the 9P methods
 * described in [NinePTranslator]. Details about methods related to 9P can be found in [NinePTranslator]. Remember to
 * disconnect using [disconnect] after use.
 *
 * Details about network-related topics can be found in [NetworkPacketTransporter] and the implementation of choice.
 *
 * Details about 9P messages and methods can be found in [NinePTranslator].
 *
 * @param netPackTrans The networking API backend of choice.
 *
 * @throws UnresolvableHostException if the host resolution made by [netPackTrans] failed.
 */
class NinePConnection(netPackTrans: NetworkPacketTransporter) : NinePTranslator {
    /**
     * Networking API.
     */
    val npt: NetworkPacketTransporter = netPackTrans

    /**
     * Disconnect from the remote host,
     *
     * @throws IOException if an I/O error occurred while closing the socket.
     */
    fun disconnect() {
        this.npt.close()
    }

    /**
     * Read an [nBytes]-long unsigned integer number from the connection.
     *
     * In 9P, binary numbers (non-textual) are specified in little-endian order (least significant byte first).
     *
     * @param nBytes The length of the integer number in bytes. It only works with unsigned numbers strictly greater
     *               than zero (zero is excluded).
     * @return The number's value.
     * @throws IllegalArgumentException if [nBytes] is zero or negative.
     */
    private fun readInteger(nBytes: Int): BigInteger {
        require(nBytes > 0)
        val bytes = this.npt.receiveFixed(nBytes.toULong())
        var number: BigInteger = BigInteger.valueOf(0)
        for (i in 0..<bytes.size) {
            number += bytes[i].toInt().toBigInteger().shl(i)
        }

        return number
    }

    /**
     * Read a string from the connection.
     *
     * In 9P, strings are represented as a 2-byte integer (the string's size) followed by the actual UTF-8 string. The
     * null terminator is forbidden in 9P messages.
     *
     * @return The string.
     */
    private fun readString(): String {
        val length = readInteger(2).toInt()
        return String(this.npt.receiveFixed(length.toULong()).toByteArray())
    }

    // TODO: implement methods from NinePTranslator
}