diff options
Diffstat (limited to 'lib/src/main/kotlin/ProtocolTranslator.kt')
| -rw-r--r-- | lib/src/main/kotlin/ProtocolTranslator.kt | 12 |
1 files changed, 3 insertions, 9 deletions
diff --git a/lib/src/main/kotlin/ProtocolTranslator.kt b/lib/src/main/kotlin/ProtocolTranslator.kt index fee52f4..8af0aea 100644 --- a/lib/src/main/kotlin/ProtocolTranslator.kt +++ b/lib/src/main/kotlin/ProtocolTranslator.kt @@ -1,13 +1,7 @@ -/* -TODO: - - add arguments to methods - - switch from returned strings to exceptions -*/ - /** - * The [ProtocolTranslator] interface provides methods that coincide 1:1 with each request type in the 9P protocol. - * Every method that can fail, that is, every request that can receive a response with `Rerror` type instead of the same - * type as itself, returns a non-null `String` that contains the error message received in the response. + * The [ProtocolTranslator] interface provides methods which represent, and enclose, full 9P transactions. A call to any + * of such methods requires filling in parameters, which coincide one-to-one with fields required by 9P requests. In an + * analogous way, the values returned from such methods calls reflects those received from 9P responses. * * Tags and the `msize` value are supposed to be managed internally by the implementing class. * |