diff options
| author | Zoltan Kiss <zoltan.kiss@linaro.org> | 2015-07-01 18:06:11 +0100 |
|---|---|---|
| committer | Maxim Uvarov <maxim.uvarov@linaro.org> | 2015-07-06 15:14:22 +0300 |
| commit | 548a5d29e87fc1715fb245f9133b42fa879f7f2c (patch) | |
| tree | 490736985b1e7bf1bdb7663b475412a5d541d7c2 /include/odp/api/packet_io.h | |
| parent | 8d744646d21d2197322252cdd6bc8ef367fa453d (diff) | |
api: packet_io: clarify what happens when not all packets are sent
Clarify that the user owns all events not sent/enqueued successfully.
Currently our examples are not handling this situation as well.
Signed-off-by: Zoltan Kiss <zoltan.kiss@linaro.org>
Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
Diffstat (limited to 'include/odp/api/packet_io.h')
| -rw-r--r-- | include/odp/api/packet_io.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/include/odp/api/packet_io.h b/include/odp/api/packet_io.h index 3d42ee001..cd1c868c0 100644 --- a/include/odp/api/packet_io.h +++ b/include/odp/api/packet_io.h @@ -153,6 +153,11 @@ int odp_pktio_recv(odp_pktio_t pktio, odp_packet_t pkt_table[], int len); /** * Send packets * + * Sends out a number of packets. A successful call returns the actual number of + * packets sent. If return value is less than 'len', the remaining packets at + * the end of pkt_table[] are not consumed, and the caller has to take care of + * them. + * * @param pktio Packet IO handle * @param pkt_table[] Array of packets to send * @param len length of pkt_table[] |