From 446157d793c30386f994743f5a8e6ab64e66507f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ram=C5=ABnas=20Ma=C5=BEeikis?= Date: Wed, 22 May 2019 21:35:46 +0300 Subject: Protocol: updated docs for functions that survived redesign. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Ramūnas Mažeikis --- include/protocol.h | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'include') 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); -- cgit v1.2.3