papi: let async calls return context

Callback receives "reply" messages containing context,
but previously there was no easy way
to get the automatically generated context value
of the originally sent "command" message.

With this, the caller can store the contexts,
so the callback knows which command got replied to.

Type: feature

Change-Id: I58ca812d20b03916f74096c396126710115a747c
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
This commit is contained in:
Vratko Polak
2019-09-06 15:20:07 +02:00
committed by Ole Trøan
parent a287a30dda
commit 2f6e0c6002

View File

@ -669,13 +669,17 @@ class VPPApiClient(object):
return rl
def _call_vpp_async(self, i, msg, **kwargs):
"""Given a message, send the message and await a reply.
"""Given a message, send the message and return the context.
msgdef - the message packing definition
i - the message type index
context - context number - chosen at random if not
supplied.
The remainder of the kwargs are the arguments to the API call.
The reply message(s) will be delivered later to the registered callback.
The returned context will help with assigning which call
the reply belongs to.
"""
if 'context' not in kwargs:
context = self.get_context()
@ -691,6 +695,7 @@ class VPPApiClient(object):
b = msg.pack(kwargs)
self.transport.write(b)
return context
def register_event_callback(self, callback):
"""Register a callback for async messages.