aboutsummaryrefslogtreecommitdiff
path: root/plugins/framing_fixedlength.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/framing_fixedlength.md')
-rw-r--r--plugins/framing_fixedlength.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/plugins/framing_fixedlength.md b/plugins/framing_fixedlength.md
new file mode 100644
index 0000000..bd095c4
--- /dev/null
+++ b/plugins/framing_fixedlength.md
@@ -0,0 +1,9 @@
+# The `fixedlength` framing function
+
+The `fixedlength` peer stream framing function segments the peer stream into binary frames
+at fixed byte boundaries (for example, aggregating and then sending 32-byte fragments from the
+peer stream).
+
+## Configuration
+
+The framing configuration string is simply the length of the segments to transmit in bytes.