summaryrefslogtreecommitdiff
path: root/node/Packet.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'node/Packet.hpp')
-rw-r--r--node/Packet.hpp9
1 files changed, 8 insertions, 1 deletions
diff --git a/node/Packet.hpp b/node/Packet.hpp
index e0c702ce..6c1b2984 100644
--- a/node/Packet.hpp
+++ b/node/Packet.hpp
@@ -678,7 +678,14 @@ public:
* <[...] arbitrary payload to be echoed back>
*
* This generates OK with a copy of the transmitted payload. No ERROR
- * is generated. Response to ECHO requests is optional.
+ * is generated. Response to ECHO requests is optional and ECHO may be
+ * ignored if a node detects a possible flood.
+ *
+ * There is a de-facto standard for ECHO payload. No payload indicates an
+ * ECHO used for path confirmation. Otherwise the first byte contains
+ * flags, in which currently the only flag is 0x01 for a user-requested
+ * echo. For user-requested echoes the result may be reported back through
+ * the API. Otherwise the payload is for internal use.
*
* Support for fragmented echo packets is optional and their use is not
* recommended.