On 11/26/2014 07:11 PM, Mike Holmes wrote: > > > On 26 November 2014 at 12:03, Taras Kondratiuk > <taras.kondrat...@linaro.org <mailto:taras.kondrat...@linaro.org>> wrote: > > Signed-off-by: Taras Kondratiuk <taras.kondrat...@linaro.org > <mailto:taras.kondrat...@linaro.org>> > --- > platform/linux-generic/include/api/odp_queue.h | 9 +++++++++ > 1 file changed, 9 insertions(+) > > diff --git a/platform/linux-generic/include/api/odp_queue.h > b/platform/linux-generic/include/api/odp_queue.h > index b8ac4bb..3321950 100644 > --- a/platform/linux-generic/include/api/odp_queue.h > +++ b/platform/linux-generic/include/api/odp_queue.h > @@ -124,6 +124,15 @@ odp_queue_t odp_queue_create(const char *name, > odp_queue_type_t type, > odp_queue_param_t *param); > > /** > + * Destroy ODP queue > + * > > > Does it need the queue to be drained, will it drain the queue, will if > free buffers if it drains the queue. > does it wait if the queue is full > Are there any @warnings about its behaviour?
For v1.0 this function can have minimal functionality. Later we can extend it to ensure correct teardown sequence and simplify operations needed from application side. /** * Destroy ODP queue * * Destroys ODP queue. The queue must be empty and detached from other * ODP API (crypto, pktio, etc). Application must ensure that no * other operations on this queue are invoked in parallel. Otherwise * behavior is undefined. */ > Otherwise behavior is undefined. > > + * @param queue Queue handle > > > in or out ? Will fix to [in] > > > + * > + * @return 0 if successful > > > what cases cause a failure, what is returned value in those case? I've added requirements to the description. Violating the requirements will cause a failure. Some failure cases can be platform dependent. Do you think there is a reason to enumerate all possible error cases? _______________________________________________ lng-odp mailing list lng-odp@lists.linaro.org http://lists.linaro.org/mailman/listinfo/lng-odp
