openstack/oslo.messaging
Code Issues Proposed changes

notify listener: document the metadata callback parameter

Browse Source 
Add some details about what the metadata parameter contains.

Change-Id: I191c1c480c679534c1dede9aa85c51615faf0800
This commit is contained in:
Mark McLoughlin 2014-03-03 09:43:21 -08:00
parent ed2a1545c0
commit 8060878b5b
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
oslo/messaging/notify/listener.py
View File

@ -71,7 +71,9 @@ in one of the targets and if an endpoint implements the method named like the
priority
Parameters to endpoint methods are the request context supplied by the client,
the publisher_id of the notification message, the event_type, the payload.
the publisher_id of the notification message, the event_type, the payload and
metadata. The metadata parameter is a mapping containing a unique message_id
and a timestamp.
An endpoint method can return explicitly messaging.NotificationResult.HANDLED
to acknowledge a message or messaging.NotificationResult.REQUEUE to requeue the