path: root/doc
diff options
authorAnatoly Burakov <>2019-05-03 12:50:50 +0100
committerThomas Monjalon <>2019-05-09 17:50:59 +0200
commitbfbc3a50416419d79c9cbe7868d1e9901919c346 (patch)
treed66039413757a697d642f97c6dcd14a56cd6b813 /doc
parent3855b4150037142435b5c1f4195e44c142785f1f (diff)
ipc: add warnings about correct API usage
When handling synchronous or asynchronous requests, the reply must be sent explicitly even if the result of the operation is an error, to avoid the other side timing out. Make note of this in documentation explicitly. Cc: Signed-off-by: Anatoly Burakov <>
Diffstat (limited to 'doc')
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index 63d08b6..a84083b 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -309,6 +309,13 @@ If a response is required, a new ``rte_mp_msg`` message descriptor must be
constructed and sent via ``rte_mp_reply()`` function, along with ``peer``
pointer. The resulting response will then be delivered to the correct requestor.
+.. warning::
+ Simply returning a value when processing a request callback will not send a
+ response to the request - it must always be explicitly sent even in case
+ of errors. Implementation of error signalling rests with the application,
+ there is no built-in way to indicate success or error for a request. Failing
+ to do so will cause the requestor to time out while waiting on a response.
Misc considerations