summaryrefslogtreecommitdiffstats
path: root/include/protocol.h
diff options
context:
space:
mode:
authorGravatar Ramūnas Mažeikis <ramunasnezinomas@gmail.com> 2019-05-22 21:35:46 +0300
committerGravatar Ramūnas Mažeikis <ramunasnezinomas@gmail.com> 2019-05-22 21:35:46 +0300
commit446157d793c30386f994743f5a8e6ab64e66507f (patch)
treef3c2e47ee76088306911deeaf0efc847615f07fa /include/protocol.h
parent323292cb8a1191e1c74c7d42c6e54f589d8023d1 (diff)
downloadusurpation-446157d793c30386f994743f5a8e6ab64e66507f.tar.gz
usurpation-446157d793c30386f994743f5a8e6ab64e66507f.tar.bz2
usurpation-446157d793c30386f994743f5a8e6ab64e66507f.zip
Protocol: updated docs for functions that survived redesign.
Signed-off-by: Ramūnas Mažeikis <ramunasnezinomas@gmail.com>
Diffstat (limited to 'include/protocol.h')
-rw-r--r--include/protocol.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/protocol.h b/include/protocol.h
index 1f941a4..cd28e2d 100644
--- a/include/protocol.h
+++ b/include/protocol.h
@@ -111,6 +111,11 @@ int get_tlv(struct tlv_parser *parser, struct tlv *ret);
/**
* Appends data to the next packet to be sent. Type of data is determined by
* enum tlv_type.
+ *
+ * In case of overflow return E_TLV_OVERFLOW.
+ *
+ * Overflow can be detected after forming tlv header. This means that the
+ * packet may have changes.
* */
int push_data(struct tlv_packet *packet, enum tlv_type type, char *data);