summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlf Wiger <ulf@feuerlabs.com>2016-01-30 11:10:08 +0100
committerUlf Wiger <ulf@feuerlabs.com>2016-01-30 11:10:08 +0100
commit3d44dd4ca67427d859d65aec9c592cec3f67e921 (patch)
tree13226f893c2cf56ad19745eb5f094f1d2e40e978
parenta4be6f9a8451b22fe3fead90c67c45cbb7fa50a2 (diff)
downloadrvi_core-3d44dd4ca67427d859d65aec9c592cec3f67e921.tar.gz
typo in rvi_fragmentation.md
-rw-r--r--doc/rvi_fragmentation.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/rvi_fragmentation.md b/doc/rvi_fragmentation.md
index 077cb49..78362c9 100644
--- a/doc/rvi_fragmentation.md
+++ b/doc/rvi_fragmentation.md
@@ -44,10 +44,16 @@ Term | Meaning
## System Overview
The fragmentation support is intended to operate immediately on top of the transport
-layer. In
+layer. In essence, the sending side (Client) asks the fragmentation support to
+deliver a message. The fragmentation support determines whether fragmentation is
+needed. If it is, it will create a first fragment, encode it and send it to the
+receiving end (Server).
<img src="images/frag-overview.png" alt="Overview" style="width:600">
+The fragmentation support can operate over a transport using its own fragment/reassembly
+method (such as TCP), but does not require it, or makes any such assumptions.
+
## Notation
The fragmentation protocol does not specify any particular encoding method.
@@ -56,6 +62,8 @@ encoding, like msgpack [MSGP] would be more suitable.
## Messages
+<img src="images/rvi_protocol_frag1.png"
+
The fragment messages are deliberately compact, in order to steal as little of
the available transfer window from the fragment itself.
@@ -109,7 +117,7 @@ Code or range | Definition
--------------| ----------------------
`0` | Message was successfully transfered and reassembled
`-99 ... -1` | Reserved for standard error codes
-`-1` | Unknown message (i.e. in a `"frg-err"` response to a `"fgr-get"` message)
+`-1` | Unknown message (i.e. in a `"frg-err"` response to a `"frg-get"` message)
`-2` | Protocol error
`-3` | Timeout error
`< -99` | Application-defined error codes