diff options
| author | Mark McLoughlin <markmc@redhat.com> | 2014-03-03 09:43:21 -0800 |
|---|---|---|
| committer | Mark McLoughlin <markmc@redhat.com> | 2014-03-03 09:43:21 -0800 |
| commit | 8060878b5ba944dbd611565faf044edfd130a3dd (patch) | |
| tree | dd6daaed098879f3285bed2a3f0799473ac6c33b | |
| parent | ed2a1545c0abf638dc977d48d78749fe4ec82f74 (diff) | |
| download | oslo-messaging-8060878b5ba944dbd611565faf044edfd130a3dd.tar.gz | |
notify listener: document the metadata callback parameter
Add some details about what the metadata parameter contains.
Change-Id: I191c1c480c679534c1dede9aa85c51615faf0800
| -rw-r--r-- | oslo/messaging/notify/listener.py | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/oslo/messaging/notify/listener.py b/oslo/messaging/notify/listener.py index 017f797..255c52c 100644 --- a/oslo/messaging/notify/listener.py +++ b/oslo/messaging/notify/listener.py @@ -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 |