LUDOC-297 protocol: Update protocol document

[doc/protocol.git] / struct_mgs_config_res.txt

diff --git a/struct_mgs_config_res.txt b/struct_mgs_config_res.txt
new file mode 100644 (file)
index 0000000..d38d281
--- /dev/null
+++ b/struct_mgs_config_res.txt
@@ -0,0 +1,18 @@
+.MGS Configuration Result
+[[struct-mgs-config-res]]
+****
+[source,c]
+----
+struct mgs_config_res {
+        __u64    mcr_offset;    /* index of last config log */
+        __u64    mcr_size;      /* size of the log */
+};
+----
+
+The 'mgs_config_res' structure returns information describing the
+replied configuration llog data requested in 'mgs_config_body'.
+'mcr_offset' contains the last configuration record number returned
+by this reply.  'mcr_size' contains the maximum record index in the
+entire configuration llog.  When 'mcr_offset' equals 'mcr_size' there
+are no more records to process in the log.
+****